如何获取 Node.js 目录中存在的所有文件的名称列表？

Question

我正在尝试使用 Node.js 获取目录中存在的所有文件的名称列表。我想要的输出是文件名数组。我该怎么做？

Answer 1

这是一个异步递归版本。

    function ( path, callback){
     // the callback gets ( err, files) where files is an array of file names
     if( typeof callback !== 'function' ) return
     var
      result = []
      , files = [ path.replace( /\/\s*$/, '' ) ]
     function traverseFiles (){
      if( files.length ) {
       var name = files.shift()
       fs.stat(name, function( err, stats){
        if( err ){
         if( err.errno == 34 ) traverseFiles()
    // in case there's broken symbolic links or a bad path
    // skip file instead of sending error
         else callback(err)
        }
        else if ( stats.isDirectory() ) fs.readdir( name, function( err, files2 ){
         if( err ) callback(err)
         else {
          files = files2
           .map( function( file ){ return name + '/' + file } )
           .concat( files )
          traverseFiles()
         }
        })
        else{
         result.push(name)
         traverseFiles()
        }
       })
      }
      else callback( null, result )
     }
     traverseFiles()
    }

Answer 2

采用@Hunan-Rostomyan 的一般方法，使其更加简洁并添加了 excludeDirs 参数。使用 includeDirs 进行扩展很简单，只需遵循相同的模式即可：

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

function fileList(dir, excludeDirs?) {
    return fs.readdirSync(dir).reduce(function (list, file) {
        const name = path.join(dir, file);
        if (fs.statSync(name).isDirectory()) {
            if (excludeDirs && excludeDirs.length) {
                excludeDirs = excludeDirs.map(d => path.normalize(d));
                const idx = name.indexOf(path.sep);
                const directory = name.slice(0, idx === -1 ? name.length : idx);
                if (excludeDirs.indexOf(directory) !== -1)
                    return list;
            }
            return list.concat(fileList(name, excludeDirs));
        }
        return list.concat([name]);
    }, []);
}

示例用法：

console.log(fileList('.', ['node_modules', 'typings', 'bower_components']));

Answer 3

我通常使用：FS-Extra。

const fileNameArray = Fse.readdir('/some/path');

结果：

[
  "b7c8a93c-45b3-4de8-b9b5-a0bf28fb986e.jpg",
  "daeb1c5b-809f-4434-8fd9-410140789933.jpg"
]

Answer 4

使用基于 Promise 的 fs api 的当前最上面列出的答案是：

import { readdir } from 'node:fs/promises'

const testFolder = "./tests/"

for (const file of await readdir(testFolder)) {
    console.log(file);
};

Answer 5

请注意：如果您计划对目录中的每个文件执行操作，请尝试 vinyl-fs< /a> （由流构建系统 gulp 使用）。

Answer 6

这将起作用并将结果存储在 test.txt 文件中，该文件将出现在同一目录中

  fs.readdirSync(__dirname).forEach(file => {
    fs.appendFileSync("test.txt", file+"\n", function(err){
    })
})

Answer 7

我最近为此构建了一个工具，它可以异步获取目录并返回项目列表。您可以获取目录、文件或两者，其中文件夹优先。如果您不想获取整个文件夹，您还可以对数据进行分页。

https://www.npmjs.com/package/fs-browser

这是链接，希望对某人有帮助！

Answer 8

没有 npm 安装。这适用于启动终端的当前文件夹，但您可以将 process.cwd() 更改为另一个文件夹。享受！

const fs=require('fs');
fs.readdirSync(process.cwd());

Answer 9

我制作了一个节点模块来自动执行此任务： mddir

使用

节点 mddir "../relative/ path/"

要安装： npm install mddir -g

要为当前目录生成 markdown：mddir

要为任何绝对路径生成：mddir /absolute/path

要为相对路径生成：mddir ~/Documents/whatever。

md 文件将在您的工作目录中生成。

目前忽略 node_modules 和 .git 文件夹。

故障排除

如果您收到错误“node\r：没有这样的文件或目录”，则问题是您的操作系统使用不同的行结束符，并且如果您未将行结束样式显式设置为 Unix，则 mddir 无法解析它们。这通常会影响 Windows，但也会影响某些版本的 Linux。将行结尾设置为 Unix 样式必须在 mddir npm 全局 bin 文件夹中执行。

行结尾修复

获取 npm bin 文件夹路径：

npm config get prefix

Cd 进入该文件夹

brew install dos2unix

dos2unix lib/node_modules/mddir/src/mddir.js

这会将行结尾转换为 Unix 而不是 Dos

然后正常运行：node mddir "../relative/path/"。

生成的 Markdown 文件结构“directoryList.md”示例

    |-- .bowerrc
    |-- .jshintrc
    |-- .jshintrc2
    |-- Gruntfile.js
    |-- README.md
    |-- bower.json
    |-- karma.conf.js
    |-- package.json
    |-- app
        |-- app.js
        |-- db.js
        |-- directoryList.md
        |-- index.html
        |-- mddir.js
        |-- routing.js
        |-- server.js
        |-- _api
            |-- api.groups.js
            |-- api.posts.js
            |-- api.users.js
            |-- api.widgets.js
        |-- _components
            |-- directives
                |-- directives.module.js
                |-- vendor
                    |-- directive.draganddrop.js
            |-- helpers
                |-- helpers.module.js
                |-- proprietary
                    |-- factory.actionDispatcher.js
            |-- services
                |-- services.cardTemplates.js
                |-- services.cards.js
                |-- services.groups.js
                |-- services.posts.js
                |-- services.users.js
                |-- services.widgets.js
        |-- _mocks
            |-- mocks.groups.js
            |-- mocks.posts.js
            |-- mocks.users.js
            |-- mocks.widgets.js

Answer 10

如果上述许多选项看起来太复杂或不是您正在寻找的，那么这里是使用 node-dir 的另一种方法 - https://github.com/fshost/node-dir

npm install node-dir

这是一个简单的函数，用于列出在子目录中搜索的所有 .xml 文件

import * as nDir from 'node-dir' ;

listXMLs(rootFolderPath) {
    let xmlFiles ;

    nDir.files(rootFolderPath, function(err, items) {
        xmlFiles = items.filter(i => {
            return path.extname(i) === '.xml' ;
        }) ;
        console.log(xmlFiles) ;       
    });
}

Answer 11

您可以使用 fs.readdir 或fs.readdirSync 方法。 fs 包含在 Node.js 核心中，因此无需安装任何东西。

fs.readdir

const testFolder = './tests/';
const fs = require('fs');

fs.readdir(testFolder, (err, files) => {
  files.forEach(file => {
    console.log(file);
  });
});

fs.readdirSync

const testFolder = './tests/';
const fs = require('fs');

fs.readdirSync(testFolder).forEach(file => {
  console.log(file);
});

两种方法之间的区别在于，第一种方法是异步的，因此您必须提供一个回调函数，该函数将在读取时执行过程结束。

第二个是同步的，它将返回文件名数组，但它将停止代码的任何进一步执行，直到读取过程结束。

Answer 12

IMO 完成此类任务的最方便方法是使用 glob 工具。这是 Node.js 的 glob 包。安装

npm install glob

然后使用通配符来匹配文件名（示例取自包的 网站）

var glob = require("glob")

// options is optional
glob("**/*.js", options, function (er, files) {
  // files is an array of filenames.
  // If the `nonull` option is set, and nothing
  // was found, then files is ["**/*.js"]
  // er is an error object or null.
})

如果您打算这里是使用 globby 查找当前文件夹下的任何 xml 文件的示例

var globby = require('globby');

const paths = await globby("**/*.xml");  

Answer 13

从 Node v10.10.0 开始，可以对 withFileTypes 选项>fs.readdir 和 fs.readdirSync< /code> 与 dirent.isDirectory() 结合使用 函数用于过滤目录中的文件名。看起来像这样：

fs.readdirSync('./dirpath', {withFileTypes: true})
.filter(item => !item.isDirectory())
.map(item => item.name)

返回的数组的形式为：

['file1.txt', 'file2.txt', 'file3.txt']

Answer 14

不过，上面的答案不会对目录执行递归搜索。这是我为递归搜索所做的事情（使用 node-walk：npm install walk< /代码>)

var walk    = require('walk');
var files   = [];

// Walker options
var walker  = walk.walk('./test', { followLinks: false });

walker.on('file', function(root, stat, next) {
    // Add this file to the list of files
    files.push(root + '/' + stat.name);
    next();
});

walker.on('end', function() {
    console.log(files);
});

Answer 15

获取所有子目录下的文件

const fs=require('fs');

function getFiles (dir, files_){
    files_ = files_ || [];
    var files = fs.readdirSync(dir);
    for (var i in files){
        var name = dir + '/' + files[i];
        if (fs.statSync(name).isDirectory()){
            getFiles(name, files_);
        } else {
            files_.push(name);
        }
    }
    return files_;
}

console.log(getFiles('path/to/dir'))

Answer 16

这是一个简单的解决方案，仅使用本机 fs 和 path 模块：

// sync version
function walkSync(currentDirPath, callback) {
    var fs = require('fs'),
        path = require('path');
    fs.readdirSync(currentDirPath).forEach(function (name) {
        var filePath = path.join(currentDirPath, name);
        var stat = fs.statSync(filePath);
        if (stat.isFile()) {
            callback(filePath, stat);
        } else if (stat.isDirectory()) {
            walkSync(filePath, callback);
        }
    });
}

或异步版本（使用 fs.readdir 代替）：

// async version with basic error handling
function walk(currentDirPath, callback) {
    var fs = require('fs'),
        path = require('path');
    fs.readdir(currentDirPath, function (err, files) {
        if (err) {
            throw new Error(err);
        }
        files.forEach(function (name) {
            var filePath = path.join(currentDirPath, name);
            var stat = fs.statSync(filePath);
            if (stat.isFile()) {
                callback(filePath, stat);
            } else if (stat.isDirectory()) {
                walk(filePath, callback);
            }
        });
    });
}

然后您只需调用 (对于同步版本）：

walkSync('path/to/root/dir', function(filePath, stat) {
    // do something with "filePath"...
});

或异步版本：

walk('path/to/root/dir', function(filePath, stat) {
    // do something with "filePath"...
});

区别在于节点在执行 IO 时如何阻塞。鉴于上面的 API 是相同的，您可以只使用异步版本来确保最大性能。

然而，使用同步版本有一个优点。步行完成后立即执行某些代码会更容易，如步行后的下一条语句。对于异步版本，您需要一些额外的方法来了解何时完成。也许首先创建所有路径的地图，然后枚举它们。对于简单的构建/util 脚本（相对于高性能 Web 服务器），您可以使用同步版本而不会造成任何损坏。

Answer 17

在 ES7 中使用 Promises 与

mz/fs 异步使用

mz 模块提供了核心的 Promisified 版本节点库。使用它们很简单。首先安装库...

npm install mz

然后...

const fs = require('mz/fs');
fs.readdir('./myDir').then(listing => console.log(listing))
  .catch(err => console.error(err));

或者您可以将它们编写在 ES7 中的异步函数中：

async function myReaddir () {
  try {
    const file = await fs.readdir('./myDir/');
  }
  catch (err) { console.error( err ) }
};

更新递归列表

一些用户指定希望查看递归列表（尽管不在问题中）...使用fs-promise。它是 mz 的薄包装。

npm install fs-promise;

然后...

const fs = require('fs-promise');
fs.walk('./myDir').then(
    listing => listing.forEach(file => console.log(file.path))
).catch(err => console.error(err));

Answer 18

非递归版本

您没有说您想递归地执行此操作，因此我假设您只需要目录的直接子级。

示例代码：

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

fs.readdirSync('your-directory-path')
  .filter((file) => fs.lstatSync(path.join(folder, file)).isFile());

Answer 19

依赖关系。

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

定义。

// String -> [String]
function fileList(dir) {
  return fs.readdirSync(dir).reduce(function(list, file) {
    var name = path.join(dir, file);
    var isDir = fs.statSync(name).isDirectory();
    return list.concat(isDir ? fileList(name) : [name]);
  }, []);
}

用法。

var DIR = '/usr/local/bin';

// 1. List all files in DIR
fileList(DIR);
// => ['/usr/local/bin/babel', '/usr/local/bin/bower', ...]

// 2. List all file names in DIR
fileList(DIR).map((file) => file.split(path.sep).slice(-1)[0]);
// => ['babel', 'bower', ...]

请注意，fileList 过于乐观。对于任何严重的问题，添加一些错误处理。

Answer 20

我从你的问题假设你不需要目录名称，只需要文件。

目录结构示例

animals
├── all.jpg
├── mammals
│   └── cat.jpg
│   └── dog.jpg
└── insects
    └── bee.jpg

Walk 函数

积分转到 Justin Maier in 此要点

如果您只需要文件路径的数组，请使用 return_object： false：

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

async function walk(dir) {
    let files = await fs.readdir(dir);
    files = await Promise.all(files.map(async file => {
        const filePath = path.join(dir, file);
        const stats = await fs.stat(filePath);
        if (stats.isDirectory()) return walk(filePath);
        else if(stats.isFile()) return filePath;
    }));

    return files.reduce((all, folderContents) => all.concat(folderContents), []);
}

使用

async function main() {
   console.log(await walk('animals'))
}

输出

[
  "/animals/all.jpg",
  "/animals/mammals/cat.jpg",
  "/animals/mammals/dog.jpg",
  "/animals/insects/bee.jpg"
];

Answer 21

它只有 2 行代码：

fs=require('fs')
fs.readdir("./img/", (err,filename)=>console.log(filename))

图片：

Answer 22

加载fs：

const fs = require('fs');

读取文件异步：

fs.readdir('./dir', function (err, files) {
    // "files" is an Array with files names
});

读取文件同步：

var files = fs.readdirSync('./dir');

Answer 23

如果有人仍在搜索这个，我会这样做：

import fs from 'fs';
import path from 'path';

const getAllFiles = dir =>
    fs.readdirSync(dir).reduce((files, file) => {
        const name = path.join(dir, file);
        const isDirectory = fs.statSync(name).isDirectory();
        return isDirectory ? [...files, ...getAllFiles(name)] : [...files, name];
    }, []);

它的工作对我来说非常好

Answer 24

我的单行代码：

const fs = require("fs")
const path = 'somePath/'

const filesArray = fs.readdirSync(path).filter(file => fs.lstatSync(path+file).isFile())

Answer 25

获取排序文件名。您可以根据特定的扩展名过滤结果，例如'.txt'、'.jpg'等。

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

function getFilenames(path, extension) {
    return fs
        .readdirSync(path)
        .filter(
            item =>
                fs.statSync(Path.join(path, item)).isFile() &&
                (extension === undefined || Path.extname(item) === extension)
        )
        .sort();
}

Answer 26

如果有人：

只想列出项目中本地子文件夹中的文件名（不包括目录），

• 我的 2 美分✅ 没有其他依赖项
• ✅ 1 个函数
• ✅ 规范化路径（Unix 与 Windows）

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

/**
 * @param {string} relativeName "resources/foo/goo"
 * @return {string[]}
 */
const listFileNames = (relativeName) => {
  try {
    const folderPath = path.join(process.cwd(), ...relativeName.split("/"));
    return fs
      .readdirSync(folderPath, { withFileTypes: true })
      .filter((dirent) => dirent.isFile())
      .map((dirent) => dirent.name.split(".")[0]);
  } catch (err) {
    // ...
  }
};

README.md
package.json
resources
 |-- countries
    |-- usa.yaml
    |-- japan.yaml
    |-- gb.yaml
    |-- provinces
       |-- .........


listFileNames("resources/countries") #=> ["usa", "japan", "gb"]

Answer 27

试试这个，它对我有用

import fs from "fs/promises";

const path = "path/to/folder";

export const readDir = async function readDir(path) {

    const files = await fs.readdir(path);

    // array of file names
    console.log(files);
}

Answer 28

这是一个 TypeScript，可选递归，可选错误日志记录和异步解决方案。您可以为要查找的文件名指定正则表达式。

我使用了 fs-extra，因为它是对 fs 的简单超级集改进。

import * as FsExtra from 'fs-extra'

/**
 * Finds files in the folder that match filePattern, optionally passing back errors .
 * If folderDepth isn't specified, only the first level is searched. Otherwise anything up
 * to Infinity is supported.
 *
 * @static
 * @param {string} folder The folder to start in.
 * @param {string} [filePattern='.*'] A regular expression of the files you want to find.
 * @param {(Error[] | undefined)} [errors=undefined]
 * @param {number} [folderDepth=0]
 * @returns {Promise<string[]>}
 * @memberof FileHelper
 */
public static async findFiles(
    folder: string,
    filePattern: string = '.*',
    errors: Error[] | undefined = undefined,
    folderDepth: number = 0
): Promise<string[]> {
    const results: string[] = []

    // Get all files from the folder
    let items = await FsExtra.readdir(folder).catch(error => {
        if (errors) {
            errors.push(error) // Save errors if we wish (e.g. folder perms issues)
        }

        return results
    })

    // Go through to the required depth and no further
    folderDepth = folderDepth - 1

    // Loop through the results, possibly recurse
    for (const item of items) {
        try {
            const fullPath = Path.join(folder, item)

            if (
                FsExtra.statSync(fullPath).isDirectory() &&
                folderDepth > -1)
            ) {
                // Its a folder, recursively get the child folders' files
                results.push(
                    ...(await FileHelper.findFiles(fullPath, filePattern, errors, folderDepth))
                )
            } else {
                // Filter by the file name pattern, if there is one
                if (filePattern === '.*' || item.search(new RegExp(filePattern, 'i')) > -1) {
                    results.push(fullPath)
                }
            }
        } catch (error) {
            if (errors) {
                errors.push(error) // Save errors if we wish
            }
        }
    }

    return results
}

Answer 29

使用 flatMap：

function getFiles(dir) {
  return fs.readdirSync(dir).flatMap((item) => {
    const path = `${dir}/${item}`;
    if (fs.statSync(path).isDirectory()) {
      return getFiles(path);
    }

    return path;
  });
}

给定以下目录：

dist
├── 404.html
├── app-AHOLRMYQ.js
├── img
│   ├── demo.gif
│   └── start.png
├── index.html
└── sw.js

用途：

getFiles("dist")

输出：

[
  'dist/404.html',
  'dist/app-AHOLRMYQ.js',
  'dist/img/demo.gif',
  'dist/img/start.png',
  'dist/index.html'
]

Answer 30

开箱即用

如果您想要一个开箱即用的具有目录结构的对象，我强烈建议您检查目录树。

假设您有以下结构：

photos
│   june
│   └── windsurf.jpg
└── january
    ├── ski.png
    └── snowboard.jpg

const dirTree = require("directory-tree");
const tree = dirTree("/path/to/photos");

将返回：

{
  path: "photos",
  name: "photos",
  size: 600,
  type: "directory",
  children: [
    {
      path: "photos/june",
      name: "june",
      size: 400,
      type: "directory",
      children: [
        {
          path: "photos/june/windsurf.jpg",
          name: "windsurf.jpg",
          size: 400,
          type: "file",
          extension: ".jpg"
        }
      ]
    },
    {
      path: "photos/january",
      name: "january",
      size: 200,
      type: "directory",
      children: [
        {
          path: "photos/january/ski.png",
          name: "ski.png",
          size: 100,
          type: "file",
          extension: ".png"
        },
        {
          path: "photos/january/snowboard.jpg",
          name: "snowboard.jpg",
          size: 100,
          type: "file",
          extension: ".jpg"
        }
      ]
    }
  ]
}

自定义对象

否则，如果您想使用自定义设置创建目录树对象，请查看以下代码片段。在此 codesandbox。

// my-script.js
const fs = require("fs");
const path = require("path");

const isDirectory = filePath => fs.statSync(filePath).isDirectory();
const isFile = filePath => fs.statSync(filePath).isFile();

const getDirectoryDetails = filePath => {
  const dirs = fs.readdirSync(filePath);
  return {
    dirs: dirs.filter(name => isDirectory(path.join(filePath, name))),
    files: dirs.filter(name => isFile(path.join(filePath, name)))
  };
};

const getFilesRecursively = (parentPath, currentFolder) => {
  const currentFolderPath = path.join(parentPath, currentFolder);
  let currentDirectoryDetails = getDirectoryDetails(currentFolderPath);

  const final = {
    current_dir: currentFolder,
    dirs: currentDirectoryDetails.dirs.map(dir =>
      getFilesRecursively(currentFolderPath, dir)
    ),
    files: currentDirectoryDetails.files
  };

  return final;
};

const getAllFiles = relativePath => {
  const fullPath = path.join(__dirname, relativePath);
  const parentDirectoryPath = path.dirname(fullPath);
  const leafDirectory = path.basename(fullPath);

  const allFiles = getFilesRecursively(parentDirectoryPath, leafDirectory);
  return allFiles;
};

module.exports = { getAllFiles };

然后你可以简单地执行以下操作：

// another-file.js 

const { getAllFiles } = require("path/to/my-script");

const allFiles = getAllFiles("/path/to/my-directory");