read-dir-deep

About

Returns a sorted recursive list of all files inside a directory.

Installation

npm install --save read-dir-deep

Usage

1const path = require('path');
2const { readDirDeep, readDirDeepSync } = require('read-dir-deep');
3
4const rootDir = path.resolve(process.cwd(), 'nested');
5
6// async
7const files = await readDirDeep(rootDir);
8
9// sync
10const files = readDirDeepSync(rootDir);
11
12console.log(files);
13// [
14//     'nested/a/b/c.js',
15//     'nested/a.js',
16//     'nested/b/a.js',
17//     'nested/b.js',
18// ]

Options

1const files = await readDirDeep(rootDir, {
2	/**
3	 * Return files relative to this directory
4	 *
5	 * defaults:
6	 *    inside process.cwd(): process.cwd()
7	 *    outside process.cwd(): rootDir
8	 */
9	cwd: process.cwd(),
10
11	/**
12	 * Return full file paths
13	 *
14	 * defaults:
15	 *     inside process.cwd: false
16	 *     outside process.cwd: true
17	 */
18	absolute: true,
19
20	/**
21	 * Custom file matching
22	 *
23	 * See [globby#patterns](https://github.com/sindresorhus/globby#patterns)
24	 *
25	 * default: ['.']
26	 */
27	patterns: [
28		'.',
29		'!**/*.test.js',
30	],
31
32	/**
33	 * Exclude files/folders
34	 *
35	 * default: see below
36	 * See named export: defaultIgnorePatterns
37	 */
38	ignore: [
39		'**/.DS_Store',
40		'**/node_modules/**',
41		'**/.git/**',
42		'**/.vscode/**',
43		'**/.idea/**',
44		'**/dist/**',
45		'**/build/**',
46		'**/coverage/**',
47	],
48
49	/**
50	 * Exclude files set in .gitignore
51	 *
52	 * default: true
53	 */
54	gitignore: true,
55});

See Globby Options for additional options

Thanks To / Related Projects

• sindresorhus/globby
• hughsk/path-sort