npm-packlist 2.1.4 → 2.2.2

package/bin/index.js

@@ -12,13 +12,14 @@ process.argv.slice(2).forEach(arg => {
     dirs.push(arg)
 })
 
-const sort = list => doSort ? list.sort((a, b) => a.localeCompare(b)) : list
+const sort = list => doSort ? list.sort((a, b) => a.localeCompare(b, 'en')) : list
 
 const packlist = require('../')
 if (!dirs.length)
   console.log(sort(packlist.sync({ path: process.cwd() })).join('\n'))
-else
+else {
   dirs.forEach(path => {
     console.log(`> ${path}`)
     console.log(sort(packlist.sync({ path })).join('\n'))
   })
+}

package/index.js

@@ -26,11 +26,10 @@ 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')
+const packageMustHavesRE = new RegExp(`^(${packageMustHaveFileNames})(\\..*[^~$])?$`, 'i')
 
 const fs = require('fs')
 const glob = require('glob')
@@ -76,13 +75,11 @@ const npmWalker = Class => class Walker extends Class {
       'package.json',
       '.npmignore',
       '.gitignore',
-      packageNecessaryRules
+      packageNecessaryRules,
     ]
 
     opt.includeEmpty = false
     opt.path = opt.path || process.cwd()
-    const dirName = path.basename(opt.path)
-    const parentName = path.basename(path.dirname(opt.path))
 
     // only follow links in the root node_modules folder, because if those
     // folders are included, it's because they're bundled, and bundles
@@ -90,7 +87,7 @@ const npmWalker = Class => class Walker extends Class {
     // This regexp tests to see that we're either a node_modules folder,
     // or a @scope within a node_modules folder, in the root's node_modules
     // hierarchy (ie, not in test/foo/node_modules/ or something).
-    const followRe = /^(?:\/node_modules\/(?:@[^\/]+\/[^\/]+|[^\/]+)\/)*\/node_modules(?:\/@[^\/]+)?$/
+    const followRe = /^(?:\/node_modules\/(?:@[^/]+\/[^/]+|[^/]+)\/)*\/node_modules(?:\/@[^/]+)?$/
     const rootPath = opt.parent ? opt.parent.root : opt.path
     const followTestPath = opt.path.replace(/\\/g, '/').substr(rootPath.length)
     opt.follow = followRe.test(followTestPath)
@@ -104,10 +101,10 @@ const npmWalker = Class => class Walker extends Class {
       this.bundled = opt.bundled || []
       this.bundledScopes = Array.from(new Set(
         this.bundled.filter(f => /^@/.test(f))
-        .map(f => f.split('/')[0])))
+          .map(f => f.split('/')[0])))
       const rules = defaultRules.join('\n') + '\n'
       this.packageJsonCache = opt.packageJsonCache || new Map()
-      super.onReadIgnoreFile(rootBuiltinRules, rules, _=>_)
+      super.onReadIgnoreFile(rootBuiltinRules, rules, _ => _)
     } else {
       this.bundled = []
       this.bundledScopes = []
@@ -129,9 +126,8 @@ const npmWalker = Class => class Walker extends Class {
     // to be in the state the user wants to include them, and
     // a package.json somewhere else might be a template or
     // test or something else entirely.
-    if (this.parent || !entries.includes('package.json')) {
+    if (this.parent || !entries.includes('package.json'))
       return super.onReaddir(entries)
-    }
 
     // when the cache has been seeded with the root manifest,
     // we must respect that (it may differ from the filesystem)
@@ -141,9 +137,8 @@ const npmWalker = Class => class Walker extends Class {
       const pkg = this.packageJsonCache.get(ig)
 
       // fall back to filesystem when seeded manifest is invalid
-      if (!pkg || typeof pkg !== 'object') {
+      if (!pkg || typeof pkg !== 'object')
         return this.readPackageJson(entries)
-      }
 
       // feels wonky, but this ensures package bin is _always_
       // normalized, as well as guarding against invalid JSON
@@ -175,13 +170,20 @@ const npmWalker = Class => class Walker extends Class {
       '/package.json',
       '/npm-shrinkwrap.json',
       '!/package-lock.json',
-      packageMustHaves,
+      packageMustHaves
     )
     return files
   }
 
   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 +204,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) => {
@@ -226,9 +228,8 @@ const npmWalker = Class => class Walker extends Class {
         return this.emit('error', er)
 
       results[i] = { negate, fileList }
-      if (--n === 0) {
+      if (--n === 0)
         processResults(results)
-      }
     }
     const processResults = results => {
       for (const {negate, fileList} of results) {
@@ -266,7 +267,7 @@ const npmWalker = Class => class Walker extends Class {
   filterEntry (entry, partial) {
     // get the partial path from the root of the walk
     const p = this.path.substr(this.root.length + 1)
-    const pkgre = /^node_modules\/(@[^\/]+\/?[^\/]+|[^\/]+)(\/.*)?$/
+    const pkgre = /^node_modules\/(@[^/]+\/?[^/]+|[^/]+)(\/.*)?$/
     const isRoot = !this.parent
     const pkg = isRoot && pkgre.test(entry) ?
       entry.replace(pkgre, '$1') : null
@@ -276,7 +277,7 @@ const npmWalker = Class => class Walker extends Class {
     return (
       // if we're in a bundled package, check with the parent.
       /^node_modules($|\/)/i.test(p) ? this.parent.filterEntry(
-          this.basename + '/' + entry, partial)
+        this.basename + '/' + entry, partial)
 
       // if package is bundled, all files included
       // also include @scope dirs for bundled scoped deps
@@ -284,8 +285,8 @@ const npmWalker = Class => class Walker extends Class {
       // However, this only matters if we're in the root.
       // node_modules folders elsewhere, like lib/node_modules,
       // should be included normally unless ignored.
-      : pkg ? -1 !== this.bundled.indexOf(pkg) ||
-        -1 !== this.bundledScopes.indexOf(pkg)
+      : pkg ? this.bundled.indexOf(pkg) !== -1 ||
+        this.bundledScopes.indexOf(pkg) !== -1
 
       // only walk top node_modules if we want to bundle something
       : rootNM ? !!this.bundled.length
@@ -301,10 +302,10 @@ const npmWalker = Class => class Walker extends Class {
         ? true
 
       // package-lock never included
-      : isRoot && entry === 'package-lock.json' ? false
+        : isRoot && entry === 'package-lock.json' ? false
 
-      // otherwise, follow ignore-walk's logic
-      : super.filterEntry(entry, partial)
+        // otherwise, follow ignore-walk's logic
+        : super.filterEntry(entry, partial)
     )
   }
 
@@ -447,12 +448,11 @@ const sort = (a, b) => {
   const basea = path.basename(a).toLowerCase()
   const baseb = path.basename(b).toLowerCase()
 
-  return exta.localeCompare(extb) ||
-    basea.localeCompare(baseb) ||
-    a.localeCompare(b)
+  return exta.localeCompare(extb, 'en') ||
+    basea.localeCompare(baseb, 'en') ||
+    a.localeCompare(b, 'en')
 }
 
-
 module.exports = walk
 walk.sync = walkSync
 walk.Walker = Walker

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "npm-packlist",
-  "version": "2.1.4",
+  "version": "2.2.2",
   "description": "Get a list of the files to add from a folder into an npm package",
   "directories": {
     "test": "test"
@@ -15,25 +15,38 @@
   "author": "Isaac Z. Schlueter <i@izs.me> (http://blog.izs.me/)",
   "license": "ISC",
   "files": [
+    "bin/index.js",
     "index.js"
   ],
   "devDependencies": {
+    "eslint": "^7.25.0",
+    "eslint-plugin-import": "^2.22.1",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-promise": "^5.1.0",
+    "eslint-plugin-standard": "^5.0.0",
     "mutate-fs": "^2.1.1",
-    "require-inject": "^1.4.4",
-    "tap": "^14.10.7"
+    "tap": "^15.0.6"
   },
   "scripts": {
     "test": "tap",
+    "posttest": "npm run lint",
     "snap": "tap",
+    "postsnap": "npm run lintfix",
     "preversion": "npm test",
     "postversion": "npm publish",
-    "prepublishOnly": "git push origin --follow-tags"
+    "prepublishOnly": "git push origin --follow-tags",
+    "eslint": "eslint",
+    "lint": "npm run eslint -- index.js bin/index.js \"test/**/*.js\"",
+    "lintfix": "npm run lint -- --fix"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/npm/npm-packlist.git"
   },
   "tap": {
+    "test-env": [
+      "LC_ALL=sk"
+    ],
     "check-coverage": true,
     "nyc-arg": [
       "--include=index.js",