{"id":22529538,"url":"https://github.com/aboviq/readdir-recursive","last_synced_at":"2026-04-30T17:31:24.546Z","repository":{"id":33659536,"uuid":"156833413","full_name":"aboviq/readdir-recursive","owner":"aboviq","description":"Customizeable async recursive fs.readdir with no dependencies and sane defaults","archived":false,"fork":false,"pushed_at":"2023-02-28T04:20:03.000Z","size":1130,"stargazers_count":0,"open_issues_count":6,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-11-22T22:12:06.709Z","etag":null,"topics":["async","fs","no-dependencies","nodejs","readdir"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aboviq.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-11-09T08:35:39.000Z","updated_at":"2022-02-21T07:37:46.000Z","dependencies_parsed_at":"2024-10-30T04:53:10.607Z","dependency_job_id":null,"html_url":"https://github.com/aboviq/readdir-recursive","commit_stats":{"total_commits":26,"total_committers":3,"mean_commits":8.666666666666666,"dds":"0.42307692307692313","last_synced_commit":"ead02abf3382e5764fdc45ac287f0cb1c1368377"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/aboviq/readdir-recursive","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aboviq%2Freaddir-recursive","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aboviq%2Freaddir-recursive/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aboviq%2Freaddir-recursive/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aboviq%2Freaddir-recursive/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aboviq","download_url":"https://codeload.github.com/aboviq/readdir-recursive/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aboviq%2Freaddir-recursive/sbom","scorecard":{"id":161471,"data":{"date":"2025-08-11","repo":{"name":"github.com/aboviq/readdir-recursive","commit":"ead02abf3382e5764fdc45ac287f0cb1c1368377"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.3,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/11 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":0,"reason":"license file not detected","details":["Warn: project does not have a license file"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 15 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"43 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-rmvr-2pp2-xj38","Warn: Project is vulnerable to: GHSA-xx4v-prfh-6cgc","Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c","Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq","Warn: Project is vulnerable to: GHSA-ff7x-qrg7-qggm","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6","Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97","Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j","Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22","Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp","Warn: Project is vulnerable to: GHSA-896r-f27r-55mw","Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h","Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp","Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw","Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9","Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm","Warn: Project is vulnerable to: GHSA-5v2h-r2cx-5xgj","Warn: Project is vulnerable to: GHSA-rrrm-qjm4-v8hf","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p","Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp","Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6","Warn: Project is vulnerable to: GHSA-r2j6-p67h-q639","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-44c6-4v22-4mhx","Warn: Project is vulnerable to: GHSA-4x5v-gmq8-25ch","Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36","Warn: Project is vulnerable to: GHSA-52f5-9888-hmc6","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3","Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v","Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7","Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q","Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-16T13:35:02.529Z","repository_id":33659536,"created_at":"2025-08-16T13:35:02.529Z","updated_at":"2025-08-16T13:35:02.529Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32472396,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-30T13:12:12.517Z","status":"ssl_error","status_checked_at":"2026-04-30T13:12:06.837Z","response_time":57,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["async","fs","no-dependencies","nodejs","readdir"],"created_at":"2024-12-07T07:15:20.008Z","updated_at":"2026-04-30T17:31:24.528Z","avatar_url":"https://github.com/aboviq.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# @aboviq/readdir-recursive\n\n[![Build status][travis-image]][travis-url] [![NPM version][npm-image]][npm-url] [![XO code style][codestyle-image]][codestyle-url]\n\n\u003e Customizeable async recursive fs.readdir with no dependencies and sane defaults\n\n## Why?\n\n- No dependencies / Small\n- Asynchronous, i.e. returns a promise (uses async/await under the hood)\n- Provides a syncronous version as well\n- Sane defaults, i.e. does not recurse into `node_modules` by default\n- Fully customizable, with [options](#options) to decide in which folders to recurse into and what files and information to include in the results, with full access to each file's [Stats][fs-stats] information\n\n## Installation\n\nInstall `@aboviq/readdir-recursive` using [npm](https://www.npmjs.com/):\n\n```bash\nnpm install @aboviq/readdir-recursive\n```\n\n## Usage\n\n### Module usage\n\n```javascript\nconst readdirRecursive = require('@aboviq/readdir-recursive');\n\nconst files = await readdirRecursive('a/path');\n/*\n[\n  \"/full-path/a/path/filename.ext\",\n  \"/full-path/a/path/nested/folders/another.ext\",\n  ...\n]\n*/\n\nconst files = readdirRecursive.sync('a/path');\n/*\n[\n  \"/full-path/a/path/filename.ext\",\n  \"/full-path/a/path/nested/folders/another.ext\",\n  ...\n]\n*/\n```\n\n## API\n\n### `readdirRecursive(dir, options)`\n\n| Name    | Type     | Description                                                                           |\n| ------- | -------- | ------------------------------------------------------------------------------------- |\n| dir     | `String` | The folder to read files recursively in, either relative to `cwd` or an absolute path |\n| options | `Object` | Options for filtering, recursion and transformation                                   |\n\nReturns: `Promise\u003cArray\u003e`, all found files transformed according to the transformer and that has not been filtered out\n\n### `readdirRecursive.sync(dir, options)`\n\n| Name    | Type     | Description                                                                           |\n| ------- | -------- | ------------------------------------------------------------------------------------- |\n| dir     | `String` | The folder to read files recursively in, either relative to `cwd` or an absolute path |\n| options | `Object` | Options for filtering, recursion and transformation                                   |\n\nReturns: `Array`, all found files transformed according to the transformer and that has not been filtered out\n\n### Options\n\n**Note:** all function options can be asynchronous (return promises) when using the async version of `readdirRecursive`, but not with the sync version.\n\n#### `options.filter`\n\nType: `Function`  \nSignature: `filter :: Object -\u003e Boolean`  \nDefault: `() =\u003e true`\n\nThe `filter` option is used to decide if a file should be included in the resulting array of files or not. A file is included if the filter function returns a truthy value.\n\nThe `Object` passed to the `filter` function has the following properties:\n\n| Name  | Type                | Description                                                          |\n| ----- | ------------------- | -------------------------------------------------------------------- |\n| file  | `String`            | The file name, e.g. `\"file.txt\"`                                     |\n| path  | `String`            | The full path to the file, e.g. `\"/your/folder/sub-folder/file.txt\"` |\n| stats | [`Stats`][fs-stats] | A stats object providing information about the file                  |\n\n#### `options.transform`\n\nType: `Function`  \nSignature: `transform :: Object -\u003e String`  \nDefault: a function returing the full path of each file\n\nThe `transform` option is used to transform file information into something useful. Every file that passes the filter function will be transformed before being included in the resulting array.\n\nThe `Object` passed to the `transform` function has the following properties:\n\n| Name  | Type                | Description                                                          |\n| ----- | ------------------- | -------------------------------------------------------------------- |\n| file  | `String`            | The file name, e.g. `\"file.txt\"`                                     |\n| path  | `String`            | The full path to the file, e.g. `\"/your/folder/sub-folder/file.txt\"` |\n| stats | [`Stats`][fs-stats] | A stats object providing information about the file                  |\n\n#### `options.recurse`\n\nType: `Function`  \nSignature: `recurse :: Object -\u003e Boolean`  \nDefault: a function which won't recurse `node_modules`\n\nThe `recurse` option is used to decide if a folder should be recursed into or not. A folder is recursed if the recurse function returns a truthy value.\n\nThe `Object` passed to the `recurse` function has the following properties:\n\n| Name  | Type                | Description                                                   |\n| ----- | ------------------- | ------------------------------------------------------------- |\n| dir   | `String`            | The folder name, e.g. `\"src\"`                                 |\n| path  | `String`            | The full path to the folder, e.g. `\"/your/folder/sub-folder\"` |\n| stats | [`Stats`][fs-stats] | A stats object providing information about the folder         |\n\n## Contributing\n\nSee [Contribution Guidelines](CONTRIBUTING.md) and our [Code Of Conduct](CODE_OF_CONDUCT.md).\n\n## License\n\nMIT © [Aboviq AB](https://www.aboviq.com/)\n\n[npm-url]: https://npmjs.org/package/@aboviq/readdir-recursive\n[npm-image]: https://badge.fury.io/js/%40aboviq%2Freaddir-recursive.svg\n[travis-url]: https://travis-ci.org/aboviq/readdir-recursive\n[travis-image]: https://travis-ci.org/aboviq/readdir-recursive.svg?branch=master\n[codestyle-url]: https://github.com/xojs/xo\n[codestyle-image]: https://img.shields.io/badge/code%20style-XO-5ed9c7.svg?style=flat\n[fs-stats]: https://nodejs.org/docs/latest/api/fs.html#fs_class_fs_stats\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faboviq%2Freaddir-recursive","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faboviq%2Freaddir-recursive","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faboviq%2Freaddir-recursive/lists"}