如何使用节点的 fs.mkdirSync 创建完整路径?

How to create full path with node's fs.mkdirSync?

如果完整路径不存在,我正在尝试创建它。

代码如下所示:

var fs = require('fs');
if (!fs.existsSync(newDest)) fs.mkdirSync(newDest); 

只要只有一个子目录(像 'dir1' 这样的 newDest),这段代码就可以很好地工作,但是当有像 ('dir1/dir2') 这样的目录路径时,它会失败 错误:ENOENT,没有那个文件或目录

我希望能够使用尽可能少的代码行创建完整路径。

我读到 fs 上有一个递归选项并试过这样

var fs = require('fs');
if (!fs.existsSync(newDest)) fs.mkdirSync(newDest,'0777', true);

我觉得递归创建一个不存在的目录应该这么简单。我是不是遗漏了什么或者我是否需要解析路径并检查每个目录并在它不存在时创建它?

我对 Node.js 还很陌生。也许我使用的是旧版本的 FS?

一种选择是使用 shelljs module

npm 安装 shelljs

var shell = require('shelljs');
shell.mkdir('-p', fullPath);

来自该页面:

Available options:

p: full path (will create intermediate dirs if necessary)

正如其他人所指出的,还有其他更有针对性的模块。但是,在 mkdirp 之外,它还有大量其他有用的 shell 操作(例如 which、grep 等...)并且它适用于 windows 和 *nix

编辑:评论表明这在没有 mkdir cli 实例的系统上不起作用。事实并非如此。这就是 shelljs 的要点 - 创建一组可移植的跨平台函数集 shell。它甚至适用于 windows.

一个更可靠的答案是使用 mkdirp.

var mkdirp = require('mkdirp');

mkdirp('/path/to/dir', function (err) {
    if (err) console.error(err)
    else console.log('dir created')
});

然后继续将文件写入完整路径:

fs.writeFile ('/path/to/dir/file.dat'....

更新

NodeJS 版本 10.12.0 添加了对 mkdirmkdirSync 的本地支持,以使用 recursive: true 选项递归创建目录,如下所示:

fs.mkdirSync(targetDir, { recursive: true });

如果你更喜欢fs Promises API,你可以写

fs.promises.mkdir(targetDir, { recursive: true });

原答案

目录不存在则递归创建! (零依赖

const fs = require('fs');
const path = require('path');

function mkDirByPathSync(targetDir, { isRelativeToScript = false } = {}) {
  const sep = path.sep;
  const initDir = path.isAbsolute(targetDir) ? sep : '';
  const baseDir = isRelativeToScript ? __dirname : '.';

  return targetDir.split(sep).reduce((parentDir, childDir) => {
    const curDir = path.resolve(baseDir, parentDir, childDir);
    try {
      fs.mkdirSync(curDir);
    } catch (err) {
      if (err.code === 'EEXIST') { // curDir already exists!
        return curDir;
      }

      // To avoid `EISDIR` error on Mac and `EACCES`-->`ENOENT` and `EPERM` on Windows.
      if (err.code === 'ENOENT') { // Throw the original parentDir error on curDir `ENOENT` failure.
        throw new Error(`EACCES: permission denied, mkdir '${parentDir}'`);
      }

      const caughtErr = ['EACCES', 'EPERM', 'EISDIR'].indexOf(err.code) > -1;
      if (!caughtErr || caughtErr && curDir === path.resolve(targetDir)) {
        throw err; // Throw if it's just the last created dir.
      }
    }

    return curDir;
  }, initDir);
}

用法

// Default, make directories relative to current working directory.
mkDirByPathSync('path/to/dir');

// Make directories relative to the current script.
mkDirByPathSync('path/to/dir', {isRelativeToScript: true});

// Make directories with an absolute path.
mkDirByPathSync('/path/to/dir');

演示

Try It!

解释

  • [更新] 此解决方案处理特定于平台的错误,例如 EISDIR for Mac 和 EPERM and EACCES for Windows。感谢@PediT.、@JohnQ、@deed02392、@robyoder 和@Almenon 的所有报告评论。
  • 此解决方案处理相对绝对 路径。感谢@john 评论。
  • 在相对路径的情况下,将在当前工作目录中创建(解析)目标目录。要相对于当前脚本目录解析它们,请传递 {isRelativeToScript: true}.
  • 使用 path.sep and path.resolve(),而不仅仅是 / 连接,以避免跨平台问题。
  • 使用 fs.mkdirSync and handling the error with try/catch if thrown to handle race conditions: another process may add the file between the calls to fs.existsSync() and fs.mkdirSync() 并导致异常。
    • 实现此目的的另一种方法是检查文件是否存在然后创建它,即 if (!fs.existsSync(curDir) fs.mkdirSync(curDir);。但这是一种反模式,使代码容易受到竞争条件的影响。感谢@GershomMaes 关于目录存在性检查的评论。
  • 需要 Node v6 及更新版本以支持解构。 (如果您在使用旧 Node 版本实施此解决方案时遇到问题,请给我留言)

使用 reduce 我们可以验证每条路径是否存在并在必要时创建它,而且我认为这种方式更容易遵循。已编辑,感谢@Arvin,我们应该使用 path.sep 来获得正确的 platform-specific 路径段分隔符。

const path = require('path');

// Path separators could change depending on the platform
const pathToCreate = 'path/to/dir'; 
pathToCreate
 .split(path.sep)
 .reduce((prevPath, folder) => {
   const currentPath = path.join(prevPath, folder, path.sep);
   if (!fs.existsSync(currentPath)){
     fs.mkdirSync(currentPath);
   }
   return currentPath;
 }, '');

fs-extra 添加了本机 fs 模块中未包含的文件系统方法。它是 fs 的替代品。

安装fs-extra

$ npm install --save fs-extra

const fs = require("fs-extra");
// Make sure the output directory is there.
fs.ensureDirSync(newDest);

有同步和异步选项。

https://github.com/jprichardson/node-fs-extra/blob/master/docs/ensureDir.md

递归创建目录的异步方式:

import fs from 'fs'

const mkdirRecursive = function(path, callback) {
  let controlledPaths = []
  let paths = path.split(
    '/' // Put each path in an array
  ).filter(
    p => p != '.' // Skip root path indicator (.)
  ).reduce((memo, item) => {
    // Previous item prepended to each item so we preserve realpaths
    const prevItem = memo.length > 0 ? memo.join('/').replace(/\.\//g, '')+'/' : ''
    controlledPaths.push('./'+prevItem+item)
    return [...memo, './'+prevItem+item]
  }, []).map(dir => {
    fs.mkdir(dir, err => {
      if (err && err.code != 'EEXIST') throw err
      // Delete created directory (or skipped) from controlledPath
      controlledPaths.splice(controlledPaths.indexOf(dir), 1)
      if (controlledPaths.length === 0) {
        return callback()
      }
    })
  })
}

// Usage
mkdirRecursive('./photos/recent', () => {
  console.log('Directories created succesfully!')
})

这是我的 mkdirp for nodejs 命令式版本。

function mkdirSyncP(location) {
    let normalizedPath = path.normalize(location);
    let parsedPathObj = path.parse(normalizedPath);
    let curDir = parsedPathObj.root;
    let folders = parsedPathObj.dir.split(path.sep);
    folders.push(parsedPathObj.base);
    for(let part of folders) {
        curDir = path.join(curDir, part);
        if (!fs.existsSync(curDir)) {
            fs.mkdirSync(curDir);
        }
    }
}

这种方法怎么样:

if (!fs.existsSync(pathToFile)) {
            var dirName = "";
            var filePathSplit = pathToFile.split('/');
            for (var index = 0; index < filePathSplit.length; index++) {
                dirName += filePathSplit[index]+'/';
                if (!fs.existsSync(dirName))
                    fs.mkdirSync(dirName);
            }
        }

这适用于相对路径。

基于 mouneer's 零依赖答案,这里有一个稍微更适合初学者的 Typescript 变体,作为一个模块:

import * as fs from 'fs';
import * as path from 'path';

/**
* Recursively creates directories until `targetDir` is valid.
* @param targetDir target directory path to be created recursively.
* @param isRelative is the provided `targetDir` a relative path?
*/
export function mkdirRecursiveSync(targetDir: string, isRelative = false) {
    const sep = path.sep;
    const initDir = path.isAbsolute(targetDir) ? sep : '';
    const baseDir = isRelative ? __dirname : '.';

    targetDir.split(sep).reduce((prevDirPath, dirToCreate) => {
        const curDirPathToCreate = path.resolve(baseDir, prevDirPath, dirToCreate);
        try {
            fs.mkdirSync(curDirPathToCreate);
        } catch (err) {
            if (err.code !== 'EEXIST') {
                throw err;
            }
            // caught EEXIST error if curDirPathToCreate already existed (not a problem for us).
        }

        return curDirPathToCreate; // becomes prevDirPath on next call to reduce
    }, initDir);
}

windows 上的 Exec 可能会很混乱。还有一个更"nodie"的解决方案。从根本上说,您有一个递归调用来查看一个目录是否存在并深入到子目录(如果它确实存在)或创建它。这是一个将创建子项并在完成后调用函数的函数:

fs = require('fs');
makedirs = function(path, func) {
 var pth = path.replace(/['\]+/g, '/');
 var els = pth.split('/');
 var all = "";
 (function insertOne() {
   var el = els.splice(0, 1)[0];
   if (!fs.existsSync(all + el)) {
    fs.mkdirSync(all + el);
   }
   all += el + "/";
   if (els.length == 0) {
    func();
   } else {
     insertOne();
   }
   })();

}

答案太多,但这里有一个没有递归的解决方案,它通过拆分路径然后从左到右重新构建它来工作

function mkdirRecursiveSync(path) {
    let paths = path.split(path.delimiter);
    let fullPath = '';
    paths.forEach((path) => {

        if (fullPath === '') {
            fullPath = path;
        } else {
            fullPath = fullPath + '/' + path;
        }

        if (!fs.existsSync(fullPath)) {
            fs.mkdirSync(fullPath);
        }
    });
};

对于那些关心 windows 与 Linux 兼容性的人,只需将上面两次出现的正斜杠替换为双反斜杠 '\' 但说实话,我们谈论的是节点 fs 而不是 windows 命令行,前者相当宽容,上面的代码将简单地在 Windows 上工作,并且更像是一个完整的跨平台解决方案。

此版本在 Windows 上比最佳答案更好,因为它理解 /path.sep,因此正斜杠在 Windows 上正常工作。支持绝对路径和相对路径(相对于process.cwd)。

/**
 * Creates a folder and if necessary, parent folders also. Returns true
 * if any folders were created. Understands both '/' and path.sep as 
 * path separators. Doesn't try to create folders that already exist,
 * which could cause a permissions error. Gracefully handles the race 
 * condition if two processes are creating a folder. Throws on error.
 * @param targetDir Name of folder to create
 */
export function mkdirSyncRecursive(targetDir) {
  if (!fs.existsSync(targetDir)) {
    for (var i = targetDir.length-2; i >= 0; i--) {
      if (targetDir.charAt(i) == '/' || targetDir.charAt(i) == path.sep) {
        mkdirSyncRecursive(targetDir.slice(0, i));
        break;
      }
    }
    try {
      fs.mkdirSync(targetDir);
      return true;
    } catch (err) {
      if (err.code !== 'EEXIST') throw err;
    }
  }
  return false;
}

此功能已添加到版本 10.12.0 中的 node.js,因此只需将选项 {recursive: true} 作为第二个参数传递给 fs.mkdir() 调用即可。 见 example in the official docs.

无需外部模块或您自己的实现。

我知道这是一个老问题,但是 nodejs v10.12.0 现在通过将 recursive 选项设置为 true 来原生支持这个问题。 fs.mkdir

// Creates /tmp/a/apple, regardless of whether `/tmp` and /tmp/a exist.
fs.mkdir('/tmp/a/apple', { recursive: true }, (err) => {
  if (err) throw err;
});
const fs = require('fs');

try {
    fs.mkdirSync(path, { recursive: true });
} catch (error) {
    // this make script keep running, even when folder already exist
    console.log(error);
}

Windows 示例(没有额外的依赖项和错误处理)

const path = require('path');
const fs = require('fs');

let dir = "C:\temp\dir1\dir2\dir3";

function createDirRecursively(dir) {
    if (!fs.existsSync(dir)) {        
        createDirRecursively(path.join(dir, ".."));
        fs.mkdirSync(dir);
    }
}

createDirRecursively(dir); //creates dir1\dir2\dir3 in C:\temp

可以使用下一个功能

const recursiveUpload = (path: string) => { 常量路径 = path.split("/")

const fullPath = paths.reduce((accumulator, current) => {
  fs.mkdirSync(accumulator)
  return `${accumulator}/${current}`
  })

  fs.mkdirSync(fullPath)

  return fullPath
}

它的作用是什么:

  1. 创建 paths 变量,将每条路径单独存储为数组的一个元素。
  2. 在数组中每个元素的末尾添加“/”。
  3. 循环:
    1. 从索引从 0 到当前迭代的数组元素的串联创建一个目录。基本上,它是递归的。

希望对您有所帮助!

顺便说一句,在 Node v10.12.0 中,您可以通过将其作为附加参数来使用递归路径创建。

fs.mkdir('/tmp/a/apple', { recursive: true }, (err) => { if (err) throw err; });

https://nodejs.org/api/fs.html#fs_fs_mkdirsync_path_options

您可以简单地递归地检查文件夹是否存在于路径中,并在检查文件夹是否存在时创建文件夹。 (没有外部库

function checkAndCreateDestinationPath (fileDestination) {
    const dirPath = fileDestination.split('/');
    dirPath.forEach((element, index) => {
        if(!fs.existsSync(dirPath.slice(0, index + 1).join('/'))){
            fs.mkdirSync(dirPath.slice(0, index + 1).join('/')); 
        }
    });
}

就这么干净:)

function makedir(fullpath) {
  let destination_split = fullpath.replace('/', '\').split('\')
  let path_builder = destination_split[0]
  $.each(destination_split, function (i, path_segment) {
    if (i < 1) return true
    path_builder += '\' + path_segment
    if (!fs.existsSync(path_builder)) {
      fs.mkdirSync(path_builder)
    }
  })
}

现在使用 NodeJS >= 10.12.0,您可以使用 fs.mkdirSync(path, { recursive: true }) fs.mkdirSync

我对 fs.mkdir 的递归选项有疑问,所以我创建了一个执行以下操作的函数:

  1. 创建所有目录的列表,从最终目标目录开始,一直到根父目录。
  2. 为 mkdir 函数工作创建所需目录的新列表
  3. 制作每个需要的目录,包括最后的

    function createDirectoryIfNotExistsRecursive(dirname) {
        return new Promise((resolve, reject) => {
           const fs = require('fs');
    
           var slash = '/';
    
           // backward slashes for windows
           if(require('os').platform() === 'win32') {
              slash = '\';
           }
           // initialize directories with final directory
           var directories_backwards = [dirname];
           var minimize_dir = dirname;
           while (minimize_dir = minimize_dir.substring(0, minimize_dir.lastIndexOf(slash))) {
              directories_backwards.push(minimize_dir);
           }
    
           var directories_needed = [];
    
           //stop on first directory found
           for(const d in directories_backwards) {
              if(!(fs.existsSync(directories_backwards[d]))) {
                 directories_needed.push(directories_backwards[d]);
              } else {
                 break;
              }
           }
    
           //no directories missing
           if(!directories_needed.length) {
              return resolve();
           }
    
           // make all directories in ascending order
           var directories_forwards = directories_needed.reverse();
    
           for(const d in directories_forwards) {
              fs.mkdirSync(directories_forwards[d]);
           }
    
           return resolve();
        });
     }
    

我以这种方式解决了问题 - 类似于其他递归答案,但对我来说这更容易理解和阅读。

const path = require('path');
const fs = require('fs');

function mkdirRecurse(inputPath) {
  if (fs.existsSync(inputPath)) {
    return;
  }
  const basePath = path.dirname(inputPath);
  if (fs.existsSync(basePath)) {
    fs.mkdirSync(inputPath);
  }
  mkdirRecurse(basePath);
}