npm-packlist 2.1.5 → 3.0.0

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)
@@ -100,14 +97,15 @@ const npmWalker = Class => class Walker extends Class {
     // ignore a bunch of things by default at the root level.
     // also ignore anything in the main project node_modules hierarchy,
     // except bundled dependencies
-    if (!this.parent) {
+    if (this.isProject) {
       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, _=>_)
+      this.packageJsonCache = this.parent ? this.parent.packageJsonCache
+        : (opt.packageJsonCache || new Map())
+      super.onReadIgnoreFile(rootBuiltinRules, rules, _ => _)
     } else {
       this.bundled = []
       this.bundledScopes = []
@@ -115,8 +113,12 @@ const npmWalker = Class => class Walker extends Class {
     }
   }
 
+  get isProject () {
+    return !this.parent || this.parent.follow && this.isSymbolicLink
+  }
+
   onReaddir (entries) {
-    if (!this.parent) {
+    if (this.isProject) {
       entries = entries.filter(e =>
         e !== '.git' &&
         !(e === 'node_modules' && this.bundled.length === 0)
@@ -129,7 +131,7 @@ 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.isProject || !entries.includes('package.json')) {
       return super.onReaddir(entries)
     }
 
@@ -154,28 +156,32 @@ const npmWalker = Class => class Walker extends Class {
   }
 
   onReadPackageJson (entries, er, pkg) {
-    if (er)
+    if (er) {
       this.emit('error', er)
-    else
+    } else {
       this.getPackageFiles(entries, pkg)
+    }
   }
 
   mustHaveFilesFromPackage (pkg) {
     const files = []
-    if (pkg.browser)
+    if (pkg.browser) {
       files.push('/' + pkg.browser)
-    if (pkg.main)
+    }
+    if (pkg.main) {
       files.push('/' + pkg.main)
+    }
     if (pkg.bin) {
       // always an object because normalized already
-      for (const key in pkg.bin)
+      for (const key in pkg.bin) {
         files.push('/' + pkg.bin[key])
+      }
     }
     files.push(
       '/package.json',
       '/npm-shrinkwrap.json',
       '!/package-lock.json',
-      packageMustHaves,
+      packageMustHaves
     )
     return files
   }
@@ -199,8 +205,9 @@ const npmWalker = Class => class Walker extends Class {
     this.packageJsonCache.set(ig, pkg)
 
     // no files list, just return the normal readdir() result
-    if (!Array.isArray(pkg.files))
+    if (!Array.isArray(pkg.files)) {
       return super.onReaddir(entries)
+    }
 
     pkg.files.push(...this.mustHaveFilesFromPackage(pkg))
 
@@ -209,13 +216,15 @@ 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 || pkg.bundledDependencies) && 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) => {
       const excl = pattern.match(/^!+/)
-      if (excl)
+      if (excl) {
         pattern = pattern.substr(excl[0].length)
+      }
       // strip off any / from the start of the pattern.  /foo => foo
       pattern = pattern.replace(/^\/+/, '')
       // an odd number of ! means a negated pattern.  !!foo ==> foo
@@ -229,8 +238,9 @@ const npmWalker = Class => class Walker extends Class {
     const negates = new Set()
     const results = []
     const then = (pattern, negate, er, fileList, i) => {
-      if (er)
+      if (er) {
         return this.emit('error', er)
+      }
 
       results[i] = { negate, fileList }
       if (--n === 0) {
@@ -273,17 +283,17 @@ 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 isRoot = !this.parent
-    const pkg = isRoot && pkgre.test(entry) ?
+    const pkgre = /^node_modules\/(@[^/]+\/?[^/]+|[^/]+)(\/.*)?$/
+    const { isProject } = this
+    const pkg = isProject && pkgre.test(entry) ?
       entry.replace(pkgre, '$1') : null
-    const rootNM = isRoot && entry === 'node_modules'
-    const rootPJ = isRoot && entry === 'package.json'
+    const rootNM = isProject && entry === 'node_modules'
+    const rootPJ = isProject && entry === 'package.json'
 
     return (
       // if we're in a bundled package, check with the parent.
-      /^node_modules($|\/)/i.test(p) ? this.parent.filterEntry(
-          this.basename + '/' + entry, partial)
+      /^node_modules($|\/)/i.test(p) && !this.isProject ? this.parent.filterEntry(
+        this.basename + '/' + entry, partial)
 
       // if package is bundled, all files included
       // also include @scope dirs for bundled scoped deps
@@ -291,8 +301,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
@@ -304,32 +314,34 @@ const npmWalker = Class => class Walker extends Class {
       : packageMustHavesRE.test(entry) ? true
 
       // npm-shrinkwrap and package.json always included in the root pkg
-      : isRoot && (entry === 'npm-shrinkwrap.json' || entry === 'package.json')
+      : isProject && (entry === 'npm-shrinkwrap.json' || entry === 'package.json')
         ? true
 
       // package-lock never included
-      : isRoot && entry === 'package-lock.json' ? false
+        : isProject && 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)
     )
   }
 
   filterEntries () {
-    if (this.ignoreRules['.npmignore'])
+    if (this.ignoreRules['.npmignore']) {
       this.ignoreRules['.gitignore'] = null
+    }
     this.filterEntries = super.filterEntries
     super.filterEntries()
   }
 
   addIgnoreFile (file, then) {
     const ig = path.resolve(this.path, file)
-    if (file === 'package.json' && this.parent)
+    if (file === 'package.json' && !this.isProject) {
       then()
-    else if (this.packageJsonCache.has(ig))
+    } else if (this.packageJsonCache.has(ig)) {
       this.onPackageJson(ig, this.packageJsonCache.get(ig), then)
-    else
+    } else {
       super.addIgnoreFile(file, then)
+    }
   }
 
   onPackageJson (ig, pkg, then) {
@@ -353,19 +365,22 @@ const npmWalker = Class => class Walker extends Class {
   // 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))
+  stat ({ entry, file, dir }, then) {
+    if (nameIsBadForWindows(entry)) {
       then()
-    else
-      super.stat(entry, file, dir, 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())
+  // override parent onstat function to nix all symlinks, other than
+  // those coming out of the followed bundled symlink deps
+  onstat ({ st, entry, file, dir, isSymbolicLink }, then) {
+    if (st.isSymbolicLink()) {
       then()
-    else
-      super.onstat(st, entry, file, dir, then)
+    } else {
+      super.onstat({ st, entry, file, dir, isSymbolicLink }, then)
+    }
   }
 
   onReadIgnoreFile (file, data, then) {
@@ -377,8 +392,9 @@ const npmWalker = Class => class Walker extends Class {
         // ignore package.json files that are not json
         then()
       }
-    } else
+    } else {
       super.onReadIgnoreFile(file, data, then)
+    }
   }
 
   sort (a, b) {
@@ -396,8 +412,8 @@ class Walker extends npmWalker(IgnoreWalker) {
       this.onReadPackageJson(entries, er, pkg))
   }
 
-  walker (entry, then) {
-    new Walker(this.walkerOpt(entry)).on('done', then).start()
+  walker (entry, opt, then) {
+    new Walker(this.walkerOpt(entry, opt)).on('done', then).start()
   }
 }
 
@@ -415,8 +431,8 @@ class WalkerSync extends npmWalker(IgnoreWalkerSync) {
     }
   }
 
-  walker (entry, then) {
-    new WalkerSync(this.walkerOpt(entry)).start()
+  walker (entry, opt, then) {
+    new WalkerSync(this.walkerOpt(entry, opt)).start()
     then()
   }
 }
@@ -454,12 +470,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.5",
+  "version": "3.0.0",
   "description": "Get a list of the files to add from a folder into an npm package",
   "directories": {
     "test": "test"
@@ -8,32 +8,42 @@
   "main": "index.js",
   "dependencies": {
     "glob": "^7.1.6",
-    "ignore-walk": "^3.0.3",
+    "ignore-walk": "^4.0.1",
     "npm-bundled": "^1.1.1",
     "npm-normalize-package-bin": "^1.0.1"
   },
   "author": "Isaac Z. Schlueter <i@izs.me> (http://blog.izs.me/)",
   "license": "ISC",
   "files": [
+    "bin/index.js",
     "index.js"
   ],
   "devDependencies": {
+    "@npmcli/lint": "^1.0.2",
     "mutate-fs": "^2.1.1",
-    "require-inject": "^1.4.4",
-    "tap": "^14.10.8"
+    "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 npmclilint -- \"*.*js\" \"test/**/*.*js\"",
+    "lintfix": "npm run lint -- --fix",
+    "npmclilint": "npmcli-lint"
   },
   "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",