scandirectory - npm Package Compare versions

Comparing version 7.3.0 to 8.0.0-next.1704146854.f2beccb4387808170ac84871de30351da5fcc63e

LICENSE.md

 <!-- LICENSEFILE/ -->
 
-<h1>License</h1>
+# License
 
 Unless stated otherwise all works are:
 
-<ul><li>Copyright &copy; 2011+ <a href="https://balupton.com">Benjamin Lupton</a></li>
-<li>Copyright &copy; 2014+ <a href="http://bevry.me">Bevry Pty Ltd</a></li></ul>
+-   Copyright &copy; [Benjamin Lupton](https://balupton.com)
 
 and licensed under:
 
-<ul><li><a href="http://spdx.org/licenses/Artistic-2.0.html">Artistic License 2.0</a></li></ul>
+-   [Artistic License 2.0](http://spdx.org/licenses/Artistic-2.0.html)
 
-<h2>The Artistic License 2.0</h2>
+## The Artistic License 2.0
 
@@ -16,0 +15,0 @@ <pre>

package.json

 {
   "name": "scandirectory",
-  "version": "7.3.0",
+  "version": "8.0.0-next.1704146854.f2beccb4387808170ac84871de30351da5fcc63e",
+  "license": "Artistic-2.0",
   "description": "Scan a directory recursively with a lot of control and power",
   "homepage": "https://github.com/bevry/scandirectory",
-  "license": "Artistic-2.0",
+  "funding": "https://bevry.me/fund",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/bevry/scandirectory.git"
+  },
+  "bugs": {
+    "url": "https://github.com/bevry/scandirectory/issues"
+  },
   "keywords": [
-    "esnext",
+    "es2015",
+    "es2017",
+    "es2022",
+    "es5",
+    "export-default",
     "fs",
@@ -17,3 +29,6 @@ "node",
     "scantree",
-    "tree"
+    "tree",
+    "typed",
+    "types",
+    "typescript"
   ],
@@ -59,20 +74,51 @@ "badges": {
   },
-  "funding": "https://bevry.me/fund",
-  "author": "2011+ Benjamin Lupton <[e-mail]> (https://balupton.com), 2014+ Bevry Pty Ltd <[e-mail]> (http://bevry.me)",
+  "author": "Benjamin Lupton <[e-mail]> (https://balupton.com) (https://github.com/balupton)",
+  "authors": [
+    "Benjamin Lupton <[e-mail]> (https://balupton.com) (https://github.com/balupton): Accelerating collaborative wisdom."
+  ],
   "maintainers": [
-    "Benjamin Lupton <[e-mail]> (https://github.com/balupton)"
+    "Benjamin Lupton <[e-mail]> (https://balupton.com) (https://github.com/balupton): Accelerating collaborative wisdom."
   ],
   "contributors": [
-    "Benjamin Lupton <[e-mail]> (https://github.com/balupton)",
+    "Benjamin Lupton <[e-mail]> (https://balupton.com) (https://github.com/balupton)",
     "Bohdan (https://github.com/bohdanly)",
     "Bohdan Lysenko <[e-mail]> (https://github.com/lysenkobv)",
-    "Sean Fridman <[e-mail]> (https://github.com/sfrdmn)"
+    "Sean Fridman <[e-mail]> (https://seanfridman.com) (https://github.com/sfrdmn)"
   ],
-  "bugs": {
-    "url": "https://github.com/bevry/scandirectory/issues"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/bevry/scandirectory.git"
-  },
+  "sponsors": [
+    "Andrew Nesbitt (https://nesbitt.io) (https://github.com/andrew): Software engineer and researcher",
+    "Balsa <[e-mail]> (https://balsa.com) (https://github.com/balsa): We're Balsa, and we're building tools for builders.",
+    "Codecov <[e-mail]> (https://codecov.io) (https://github.com/codecov): Empower developers with tools to improve code quality and testing.",
+    "Poonacha Medappa (https://poonachamedappa.com) (https://github.com/km-Poonacha)",
+    "Rob Morris <[e-mail]> (https://github.com/Rob-Morris)",
+    "Sentry (https://sentry.io) (https://github.com/getsentry): Real-time crash reporting for your web apps, mobile apps, and games.",
+    "Syntax <[e-mail]> (https://syntax.fm) (https://github.com/syntaxfm): Syntax Podcast"
+  ],
+  "donors": [
+    "Andrew Nesbitt (https://nesbitt.io) (https://github.com/andrew)",
+    "Armen Mkrtchian (https://mogoni.dev) (https://github.com/Armenm)",
+    "Balsa <[e-mail]> (https://balsa.com) (https://github.com/balsa)",
+    "Chad (https://opencollective.com/chad8)",
+    "Codecov <[e-mail]> (https://codecov.io) (https://github.com/codecov)",
+    "dr.dimitru (https://veliovgroup.com) (https://github.com/dr-dimitru)",
+    "Elliott Ditman (https://elliottditman.com) (https://github.com/elliottditman)",
+    "entroniq (https://gitlab.com/entroniq) (https://thanks.dev/d/gl/entroniq)",
+    "GitHub (https://github.com/about) (https://github.com/github)",
+    "Hunter Beast (https://cryptoquick.com) (https://github.com/cryptoquick)",
+    "Jean-Luc Geering (https://github.com/jlgeering) (https://opencollective.com/jlgeering) (https://twitter.com/jlgeering)",
+    "Michael Duane Mooring (https://mdm.cc) (https://github.com/mikeumus) (https://opencollective.com/mikeumus) (https://twitter.com/mikeumus)",
+    "Michael Harry Scepaniak <[e-mail]> (https://michaelscepaniak.com) (https://github.com/hispanic)",
+    "Mohammed Shah <[e-mail]> (https://github.com/smashah) (https://thanks.dev/d/gh/smashah) (https://twitter.com/smashah)",
+    "Mr. Henry <[e-mail]> (https://mrhenry.be) (https://github.com/mrhenry)",
+    "Nermal <[e-mail]> (https://arjunaditya.vercel.app) (https://github.com/nermalcat69)",
+    "Pleo (https://pleo.io) (https://github.com/pleo-io)",
+    "Poonacha Medappa (https://poonachamedappa.com) (https://github.com/km-Poonacha)",
+    "Rob Morris <[e-mail]> (https://github.com/Rob-Morris)",
+    "Robert de Forest <[e-mail]> (https://github.com/rdeforest)",
+    "Sentry (https://sentry.io) (https://github.com/getsentry)",
+    "ServieJS (https://github.com/serviejs) (https://thanks.dev/d/gh/serviejs)",
+    "Skunk Team (https://skunk.team) (https://github.com/skunkteam)",
+    "Syntax <[e-mail]> (https://syntax.fm) (https://github.com/syntaxfm)",
+    "WriterJohnBuck (https://github.com/WriterJohnBuck)"
+  ],
   "engines": {
@@ -83,18 +129,30 @@ "node": ">=4"
     {
-      "description": "ESNext source code for Node.js 6 || 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with Require for modules",
+      "description": "TypeScript source code with Import for modules",
       "directory": "source",
+      "entry": "index.ts",
+      "tags": [
+        "source",
+        "typescript",
+        "import"
+      ],
+      "engines": false
+    },
+    {
+      "description": "TypeScript compiled against ES2022 for Node.js 14 || 16 || 18 || 20 || 21 with Require for modules",
+      "directory": "edition-es2022",
       "entry": "index.js",
       "tags": [
-        "source",
+        "compiled",
         "javascript",
-        "esnext",
+        "es2022",
         "require"
       ],
       "engines": {
-        "node": "6 || 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21"
+        "node": "14 || 16 || 18 || 20 || 21",
+        "browsers": false
       }
     },
     {
-      "description": "ESNext compiled for Node.js 4 with Require for modules",
-      "directory": "edition-node-4",
+      "description": "TypeScript compiled against ES2017 for Node.js 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with Require for modules",
+      "directory": "edition-es2017",
       "entry": "index.js",
@@ -104,41 +162,115 @@ "tags": [
         "javascript",
+        "es2017",
         "require"
       ],
       "engines": {
+        "node": "8 || 10 || 12 || 14 || 16 || 18 || 20 || 21",
+        "browsers": false
+      }
+    },
+    {
+      "description": "TypeScript compiled against ES2015 for Node.js 6 || 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with Require for modules",
+      "directory": "edition-es2015",
+      "entry": "index.js",
+      "tags": [
+        "compiled",
+        "javascript",
+        "es2015",
+        "require"
+      ],
+      "engines": {
+        "node": "6 || 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21",
+        "browsers": false
+      }
+    },
+    {
+      "description": "TypeScript compiled against ES5 for Node.js 4 || 6 || 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with Require for modules",
+      "directory": "edition-es5",
+      "entry": "index.js",
+      "tags": [
+        "compiled",
+        "javascript",
+        "es5",
+        "require"
+      ],
+      "engines": {
         "node": "4 || 6 || 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21",
         "browsers": false
       }
+    },
+    {
+      "description": "TypeScript compiled against ES2017 for Node.js 12 || 14 || 16 || 18 || 20 || 21 with Import for modules",
+      "directory": "edition-es2017-esm",
+      "entry": "index.js",
+      "tags": [
+        "compiled",
+        "javascript",
+        "es2017",
+        "import"
+      ],
+      "engines": {
+        "node": "12 || 14 || 16 || 18 || 20 || 21",
+        "browsers": false
+      }
+    },
+    {
+      "description": "TypeScript compiled Types with Import for modules",
+      "directory": "edition-types",
+      "entry": "index.d.ts",
+      "tags": [
+        "compiled",
+        "types",
+        "import"
+      ],
+      "engines": false
     }
   ],
-  "type": "commonjs",
+  "bin": "bin.cjs",
+  "types": "edition-types/index.d.ts",
+  "type": "module",
   "main": "index.cjs",
+  "exports": {
+    "node": {
+      "types": "./edition-types/index.d.ts",
+      "import": "./edition-es2017-esm/index.js",
+      "default": "./index.cjs",
+      "require": "./edition-es2022/index.js"
+    }
+  },
   "dependencies": {
-    "editions": "^6.16.0",
-    "ignorefs": "^4.3.0",
-    "readdir-cluster": "^5.2.0"
+    "editions": "^6.21.0",
+    "ignorefs": "^5.0.4"
   },
   "devDependencies": {
-    "@babel/cli": "^7.23.4",
-    "@babel/core": "^7.23.3",
-    "@babel/plugin-proposal-object-rest-spread": "^7.20.7",
-    "@babel/preset-env": "^7.23.3",
-    "@bevry/update-contributors": "^1.23.0",
-    "assert-helpers": "^11.6.0",
-    "eslint": "^8.54.0",
-    "eslint-config-bevry": "^5.2.0",
-    "eslint-config-prettier": "^9.0.0",
-    "eslint-plugin-prettier": "^5.0.1",
-    "kava": "^7.4.0",
-    "prettier": "^3.1.0",
-    "projectz": "^3.4.0",
-    "valid-directory": "^4.5.0"
+    "@types/node": "^20.10.6",
+    "@typescript-eslint/eslint-plugin": "^6.17.0",
+    "@typescript-eslint/parser": "^6.17.0",
+    "assert-helpers": "^11.12.0",
+    "eslint": "^8.56.0",
+    "eslint-config-bevry": "^5.4.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.1.2",
+    "filedirname": "^3.4.0",
+    "kava": "^7.8.0",
+    "prettier": "^3.1.1",
+    "projectz": "^4.2.0",
+    "typedoc": "^0.25.6",
+    "typescript": "5.3.3",
+    "valid-directory": "^4.9.0"
   },
   "scripts": {
+    "our:bin": "node ./bin.cjs",
     "our:clean": "rm -rf ./docs ./edition* ./es2015 ./es5 ./out ./.next",
-    "our:compile": "npm run our:compile:edition-node-4",
-    "our:compile:edition-node-4": "env BABEL_ENV=edition-node-4 babel --out-dir ./edition-node-4 ./source && printf '%s' '{\"type\": \"commonjs\"}' > edition-node-4/package.json",
+    "our:compile": "npm run our:compile:edition-es2015 && npm run our:compile:edition-es2017 && npm run our:compile:edition-es2017-esm && npm run our:compile:edition-es2022 && npm run our:compile:edition-es5 && npm run our:compile:edition-types",
+    "our:compile:edition-es2015": "tsc --module commonjs --target ES2015 --outDir ./edition-es2015 --project tsconfig.json && ( test ! -d edition-es2015/source || ( mv edition-es2015/source edition-temp && rm -rf edition-es2015 && mv edition-temp edition-es2015 ) ) && printf '%s' '{\"type\": \"commonjs\"}' > edition-es2015/package.json",
+    "our:compile:edition-es2017": "tsc --module commonjs --target ES2017 --outDir ./edition-es2017 --project tsconfig.json && ( test ! -d edition-es2017/source || ( mv edition-es2017/source edition-temp && rm -rf edition-es2017 && mv edition-temp edition-es2017 ) ) && printf '%s' '{\"type\": \"commonjs\"}' > edition-es2017/package.json",
+    "our:compile:edition-es2017-esm": "tsc --module ESNext --target ES2017 --outDir ./edition-es2017-esm --project tsconfig.json && ( test ! -d edition-es2017-esm/source || ( mv edition-es2017-esm/source edition-temp && rm -rf edition-es2017-esm && mv edition-temp edition-es2017-esm ) ) && printf '%s' '{\"type\": \"module\"}' > edition-es2017-esm/package.json",
+    "our:compile:edition-es2022": "tsc --module commonjs --target ES2022 --outDir ./edition-es2022 --project tsconfig.json && ( test ! -d edition-es2022/source || ( mv edition-es2022/source edition-temp && rm -rf edition-es2022 && mv edition-temp edition-es2022 ) ) && printf '%s' '{\"type\": \"commonjs\"}' > edition-es2022/package.json",
+    "our:compile:edition-es5": "tsc --module commonjs --target ES5 --outDir ./edition-es5 --project tsconfig.json && ( test ! -d edition-es5/source || ( mv edition-es5/source edition-temp && rm -rf edition-es5 && mv edition-temp edition-es5 ) ) && printf '%s' '{\"type\": \"commonjs\"}' > edition-es5/package.json",
+    "our:compile:edition-types": "tsc --emitDeclarationOnly --declaration --declarationMap --declarationDir ./edition-types --project tsconfig.json && ( test ! -d edition-types/source || ( mv edition-types/source edition-temp && rm -rf edition-types && mv edition-temp edition-types ) )",
     "our:deploy": "printf '%s\n' 'no need for this project'",
-    "our:meta": "npm run our:meta:contributors && npm run our:meta:projectz",
-    "our:meta:contributors": "update-contributors",
-    "our:meta:projectz": "projectz compile",
+    "our:meta": "npm run our:meta:docs && npm run our:meta:projectz",
+    "our:meta:docs": "npm run our:meta:docs:typedoc",
+    "our:meta:docs:typedoc": "rm -rf ./docs && typedoc --exclude '**/+(*test*|node_modules)' --excludeExternals --out ./docs ./source",
+    "our:meta:projectz": "projectz --offline",
     "our:release": "npm run our:release:prepare && npm run our:release:check-changelog && npm run our:release:check-dirty && npm run our:release:tag && npm run our:release:push",
@@ -153,4 +285,3 @@ "our:release:check-changelog": "cat ./HISTORY.md | grep \"v$npm_package_version\" || (printf '%s\n' \"add a changelog entry for v$npm_package_version\" && exit -1)",
     "our:test": "npm run our:verify && npm test",
-    "our:verify": "npm run our:verify:directory && npm run our:verify:eslint && npm run our:verify:prettier",
-    "our:verify:directory": "valid-directory",
+    "our:verify": "npm run our:verify:eslint && npm run our:verify:prettier",
     "our:verify:eslint": "eslint --fix --ignore-pattern '**/*.d.ts' --ignore-pattern '**/vendor/' --ignore-pattern '**/node_modules/' --ext .mjs,.js,.jsx,.ts,.tsx ./source",
@@ -168,25 +299,5 @@ "our:verify:prettier": "prettier --write .",
     "singleQuote": true,
-    "trailingComma": "es5"
-  },
-  "babel": {
-    "env": {
-      "edition-node-4": {
-        "sourceType": "script",
-        "presets": [
-          [
-            "@babel/preset-env",
-            {
-              "targets": {
-                "node": "4"
-              },
-              "modules": "commonjs"
-            }
-          ]
-        ],
-        "plugins": [
-          "@babel/proposal-object-rest-spread"
-        ]
-      }
-    }
+    "trailingComma": "es5",
+    "endOfLine": "lf"
   }
-}
+}

README.md

 <!-- TITLE/ -->
 
-<h1>scandirectory</h1>
+# scandirectory
 
 <!-- /TITLE -->
 
-
 <!-- BADGES/ -->
@@ -28,3 +27,2 @@
 
-
 <!-- DESCRIPTION/ -->
@@ -39,113 +37,69 @@
 
-```javascript
-var scandir = require('scandirectory')
-var path = process.cwd()
-var options = {}
-function completionCallback(err, list, tree) {
-    console.log({
-        error: err,
-        list: list,
-        tree: tree,
-    })
-    /*
-	{
-		error: null,
-		list: {
-			'a file.txt': 'file',
-			'a directory': 'dir',
-			'a directory/a sub file.txt': 'file'
-		},
-		tree: {
-			'a file.txt': true,
-			'a directory': {
-				'a sub file.txt': 'true
-			}
-		}
-	}
-	*/
-}
-scandir(path, options, completionCallback)
-```
+[Complete API Documentation.](http://master.scandirectory.bevry.surge.sh/docs/)
 
-Scan directory options:
+<!-- INSTALL/ -->
 
--   `action` - (default `null`) can be `null` or a function to use for both the fileAction and dirAction
--   `fileAction` - (default `null`) can be `null`, `false`, or a function to be the action callback
--   `dirAction` - (default `null`) can be `null`, `false`, or a function to the action callback
--   `recurse` - (default `true`) can be `null` or a boolean for whether or not to scan subdirectories too
--   `readFiles` - (default `false`) can be `null` or a boolean for whether or not we should read the file contents
+## Install
 
-The options object is also sent to [ignorefs](https://github.com/bevry/ignorefs) so you can use its options too
+### [npm](https://npmjs.com "npm is a package manager for javascript")
 
-The completion callback accepts the following arguments:
+#### Install Globally
 
--   `err` - `null` or an error that has occured
--   `list` - a collection of all the child nodes in a list/object format: - `{fileRelativePath: 'dir|file'}`
--   `tree` - a collection of all the child nodes in a tree format: - `{dir: {dir:{}, file1:true} }` - if the readFiles option is true, then files will be returned with their contents instead
+-   Install: `npm install --global scandirectory`
+-   Executable: `scandirectory`
 
-The results for a specific argument is only generated if the argument is requested.
+#### Install Locally
 
-The action callbacks accept the following arguments:
+-   Install: `npm install --save scandirectory`
+-   Executable: `npx scandirectory`
+-   Import: `import pkg from ('scandirectory')`
+-   Require: `const pkg = require('scandirectory').default`
 
--   `fullPath` - the full/absolute path of the current file/directory
--   `relativePath` - the relative path of the current file/directory with respect to the original scanning path
--   `filename` - the basename of the current file/directory
--   `stat` - a simple stat object provided by [readdir-cluster](https://github.com/bevry/readdir-cluster)
+### [Editions](https://editions.bevry.me "Editions are the best way to produce and consume packages you care about.")
 
-The action callbacks can return `false` to skip the path from being processed further.
+This package is published with the following editions:
+-   `scandirectory` aliases `scandirectory/index.cjs` which uses the [Editions Autoloader](https://github.com/bevry/editions "You can use the Editions Autoloader to autoload the appropriate edition for your consumers environment") to automatically select the correct edition for the consumer's environment
+-   `scandirectory/source/index.ts` is [TypeScript](https://www.typescriptlang.org/ "TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.") source code with [Import](https://babeljs.io/docs/learn-es2015/#modules "ECMAScript Modules") for modules
+-   `scandirectory/edition-es2022/index.js` is [TypeScript](https://www.typescriptlang.org/ "TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.") compiled against [ES2022](https://en.wikipedia.org/wiki/ES2022 "ECMAScript 2022") for [Node.js](https://nodejs.org "Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine") 14 || 16 || 18 || 20 || 21 with [Require](https://nodejs.org/dist/latest-v5.x/docs/api/modules.html "Node/CJS Modules") for modules
+-   `scandirectory/edition-es2017/index.js` is [TypeScript](https://www.typescriptlang.org/ "TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.") compiled against [ES2017](https://en.wikipedia.org/wiki/ES2017 "ECMAScript 2017") for [Node.js](https://nodejs.org "Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine") 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with [Require](https://nodejs.org/dist/latest-v5.x/docs/api/modules.html "Node/CJS Modules") for modules
+-   `scandirectory/edition-es2015/index.js` is [TypeScript](https://www.typescriptlang.org/ "TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.") compiled against [ES2015](https://babeljs.io/docs/en/learn#ecmascript-2015-features "ECMAScript 2015") for [Node.js](https://nodejs.org "Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine") 6 || 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with [Require](https://nodejs.org/dist/latest-v5.x/docs/api/modules.html "Node/CJS Modules") for modules
+-   `scandirectory/edition-es5/index.js` is [TypeScript](https://www.typescriptlang.org/ "TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.") compiled against ES5 for [Node.js](https://nodejs.org "Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine") 4 || 6 || 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with [Require](https://nodejs.org/dist/latest-v5.x/docs/api/modules.html "Node/CJS Modules") for modules
+-   `scandirectory/edition-es2017-esm/index.js` is [TypeScript](https://www.typescriptlang.org/ "TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.") compiled against [ES2017](https://en.wikipedia.org/wiki/ES2017 "ECMAScript 2017") for [Node.js](https://nodejs.org "Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine") 12 || 14 || 16 || 18 || 20 || 21 with [Import](https://babeljs.io/docs/learn-es2015/#modules "ECMAScript Modules") for modules
+-   `scandirectory/edition-types/index.d.ts` is [TypeScript](https://www.typescriptlang.org/ "TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.") compiled Types with [Import](https://babeljs.io/docs/learn-es2015/#modules "ECMAScript Modules") for modules
 
-<!-- CONTRIBUTE/ -->
+<!-- /INSTALL -->
 
-<h2>Contribute</h2>
+<!-- HISTORY/ -->
 
-<a href="https://github.com/bevry/scandirectory/blob/master/CONTRIBUTING.md#files">Discover how you can contribute by heading on over to the <code>CONTRIBUTING.md</code> file.</a>
+## History
 
-<!-- /CONTRIBUTE -->
+[Discover the release history by heading on over to the `HISTORY.md` file.](https://github.com/bevry/scandirectory/blob/HEAD/HISTORY.md#files)
 
+<!-- /HISTORY -->
 
-<!-- INSTALL/ -->
+<!-- BACKERS/ -->
 
-<h2>Install</h2>
+## Backers
 
-<a href="https://npmjs.com" title="npm is a package manager for javascript"><h3>npm</h3></a>
-<ul>
-<li>Install: <code>npm install --save scandirectory</code></li>
-<li>Import: <code>import * as pkg from ('scandirectory')</code></li>
-<li>Require: <code>const pkg = require('scandirectory')</code></li>
-</ul>
+### Code
 
-<h3><a href="https://editions.bevry.me" title="Editions are the best way to produce and consume packages you care about.">Editions</a></h3>
+[Discover how to contribute via the `CONTRIBUTING.md` file.](https://github.com/bevry/scandirectory/blob/HEAD/CONTRIBUTING.md#files)
 
-<p>This package is published with the following editions:</p>
+#### Authors
 
-<ul><li><code>scandirectory</code> aliases <code>scandirectory/index.cjs</code> which uses the <a href="https://github.com/bevry/editions" title="You can use the Editions Autoloader to autoload the appropriate edition for your consumers environment">Editions Autoloader</a> to automatically select the correct edition for the consumer's environment</li>
-<li><code>scandirectory/source/index.js</code> is <a href="https://en.wikipedia.org/wiki/ECMAScript#ES.Next" title="ECMAScript Next">ESNext</a> source code for <a href="https://nodejs.org" title="Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine">Node.js</a> 6 || 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with <a href="https://nodejs.org/dist/latest-v5.x/docs/api/modules.html" title="Node/CJS Modules">Require</a> for modules</li>
-<li><code>scandirectory/edition-node-4/index.js</code> is <a href="https://en.wikipedia.org/wiki/ECMAScript#ES.Next" title="ECMAScript Next">ESNext</a> compiled for <a href="https://nodejs.org" title="Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine">Node.js</a> 4 with <a href="https://nodejs.org/dist/latest-v5.x/docs/api/modules.html" title="Node/CJS Modules">Require</a> for modules</li></ul>
+-   [Benjamin Lupton](https://balupton.com) — Accelerating collaborative wisdom.
 
-<!-- /INSTALL -->
+#### Maintainers
 
+-   [Benjamin Lupton](https://balupton.com) — Accelerating collaborative wisdom.
 
-<!-- HISTORY/ -->
+#### Contributors
 
-<h2>History</h2>
+-   [Benjamin Lupton](https://github.com/balupton) — [view contributions](https://github.com/bevry/scandirectory/commits?author=balupton "View the GitHub contributions of Benjamin Lupton on repository bevry/scandirectory")
+-   [Bohdan](https://github.com/bohdanly) — [view contributions](https://github.com/bevry/scandirectory/commits?author=bohdanly "View the GitHub contributions of Bohdan on repository bevry/scandirectory")
+-   [Bohdan Lysenko](https://github.com/lysenkobv) — [view contributions](https://github.com/bevry/scandirectory/commits?author=lysenkobv "View the GitHub contributions of Bohdan Lysenko on repository bevry/scandirectory")
+-   [Sean Fridman](https://github.com/sfrdmn) — [view contributions](https://github.com/bevry/scandirectory/commits?author=sfrdmn "View the GitHub contributions of Sean Fridman on repository bevry/scandirectory")
 
-<a href="https://github.com/bevry/scandirectory/blob/master/HISTORY.md#files">Discover the release history by heading on over to the <code>HISTORY.md</code> file.</a>
+### Finances
 
-<!-- /HISTORY -->
-
-
-<!-- BACKERS/ -->
-
-<h2>Backers</h2>
-
-<h3>Maintainers</h3>
-
-These amazing people are maintaining this project:
-
-<ul><li><a href="https://balupton.com">Benjamin Lupton</a> — <a href="https://github.com/bevry/scandirectory/commits?author=balupton" title="View the GitHub contributions of Benjamin Lupton on repository bevry/scandirectory">view contributions</a></li></ul>
-
-<h3>Sponsors</h3>
-
-No sponsors yet! Will you be the first?
-
 <span class="badge-githubsponsors"><a href="https://github.com/sponsors/balupton" title="Donate to this project using GitHub Sponsors"><img src="https://img.shields.io/badge/github-donate-yellow.svg" alt="GitHub Sponsors donate button" /></a></span>
@@ -160,29 +114,54 @@ <span class="badge-thanksdev"><a href="https://thanks.dev/u/gh/bevry" title="Donate to this project using ThanksDev"><img src="https://img.shields.io/badge/thanksdev-donate-yellow.svg" alt="ThanksDev donate button" /></a></span>
 
-<h3>Contributors</h3>
+#### Sponsors
 
-These amazing people have contributed code to this project:
+-   [Andrew Nesbitt](https://nesbitt.io) — Software engineer and researcher
+-   [Balsa](https://balsa.com) — We're Balsa, and we're building tools for builders.
+-   [Codecov](https://codecov.io) — Empower developers with tools to improve code quality and testing.
+-   [Poonacha Medappa](https://poonachamedappa.com)
+-   [Rob Morris](https://github.com/Rob-Morris)
+-   [Sentry](https://sentry.io) — Real-time crash reporting for your web apps, mobile apps, and games.
+-   [Syntax](https://syntax.fm) — Syntax Podcast
 
-<ul><li><a href="https://balupton.com">Benjamin Lupton</a> — <a href="https://github.com/bevry/scandirectory/commits?author=balupton" title="View the GitHub contributions of Benjamin Lupton on repository bevry/scandirectory">view contributions</a></li>
-<li><a href="https://github.com/bohdanly">Bohdan</a> — <a href="https://github.com/bevry/scandirectory/commits?author=bohdanly" title="View the GitHub contributions of Bohdan on repository bevry/scandirectory">view contributions</a></li>
-<li><a href="https://github.com/lysenkobv">Bohdan Lysenko</a> — <a href="https://github.com/bevry/scandirectory/commits?author=lysenkobv" title="View the GitHub contributions of Bohdan Lysenko on repository bevry/scandirectory">view contributions</a></li>
-<li><a href="https://github.com/sfrdmn">Sean Fridman</a> — <a href="https://github.com/bevry/scandirectory/commits?author=sfrdmn" title="View the GitHub contributions of Sean Fridman on repository bevry/scandirectory">view contributions</a></li></ul>
+#### Donors
 
-<a href="https://github.com/bevry/scandirectory/blob/master/CONTRIBUTING.md#files">Discover how you can contribute by heading on over to the <code>CONTRIBUTING.md</code> file.</a>
+-   [Andrew Nesbitt](https://nesbitt.io)
+-   [Armen Mkrtchian](https://mogoni.dev)
+-   [Balsa](https://balsa.com)
+-   [Chad](https://opencollective.com/chad8)
+-   [Codecov](https://codecov.io)
+-   [dr.dimitru](https://veliovgroup.com)
+-   [Elliott Ditman](https://elliottditman.com)
+-   [entroniq](https://gitlab.com/entroniq)
+-   [GitHub](https://github.com/about)
+-   [Hunter Beast](https://cryptoquick.com)
+-   [Jean-Luc Geering](https://github.com/jlgeering)
+-   [Michael Duane Mooring](https://mdm.cc)
+-   [Michael Harry Scepaniak](https://michaelscepaniak.com)
+-   [Mohammed Shah](https://github.com/smashah)
+-   [Mr. Henry](https://mrhenry.be)
+-   [Nermal](https://arjunaditya.vercel.app)
+-   [Pleo](https://pleo.io)
+-   [Poonacha Medappa](https://poonachamedappa.com)
+-   [Rob Morris](https://github.com/Rob-Morris)
+-   [Robert de Forest](https://github.com/rdeforest)
+-   [Sentry](https://sentry.io)
+-   [ServieJS](https://github.com/serviejs)
+-   [Skunk Team](https://skunk.team)
+-   [Syntax](https://syntax.fm)
+-   [WriterJohnBuck](https://github.com/WriterJohnBuck)
 
 <!-- /BACKERS -->
 
-
 <!-- LICENSE/ -->
 
-<h2>License</h2>
+## License
 
 Unless stated otherwise all works are:
 
-<ul><li>Copyright &copy; 2011+ <a href="https://balupton.com">Benjamin Lupton</a></li>
-<li>Copyright &copy; 2014+ <a href="http://bevry.me">Bevry Pty Ltd</a></li></ul>
+-   Copyright &copy; [Benjamin Lupton](https://balupton.com)
 
 and licensed under:
 
-<ul><li><a href="http://spdx.org/licenses/Artistic-2.0.html">Artistic License 2.0</a></li></ul>
+-   [Artistic License 2.0](http://spdx.org/licenses/Artistic-2.0.html)
 
 <!-- /LICENSE -->

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

143605

increased by287.1%

Dependency count

2

decreased by-33.33%

Number of package files

29

increased by222.22%

Lines of code

2516

increased by776.66%

Is type module

Yes

Worsened metrics

Dev dependency count

15

increased by7.14%

Number of low quality alerts

1

increased byInfinity%

Number of lines in readme file

165

decreased by-11.29%

Number of low supply chain risk alerts

5

increased by150%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Addedignorefs@5.0.4(transitive)

• - Removedreaddir-cluster@^5.2.0

• - Removedignorefs@4.8.0(transitive)

• - Removedreaddir-cluster@5.3.0(transitive)

• Updatededitions@^6.21.0

• Updatedignorefs@^5.0.4