npm-packlist 6.0.0 → 7.0.0-pre.0

package/README.md

@@ -6,20 +6,24 @@ These can be handed to [tar](http://npm.im/tar) like so to make an npm
 package tarball:
 
 ```js
+const Arborist = require('@npmcli/arborist')
 const packlist = require('npm-packlist')
 const tar = require('tar')
 const packageDir = '/path/to/package'
 const packageTarball = '/path/to/package.tgz'
 
-packlist({ path: packageDir })
-  .then(files => tar.create({
-    prefix: 'package/',
-    cwd: packageDir,
-    file: packageTarball,
-    gzip: true
-  }, files))
-  .then(_ => {
-    // tarball has been created, continue with your day
+const arborist = new Arborist({ path: packageDir })
+arborist.loadActual().then((tree) => {
+  packlist(tree)
+    .then(files => tar.create({
+      prefix: 'package/',
+      cwd: packageDir,
+      file: packageTarball,
+      gzip: true
+    }, files))
+    .then(_ => {
+      // tarball has been created, continue with your day
+    })
   })
 ```
 
@@ -97,7 +101,6 @@ Any specific file matched by an exact filename in the package.json `files` list
 
 ## API
 
-Same API as [ignore-walk](http://npm.im/ignore-walk), just hard-coded
-file list and rule sets.
+Same API as [ignore-walk](http://npm.im/ignore-walk), except providing a `tree` is required and there are hard-coded file list and rule sets.
 
-The `Walker` class will load an [arborist](https://github.com/npm/cli/tree/latest/workspaces/arborist) tree, and if any bundled dependencies are found will include them as well as their own dependencies in the resulting file set.
+The `Walker` class requires an [arborist](https://github.com/npm/cli/tree/latest/workspaces/arborist) tree, and if any bundled dependencies are found will include them as well as their own dependencies in the resulting file set.

package/lib/index.js

@@ -1,6 +1,5 @@
 'use strict'
 
-const Arborist = require('@npmcli/arborist')
 const { Walker: IgnoreWalker } = require('ignore-walk')
 const { lstatSync: lstat, readFileSync: readFile } = require('fs')
 const { basename, dirname, extname, join, relative, resolve, sep } = require('path')
@@ -81,30 +80,26 @@ const readOutOfTreeIgnoreFiles = (root, rel, result = []) => {
 }
 
 class PackWalker extends IgnoreWalker {
-  constructor (opts) {
+  constructor (tree, opts) {
     const options = {
       ...opts,
       includeEmpty: false,
       follow: false,
-    }
-
-    // we path.resolve() here because ignore-walk doesn't do it and we want full paths
-    options.path = resolve(options.path || process.cwd()).replace(/\\/g, '/')
-
-    if (!options.ignoreFiles) {
-      options.ignoreFiles = [
+      // we path.resolve() here because ignore-walk doesn't do it and we want full paths
+      path: resolve(opts?.path || tree.path).replace(/\\/g, '/'),
+      ignoreFiles: opts?.ignoreFiles || [
         defaultRules,
         'package.json',
         '.npmignore',
         '.gitignore',
         strictRules,
-      ]
+      ],
     }
 
     super(options)
     this.isPackage = options.isPackage
     this.seen = options.seen || new Set()
-    this.tree = options.tree // no default, we'll load the tree later if we need to
+    this.tree = tree
     this.requiredFiles = options.requiredFiles || []
 
     const additionalDefaults = []
@@ -202,37 +197,16 @@ class PackWalker extends IgnoreWalker {
     return super.stat(opts, callback)
   }
 
-  // overridden method: we need to load the arborist tree before we actually start running
-  start () {
-    if (this.isPackage && !this.tree) {
-      const arborist = new Arborist({ path: this.path })
-      // loading the tree is async while the start function depends on being sync
-      // eslint-disable-next-line promise/catch-or-return, promise/always-return
-      arborist.loadActual().then((tree) => {
-        this.tree = tree
-        super.start()
-      })
-      return this
-    }
-
-    return super.start()
-  }
-
   // overridden method: this is called to create options for a child walker when we step
   // in to a normal child directory (this will never be a bundle). the default method here
   // copies the root's `ignoreFiles` value, but we don't want to respect package.json for
   // subdirectories, so we override it with a list that intentionally omits package.json
   walkerOpt (entry, opts) {
-    let ignoreFiles = [
-      defaultRules,
-      '.npmignore',
-      '.gitignore',
-      strictRules,
-    ]
+    let ignoreFiles = null
 
     // however, if we have a tree, and we have workspaces, and the directory we're about
     // to step into is a workspace, then we _do_ want to respect its package.json
-    if (this.tree && this.tree.workspaces) {
+    if (this.tree.workspaces) {
       const workspaceDirs = [...this.tree.workspaces.values()]
         .map((dir) => dir.replace(/\\/g, '/'))
 
@@ -246,6 +220,13 @@ class PackWalker extends IgnoreWalker {
           strictRules,
         ]
       }
+    } else {
+      ignoreFiles = [
+        defaultRules,
+        '.npmignore',
+        '.gitignore',
+        strictRules,
+      ]
     }
 
     return {
@@ -265,7 +246,7 @@ class PackWalker extends IgnoreWalker {
 
   // overridden method: we want child walkers to be instances of this class, not ignore-walk
   walker (entry, opts, callback) {
-    new PackWalker(this.walkerOpt(entry, opts)).on('done', callback).start()
+    new PackWalker(this.tree, this.walkerOpt(entry, opts)).on('done', callback).start()
   }
 
   // overridden method: we use a custom sort method to help compressibility
@@ -368,7 +349,7 @@ class PackWalker extends IgnoreWalker {
   // custom method: after we've finished gathering the files for the root package, we call this
   // before emitting the 'done' event in order to gather all of the files for bundled deps
   async gatherBundles () {
-    if (this.tree && this.seen.has(this.tree)) {
+    if (this.seen.has(this.tree)) {
       return
     }
 
@@ -397,14 +378,16 @@ class PackWalker extends IgnoreWalker {
 
       // get a reference to the node we're bundling
       const node = this.tree.edgesOut.get(dep).to
+      // we use node.path for the path because we want the location the node was linked to,
+      // not where it actually lives on disk
+      const path = node.path
+      // but link nodes don't have edgesOut, so we need to pass in the target of the node
+      // in order to make sure we correctly traverse its dependencies
+      const tree = node.target
+
       // and start building options to be passed to the walker for this package
       const walkerOpts = {
-        // we use node.path for the path because we want the location the node was linked to,
-        // not where it actually lives on disk
-        path: node.path,
-        // but link nodes don't have edgesOut, so we need to pass in the target of the node
-        // in order to make sure we correctly traverse its dependencies
-        tree: node.target,
+        path,
         isPackage: true,
         ignoreFiles: [],
         seen: this.seen, // pass through seen so we can prevent infinite circular loops
@@ -430,7 +413,7 @@ class PackWalker extends IgnoreWalker {
       walkerOpts.ignoreFiles.push(strictRules)
 
       // create a walker for this dependency and gather its results
-      const walker = new PackWalker(walkerOpts)
+      const walker = new PackWalker(tree, walkerOpts)
       const bundled = await new Promise((pResolve, pReject) => {
         walker.on('error', pReject)
         walker.on('done', pResolve)
@@ -447,10 +430,14 @@ class PackWalker extends IgnoreWalker {
   }
 }
 
-const walk = (options, callback) => {
-  options = { ...options, isPackage: true }
+const walk = (tree, options, callback) => {
+  if (typeof options === 'function') {
+    callback = options
+    options = {}
+  }
   const p = new Promise((pResolve, pReject) => {
-    new PackWalker(options).on('done', pResolve).on('error', pReject).start()
+    new PackWalker(tree, { ...options, isPackage: true })
+      .on('done', pResolve).on('error', pReject).start()
   })
   return callback ? p.then(res => callback(null, res), callback) : p
 }

package/package.json

@@ -1,13 +1,12 @@
 {
   "name": "npm-packlist",
-  "version": "6.0.0",
+  "version": "7.0.0-pre.0",
   "description": "Get a list of the files to add from a folder into an npm package",
   "directories": {
     "test": "test"
   },
   "main": "lib/index.js",
   "dependencies": {
-    "@npmcli/arborist": "^5.0.4",
     "ignore-walk": "^5.0.1"
   },
   "author": "GitHub Inc.",
@@ -17,8 +16,9 @@
     "lib/"
   ],
   "devDependencies": {
+    "@npmcli/arborist": "^6.0.0 || ^6.0.0-pre.0",
     "@npmcli/eslint-config": "^3.0.1",
-    "@npmcli/template-oss": "4.3.2",
+    "@npmcli/template-oss": "4.4.2",
     "mutate-fs": "^2.1.1",
     "tap": "^16.0.1"
   },
@@ -45,16 +45,16 @@
     "nyc-arg": [
       "--exclude",
       "tap-snapshots/**"
+    ],
+    "files": [
+      "test/*.js"
     ]
   },
-  "bin": {
-    "npm-packlist": "bin/index.js"
-  },
   "engines": {
     "node": "^14.17.0 || ^16.13.0 || >=18.0.0"
   },
   "templateOSS": {
     "//@npmcli/template-oss": "This file is partially managed by @npmcli/template-oss. Edits may be overwritten.",
-    "version": "4.3.2"
+    "version": "4.4.2"
   }
 }

package/bin/index.js

@@ -1,39 +0,0 @@
-#!/usr/bin/env node
-'use strict'
-
-const packlist = require('../')
-
-const dirs = []
-let doSort = false
-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') {
-    doSort = true
-  } else {
-    dirs.push(arg)
-  }
-})
-
-const sort = list => doSort ? list.sort((a, b) => a.localeCompare(b, 'en')) : list
-
-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)
-})