npm-packlist 1.4.3 → 1.4.7

package/index.js

@@ -17,6 +17,8 @@ const rootBuiltinRules = Symbol('root-builtin-rules')
 const packageNecessaryRules = Symbol('package-necessary-rules')
 const path = require('path')
 
+const normalizePackageBin = require('npm-normalize-package-bin')
+
 const defaultRules = [
   '.npmignore',
   '.gitignore',
@@ -51,6 +53,9 @@ const defaultRules = [
   'core.+([0-9])',
 ]
 
+// There may be others, but :?|<> are handled by node-tar
+const nameIsBadForWindows = file => /\*/.test(file)
+
 // a decorator that applies our custom rules to an ignore walker
 const npmWalker = Class => class Walker extends Class {
   constructor (opt) {
@@ -92,8 +97,12 @@ const npmWalker = Class => class Walker extends Class {
   }
 
   onReaddir (entries) {
-    if (!this.parent)
-      entries = entries.filter(e => e !== '.git')
+    if (!this.parent) {
+      entries = entries.filter(e =>
+        e !== '.git' &&
+        !(e === 'node_modules' && this.bundled.length === 0)
+      )
+    }
     return super.onReaddir(entries)
   }
 
@@ -166,14 +175,14 @@ const npmWalker = Class => class Walker extends Class {
       pkg.browser ? '!' + pkg.browser : '',
       pkg.main ? '!' + pkg.main : '',
       '!package.json',
+      '!npm-shrinkwrap.json',
       '!@(readme|copying|license|licence|notice|changes|changelog|history){,.*[^~$]}'
     ]
-    if (pkg.bin)
-      if (typeof pkg.bin === "object")
-        for (const key in pkg.bin)
-          rules.push('!' + pkg.bin[key])
-      else
-        rules.push('!' + pkg.bin)
+    if (pkg.bin) {
+      // always an object, because normalized already
+      for (const key in pkg.bin)
+        rules.push('!' + pkg.bin[key])
+    }
 
     const data = rules.filter(f => f).join('\n') + '\n'
     super.onReadIgnoreFile(packageNecessaryRules, data, _=>_)
@@ -186,6 +195,16 @@ const npmWalker = Class => class Walker extends Class {
       then()
   }
 
+  // override parent stat function to completely skip any filenames
+  // that will break windows entirely.
+  // XXX(isaacs) Next major version should make this an error instead.
+  stat (entry, file, dir, then) {
+    if (nameIsBadForWindows(entry))
+      then()
+    else
+      super.stat(entry, file, dir, then)
+  }
+
   // override parent onstat function to nix all symlinks
   onstat (st, entry, file, dir, then) {
     if (st.isSymbolicLink())
@@ -198,7 +217,7 @@ const npmWalker = Class => class Walker extends Class {
     if (file === 'package.json')
       try {
         const ig = path.resolve(this.path, file)
-        this.onPackageJson(ig, JSON.parse(data), then)
+        this.onPackageJson(ig, normalizePackageBin(JSON.parse(data)), then)
       } catch (er) {
         // ignore package.json files that are not json
         then()
@@ -249,15 +268,20 @@ const walkSync = options => {
   return walker.result
 }
 
-// package.json first, node_modules last, files before folders, alphasort
-const sort = (a, b) =>
-  a === 'package.json' ? -1
-  : b === 'package.json' ? 1
-  : /^node_modules/.test(a) && !/^node_modules/.test(b) ? 1
-  : /^node_modules/.test(b) && !/^node_modules/.test(a) ? -1
-  : path.dirname(a) === '.' && path.dirname(b) !== '.' ? -1
-  : path.dirname(b) === '.' && path.dirname(a) !== '.' ? 1
-  : a.localeCompare(b)
+// optimize for compressibility
+// extname, then basename, then locale alphabetically
+// https://twitter.com/isntitvacant/status/1131094910923231232
+const sort = (a, b) => {
+  const exta = path.extname(a).toLowerCase()
+  const extb = path.extname(b).toLowerCase()
+  const basea = path.basename(a).toLowerCase()
+  const baseb = path.basename(b).toLowerCase()
+
+  return exta.localeCompare(extb) ||
+    basea.localeCompare(baseb) ||
+    a.localeCompare(b)
+}
+
 
 module.exports = walk
 walk.sync = walkSync

package/package.json

@@ -1,6 +1,9 @@
 {
   "name": "npm-packlist",
-  "version": "1.4.3",
+  "version": "1.4.7",
+  "publishConfig": {
+    "tag": "legacy-v1"
+  },
   "description": "Get a list of the files to add from a folder into an npm package",
   "directories": {
     "test": "test"
@@ -18,13 +21,14 @@
   "devDependencies": {
     "mkdirp": "^0.5.1",
     "rimraf": "^2.6.1",
-    "tap": "^11.1.5"
+    "tap": "^14.6.9"
   },
   "scripts": {
-    "test": "tap test/*.js --100 -J",
+    "test": "tap",
+    "snap": "tap",
     "preversion": "npm test",
     "postversion": "npm publish",
-    "postpublish": "git push origin --all --follow-tags"
+    "postpublish": "git push origin --follow-tags"
   },
   "repository": {
     "type": "git",
@@ -33,5 +37,8 @@
   "bugs": {
     "url": "https://github.com/npm/npm-packlist/issues"
   },
-  "homepage": "https://www.npmjs.com/package/npm-packlist"
+  "homepage": "https://www.npmjs.com/package/npm-packlist",
+  "tap": {
+    "jobs": 1
+  }
 }