Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
BREAKING: Use native fs.mkdir recursive everywhere (#894)
Moved last bit of make-dir code to its own file
- Loading branch information
Showing
2 changed files
with
37 additions
and
130 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,141 +1,27 @@ | ||
| // Adapted from https://github.com/sindresorhus/make-dir | ||
| // Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (sindresorhus.com) | ||
| // Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: | ||
| // The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. | ||
| // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. | ||
| 'use strict' | ||
| const fs = require('../fs') | ||
| const path = require('path') | ||
| const atLeastNode = require('at-least-node') | ||
| const { checkPath } = require('./utils') | ||
|
|
||
| const useNativeRecursiveOption = atLeastNode('10.12.0') | ||
|
|
||
| // https://github.com/nodejs/node/issues/8987 | ||
| // https://github.com/libuv/libuv/pull/1088 | ||
| const checkPath = pth => { | ||
| if (process.platform === 'win32') { | ||
| const pathHasInvalidWinCharacters = /[<>:"|?*]/.test(pth.replace(path.parse(pth).root, '')) | ||
|
|
||
| if (pathHasInvalidWinCharacters) { | ||
| const error = new Error(`Path contains invalid characters: ${pth}`) | ||
| error.code = 'EINVAL' | ||
| throw error | ||
| } | ||
| } | ||
| } | ||
|
|
||
| const processOptions = options => { | ||
| const getMode = options => { | ||
| const defaults = { mode: 0o777 } | ||
| if (typeof options === 'number') options = { mode: options } | ||
| return { ...defaults, ...options } | ||
| } | ||
|
|
||
| const permissionError = pth => { | ||
| // This replicates the exception of `fs.mkdir` with native the | ||
| // `recusive` option when run on an invalid drive under Windows. | ||
| const error = new Error(`operation not permitted, mkdir '${pth}'`) | ||
| error.code = 'EPERM' | ||
| error.errno = -4048 | ||
| error.path = pth | ||
| error.syscall = 'mkdir' | ||
| return error | ||
| if (typeof options === 'number') return options | ||
| return ({ ...defaults, ...options }).mode | ||
| } | ||
|
|
||
| module.exports.makeDir = async (input, options) => { | ||
| checkPath(input) | ||
| options = processOptions(options) | ||
|
|
||
| if (useNativeRecursiveOption) { | ||
| const pth = path.resolve(input) | ||
|
|
||
| return fs.mkdir(pth, { | ||
| mode: options.mode, | ||
| recursive: true | ||
| }) | ||
| } | ||
|
|
||
| const make = async pth => { | ||
| try { | ||
| await fs.mkdir(pth, options.mode) | ||
| } catch (error) { | ||
| if (error.code === 'EPERM') { | ||
| throw error | ||
| } | ||
|
|
||
| if (error.code === 'ENOENT') { | ||
| if (path.dirname(pth) === pth) { | ||
| throw permissionError(pth) | ||
| } | ||
| module.exports.makeDir = async (dir, options) => { | ||
| checkPath(dir) | ||
|
|
||
| if (error.message.includes('null bytes')) { | ||
| throw error | ||
| } | ||
|
|
||
| await make(path.dirname(pth)) | ||
| return make(pth) | ||
| } | ||
|
|
||
| try { | ||
| const stats = await fs.stat(pth) | ||
| if (!stats.isDirectory()) { | ||
| // This error is never exposed to the user | ||
| // it is caught below, and the original error is thrown | ||
| throw new Error('The path is not a directory') | ||
| } | ||
| } catch { | ||
| throw error | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return make(path.resolve(input)) | ||
| return fs.mkdir(dir, { | ||
| mode: getMode(options), | ||
| recursive: true | ||
| }) | ||
| } | ||
|
|
||
| module.exports.makeDirSync = (input, options) => { | ||
| checkPath(input) | ||
| options = processOptions(options) | ||
|
|
||
| if (useNativeRecursiveOption) { | ||
| const pth = path.resolve(input) | ||
|
|
||
| return fs.mkdirSync(pth, { | ||
| mode: options.mode, | ||
| recursive: true | ||
| }) | ||
| } | ||
|
|
||
| const make = pth => { | ||
| try { | ||
| fs.mkdirSync(pth, options.mode) | ||
| } catch (error) { | ||
| if (error.code === 'EPERM') { | ||
| throw error | ||
| } | ||
|
|
||
| if (error.code === 'ENOENT') { | ||
| if (path.dirname(pth) === pth) { | ||
| throw permissionError(pth) | ||
| } | ||
|
|
||
| if (error.message.includes('null bytes')) { | ||
| throw error | ||
| } | ||
|
|
||
| make(path.dirname(pth)) | ||
| return make(pth) | ||
| } | ||
|
|
||
| try { | ||
| if (!fs.statSync(pth).isDirectory()) { | ||
| // This error is never exposed to the user | ||
| // it is caught below, and the original error is thrown | ||
| throw new Error('The path is not a directory') | ||
| } | ||
| } catch { | ||
| throw error | ||
| } | ||
| } | ||
| } | ||
| module.exports.makeDirSync = (dir, options) => { | ||
| checkPath(dir) | ||
|
|
||
| return make(path.resolve(input)) | ||
| return fs.mkdirSync(dir, { | ||
| mode: getMode(options), | ||
| recursive: true | ||
| }) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| // Adapted from https://github.com/sindresorhus/make-dir | ||
| // Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (sindresorhus.com) | ||
| // Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: | ||
| // The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. | ||
| // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. | ||
| 'use strict' | ||
| const path = require('path') | ||
|
|
||
| // https://github.com/nodejs/node/issues/8987 | ||
| // https://github.com/libuv/libuv/pull/1088 | ||
| module.exports.checkPath = function checkPath (pth) { | ||
| if (process.platform === 'win32') { | ||
| const pathHasInvalidWinCharacters = /[<>:"|?*]/.test(pth.replace(path.parse(pth).root, '')) | ||
|
|
||
| if (pathHasInvalidWinCharacters) { | ||
| const error = new Error(`Path contains invalid characters: ${pth}`) | ||
| error.code = 'EINVAL' | ||
| throw error | ||
| } | ||
| } | ||
| } |