npm-packlist 3.0.0 → 5.0.1

package/bin/index.js

@@ -1,4 +1,7 @@
 #!/usr/bin/env node
+'use strict'
+
+const packlist = require('../')
 
 const dirs = []
 let doSort = false
@@ -6,20 +9,31 @@ process.argv.slice(2).forEach(arg => {
   if (arg === '-h' || arg === '--help') {
     console.log('usage: npm-packlist [-s --sort] [directory, directory, ...]')
     process.exit(0)
-  } else if (arg === '-s' || arg === '--sort')
+  } else if (arg === '-s' || arg === '--sort') {
     doSort = true
-  else
+  } else {
     dirs.push(arg)
+  }
 })
 
 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 {
-  dirs.forEach(path => {
-    console.log(`> ${path}`)
-    console.log(sort(packlist.sync({ path })).join('\n'))
-  })
+const main = async () => {
+  if (!dirs.length) {
+    const results = await packlist({ path: process.cwd() })
+    console.log(sort(results).join('\n'))
+  } else {
+    for (const dir of dirs) {
+      console.group(`> ${dir}`)
+      const results = await packlist({ path: dir })
+      console.log(sort(results).join('\n'))
+      console.groupEnd()
+    }
+  }
 }
+
+// coverage disabled for catch handler because we don't need to test that
+main().catch(/* istanbul ignore next */(err) => {
+  process.exitCode = 1
+  console.error(err.stack)
+})

package/{index.js → lib/index.js}

@@ -7,11 +7,9 @@
 
 const bundleWalk = require('npm-bundled')
 const BundleWalker = bundleWalk.BundleWalker
-const BundleWalkerSync = bundleWalk.BundleWalkerSync
 
 const ignoreWalk = require('ignore-walk')
 const IgnoreWalker = ignoreWalk.Walker
-const IgnoreWalkerSync = ignoreWalk.WalkerSync
 
 const rootBuiltinRules = Symbol('root-builtin-rules')
 const packageNecessaryRules = Symbol('package-necessary-rules')
@@ -34,6 +32,24 @@ const packageMustHavesRE = new RegExp(`^(${packageMustHaveFileNames})(\\..*[^~$]
 const fs = require('fs')
 const glob = require('glob')
 
+const pathHasPkg = (input) => {
+  if (!input.startsWith('node_modules/')) {
+    return false
+  }
+
+  const segments = input.slice('node_modules/'.length).split('/', 2)
+  return segments[0].startsWith('@')
+    ? segments.length === 2
+    : true
+}
+
+const pkgFromPath = (input) => {
+  const segments = input.slice('node_modules/'.length).split('/', 2)
+  return segments[0].startsWith('@')
+    ? segments.join('/')
+    : segments[0]
+}
+
 const defaultRules = [
   '.npmignore',
   '.gitignore',
@@ -58,14 +74,14 @@ const defaultRules = [
   '*.orig',
   '/package-lock.json',
   '/yarn.lock',
+  '/pnpm-lock.yaml',
   '/archived-packages/**',
 ]
 
 // 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 {
+class Walker extends IgnoreWalker {
   constructor (opt) {
     opt = opt || {}
 
@@ -89,7 +105,7 @@ const npmWalker = Class => class Walker extends Class {
     // hierarchy (ie, not in test/foo/node_modules/ or something).
     const followRe = /^(?:\/node_modules\/(?:@[^/]+\/[^/]+|[^/]+)\/)*\/node_modules(?:\/@[^/]+)?$/
     const rootPath = opt.parent ? opt.parent.root : opt.path
-    const followTestPath = opt.path.replace(/\\/g, '/').substr(rootPath.length)
+    const followTestPath = opt.path.replace(/\\/g, '/').slice(rootPath.length)
     opt.follow = followRe.test(followTestPath)
 
     super(opt)
@@ -223,7 +239,7 @@ const npmWalker = Class => class Walker extends Class {
     const patterns = Array.from(new Set(pkg.files)).reduce((set, pattern) => {
       const excl = pattern.match(/^!+/)
       if (excl) {
-        pattern = pattern.substr(excl[0].length)
+        pattern = pattern.slice(excl[0].length)
       }
       // strip off any / from the start of the pattern.  /foo => foo
       pattern = pattern.replace(/^\/+/, '')
@@ -247,8 +263,8 @@ const npmWalker = Class => class Walker extends Class {
         processResults(results)
       }
     }
-    const processResults = results => {
-      for (const {negate, fileList} of results) {
+    const processResults = processed => {
+      for (const { negate, fileList } of processed) {
         if (negate) {
           fileList.forEach(f => {
             f = f.replace(/\/+$/, '')
@@ -276,17 +292,17 @@ const npmWalker = Class => class Walker extends Class {
     // 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) =>
+    patterns.forEach(({ pattern, negate }, i) =>
       this.globFiles(pattern, (er, res) => then(pattern, negate, er, res, i)))
   }
 
   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 p = this.path.slice(this.root.length + 1)
     const { isProject } = this
-    const pkg = isProject && pkgre.test(entry) ?
-      entry.replace(pkgre, '$1') : null
+    const pkg = isProject && pathHasPkg(entry)
+      ? pkgFromPath(entry)
+      : null
     const rootNM = isProject && entry === 'node_modules'
     const rootPJ = isProject && entry === 'package.json'
 
@@ -398,11 +414,19 @@ const npmWalker = Class => class Walker extends Class {
   }
 
   sort (a, b) {
-    return sort(a, b)
+    // optimize for compressibility
+    // extname, then basename, then locale alphabetically
+    // https://twitter.com/isntitvacant/status/1131094910923231232
+    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, 'en') ||
+      basea.localeCompare(baseb, 'en') ||
+      a.localeCompare(b, 'en')
   }
-}
 
-class Walker extends npmWalker(IgnoreWalker) {
   globFiles (pattern, cb) {
     glob(pattern, { dot: true, cwd: this.path, nocase: true }, cb)
   }
@@ -417,26 +441,6 @@ class Walker extends npmWalker(IgnoreWalker) {
   }
 }
 
-class WalkerSync extends npmWalker(IgnoreWalkerSync) {
-  globFiles (pattern, cb) {
-    cb(null, glob.sync(pattern, { dot: true, cwd: this.path, nocase: true }))
-  }
-
-  readPackageJson (entries) {
-    const p = this.path + '/package.json'
-    try {
-      this.onReadPackageJson(entries, null, fs.readFileSync(p))
-    } catch (er) {
-      this.onReadPackageJson(entries, er)
-    }
-  }
-
-  walker (entry, opt, then) {
-    new WalkerSync(this.walkerOpt(entry, opt)).start()
-    then()
-  }
-}
-
 const walk = (options, callback) => {
   options = options || {}
   const p = new Promise((resolve, reject) => {
@@ -451,31 +455,5 @@ const walk = (options, callback) => {
   return callback ? p.then(res => callback(null, res), callback) : p
 }
 
-const walkSync = options => {
-  options = options || {}
-  const bw = new BundleWalkerSync(options).start()
-  options.bundled = bw.result
-  options.packageJsonCache = bw.packageJsonCache
-  const walker = new WalkerSync(options)
-  walker.start()
-  return walker.result
-}
-
-// 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, 'en') ||
-    basea.localeCompare(baseb, 'en') ||
-    a.localeCompare(b, 'en')
-}
-
 module.exports = walk
-walk.sync = walkSync
 walk.Walker = Walker
-walk.WalkerSync = WalkerSync

package/package.json

@@ -1,59 +1,61 @@
 {
   "name": "npm-packlist",
-  "version": "3.0.0",
+  "version": "5.0.1",
   "description": "Get a list of the files to add from a folder into an npm package",
   "directories": {
     "test": "test"
   },
-  "main": "index.js",
+  "main": "lib",
   "dependencies": {
-    "glob": "^7.1.6",
-    "ignore-walk": "^4.0.1",
-    "npm-bundled": "^1.1.1",
+    "glob": "^8.0.1",
+    "ignore-walk": "^5.0.1",
+    "npm-bundled": "^1.1.2",
     "npm-normalize-package-bin": "^1.0.1"
   },
-  "author": "Isaac Z. Schlueter <i@izs.me> (http://blog.izs.me/)",
+  "author": "GitHub Inc.",
   "license": "ISC",
   "files": [
-    "bin/index.js",
-    "index.js"
+    "bin/",
+    "lib/"
   ],
   "devDependencies": {
-    "@npmcli/lint": "^1.0.2",
+    "@npmcli/eslint-config": "^3.0.1",
+    "@npmcli/template-oss": "3.4.1",
     "mutate-fs": "^2.1.1",
-    "tap": "^15.0.6"
+    "tap": "^16.0.1"
   },
   "scripts": {
     "test": "tap",
-    "posttest": "npm run lint --",
+    "posttest": "npm run lint",
     "snap": "tap",
     "postsnap": "npm run lintfix --",
     "preversion": "npm test",
     "postversion": "npm publish",
     "prepublishOnly": "git push origin --follow-tags",
     "eslint": "eslint",
-    "lint": "npm run npmclilint -- \"*.*js\" \"test/**/*.*js\"",
+    "lint": "eslint \"**/*.js\"",
     "lintfix": "npm run lint -- --fix",
-    "npmclilint": "npmcli-lint"
+    "npmclilint": "npmcli-lint",
+    "postlint": "template-oss-check",
+    "template-oss-apply": "template-oss-apply --force"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/npm/npm-packlist.git"
+    "url": "https://github.com/npm/npm-packlist.git"
   },
   "tap": {
     "test-env": [
       "LC_ALL=sk"
-    ],
-    "check-coverage": true,
-    "nyc-arg": [
-      "--include=index.js",
-      "--include=bin/index.js"
     ]
   },
   "bin": {
     "npm-packlist": "bin/index.js"
   },
   "engines": {
-    "node": ">=10"
+    "node": "^12.13.0 || ^14.15.0 || >=16.0.0"
+  },
+  "templateOSS": {
+    "//@npmcli/template-oss": "This file is partially managed by @npmcli/template-oss. Edits may be overwritten.",
+    "version": "3.4.1"
   }
 }