Installations

npm install read-dir-deep

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Min. Node Version

>=18.12.0

Node Version

20.9.0

NPM Version

10.1.0 Score

69

Supply Chain

98.6

Quality

74.9

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

0

Total

0

Closed

0

Issues

Open

0

Total

2

Closed

2

Releases

4

v8.0.0

Published on 15 Nov 2023

v7.0.1

Published on 10 Jul 2019

v7.0.0

Published on 10 Jul 2019

v6.0.1

Published on 25 Jun 2019

View all 4 releases

Contributors

1

Unable to fetch Contributors

View all 1 contributors

Languages

3

TypeScript

JavaScript

Shell

TypeScript (69.45%)

JavaScript (30.03%)

Shell (0.52%)

Developer

chrisblossom

Download Statistics

Total Downloads

151,506

Last Day

14

Last Week

97

Last Month

738

Last Year

16,037

GitHub Statistics

5 Stars

62 Commits

2 Watching

1 Branches

1 Contributors

Bundle Size

87.80 kB

Minified

26.78 kB

Minified + Gzipped

Bundlephobia

Maintainers

1

Package Meta Information

Latest Version

8.0.0

Package Id

read-dir-deep@8.0.0

Unpacked Size

23.36 kB

Size

6.62 kB

File Count

18

NPM Version

10.1.0

Node Version

20.9.0

Publised On

15 Nov 2023

Total Downloads

Cumulative downloads

Total Downloads

151,506

Last day

-72%

14

Compared to previous day

Last week

-66.2%

97

Compared to previous week

Last month

27.2%

738

Compared to previous month

Last year

-28.4%

16,037

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

5

globby is-path-cwd is-path-in-cwd path-sort2 slash

Dev Dependencies

6

@backtrack/core @backtrack/preset-node @types/jest @types/node temp-sandbox typescript

Versions

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

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

SAST

Determines if the project uses static code analysis.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

License

Determines if the project has defined a license.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

Score

2.6

/10

Last Scanned on 2025-01-27

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to read-dir-deep

read-dir-deep

Installations

Developer Guide

Yes

CommonJS

>=18.12.0

20.9.0

10.1.0

Score

Pull Requests

0

0

0

Issues

0

2

2

Releases

Contributors

Unable to fetch Contributors

Languages

Developer

Download Statistics

GitHub Statistics

Bundle Size

87.80 kB

26.78 kB

Maintainers

Package Meta Information

Total Downloads

151,506

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

read-dir-deep

About

Installation

Usage

Options

Thanks To / Related Projects

10

10

0

0

0

0

0

0

0

0

2.6

/10