npm-packlist 2.1.2 → 2.2.0

package/index.js

@@ -26,8 +26,7 @@ const normalizePackageBin = require('npm-normalize-package-bin')
 // localized documentation and other use cases.  Adding a `/` to
 // these rules, while tempting and arguably more "correct", is a
 // significant change that will break existing use cases.
-const packageMustHaveFileNames =
-  'readme|copying|license|licence|notice|changes|changelog|history'
+const packageMustHaveFileNames = 'readme|copying|license|licence'
 
 const packageMustHaves = `@(${packageMustHaveFileNames}){,.*[^~$]}`
 const packageMustHavesRE = new RegExp(`^(${packageMustHaveFileNames})(\\..*[^~\$])?$`, 'i')
@@ -182,6 +181,13 @@ const npmWalker = Class => class Walker extends Class {
 
   getPackageFiles (entries, pkg) {
     try {
+      // XXX this could be changed to use read-package-json-fast
+      // which handles the normalizing of bins for us, and simplifies
+      // the test for bundleDependencies and bundledDependencies later.
+      // HOWEVER if we do this, we need to be sure that we're careful
+      // about what we write back out since rpj-fast removes some fields
+      // that the user likely wants to keep. it also would add a second
+      // file read that we would want to optimize away.
       pkg = normalizePackageBin(JSON.parse(pkg.toString()))
     } catch (er) {
       // not actually a valid package.json
@@ -202,7 +208,7 @@ const npmWalker = Class => class Walker extends Class {
     // the files list as the effective readdir result, that means it
     // looks like we don't have a node_modules folder at all unless we
     // include it here.
-    if (pkg.bundleDependencies && entries.includes('node_modules'))
+    if ((pkg.bundleDependencies || pkg.bundledDependencies) && entries.includes('node_modules'))
       pkg.files.push('node_modules')
 
     const patterns = Array.from(new Set(pkg.files)).reduce((set, pattern) => {
@@ -220,35 +226,47 @@ const npmWalker = Class => class Walker extends Class {
     let n = patterns.length
     const set = new Set()
     const negates = new Set()
-    const then = (pattern, negate, er, fileList) => {
+    const results = []
+    const then = (pattern, negate, er, fileList, i) => {
       if (er)
         return this.emit('error', er)
 
-      if (negate) {
-        fileList.forEach(f => {
-          set.delete(f)
-          negates.add(f)
-        })
-      } else {
-        fileList.forEach(f => {
-          set.add(f)
-          negates.delete(f)
-        })
-      }
-
+      results[i] = { negate, fileList }
       if (--n === 0) {
-        const list = Array.from(set)
-        // replace the files array with our computed explicit set
-        pkg.files = list.concat(Array.from(negates).map(f => '!' + f))
-        const rdResult = Array.from(new Set(
-          list.map(f => f.replace(/^\/+/, ''))
-        ))
-        super.onReaddir(rdResult)
+        processResults(results)
       }
     }
+    const processResults = results => {
+      for (const {negate, fileList} of results) {
+        if (negate) {
+          fileList.forEach(f => {
+            f = f.replace(/\/+$/, '')
+            set.delete(f)
+            negates.add(f)
+          })
+        } else {
+          fileList.forEach(f => {
+            f = f.replace(/\/+$/, '')
+            set.add(f)
+            negates.delete(f)
+          })
+        }
+      }
+
+      const list = Array.from(set)
+      // replace the files array with our computed explicit set
+      pkg.files = list.concat(Array.from(negates).map(f => '!' + f))
+      const rdResult = Array.from(new Set(
+        list.map(f => f.replace(/^\/+/, ''))
+      ))
+      super.onReaddir(rdResult)
+    }
 
-    patterns.forEach(({pattern, negate}) =>
-      this.globFiles(pattern, (er, res) => then(pattern, negate, er, res)))
+    // maintain the index so that we process them in-order only once all
+    // are completed, otherwise the parallelism messes things up, since a
+    // glob like **/*.js will always be slower than a subsequent !foo.js
+    patterns.forEach(({pattern, negate}, i) =>
+      this.globFiles(pattern, (er, res) => then(pattern, negate, er, res, i)))
   }
 
   filterEntry (entry, partial) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "npm-packlist",
-  "version": "2.1.2",
+  "version": "2.2.0",
   "description": "Get a list of the files to add from a folder into an npm package",
   "directories": {
     "test": "test"
@@ -15,19 +15,19 @@
   "author": "Isaac Z. Schlueter <i@izs.me> (http://blog.izs.me/)",
   "license": "ISC",
   "files": [
+    "bin/index.js",
     "index.js"
   ],
   "devDependencies": {
     "mutate-fs": "^2.1.1",
-    "require-inject": "^1.4.4",
-    "tap": "^14.10.7"
+    "tap": "^15.0.6"
   },
   "scripts": {
     "test": "tap",
     "snap": "tap",
     "preversion": "npm test",
     "postversion": "npm publish",
-    "postpublish": "git push origin --follow-tags"
+    "prepublishOnly": "git push origin --follow-tags"
   },
   "repository": {
     "type": "git",
@@ -40,7 +40,9 @@
       "--include=bin/index.js"
     ]
   },
-  "bin": "bin/index.js",
+  "bin": {
+    "npm-packlist": "bin/index.js"
+  },
   "engines": {
     "node": ">=10"
   }