feat: make the required tree the first parameter

This also uses `tree.path` as the fallback instead of `process.cwd()`.
Arborist defaults to `cwd` as well so there is no functional difference.
This also refactors away some dead code now that tree is required.

BREAKING CHANGE: `tree` is now the first parameter

Author: lukekarrys

README.md

@@ -14,7 +14,7 @@ const packageTarball = '/path/to/package.tgz'
 
 const arborist = new Arborist({ path: packageDir })
 arborist.loadActual().then((tree) => {
-  packlist({ path: packageDir, tree })
+  packlist(tree)
     .then(files => tar.create({
       prefix: 'package/',
       cwd: packageDir,

lib/index.js

@@ -80,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
+    this.tree = tree
     this.requiredFiles = options.requiredFiles || []
 
     const additionalDefaults = []
@@ -206,16 +202,11 @@ class PackWalker extends IgnoreWalker {
   // 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, '/'))
 
@@ -229,6 +220,13 @@ class PackWalker extends IgnoreWalker {
           strictRules,
         ]
       }
+    } else {
+      ignoreFiles = [
+        defaultRules,
+        '.npmignore',
+        '.gitignore',
+        strictRules,
+      ]
     }
 
     return {
@@ -248,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
@@ -351,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
     }
 
@@ -380,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
@@ -413,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)
@@ -430,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.json

@@ -16,7 +16,7 @@
     "lib/"
   ],
   "devDependencies": {
-    "@npmcli/arborist": "^5.0.4 || ^6.0.0 || ^6.0.0-pre.0",
+    "@npmcli/arborist": "^6.0.0 || ^6.0.0-pre.0",
     "@npmcli/eslint-config": "^3.0.1",
     "@npmcli/template-oss": "4.4.2",
     "mutate-fs": "^2.1.1",

test/bundle-missing-dep.js

@@ -28,7 +28,7 @@ t.test('skips bundling deps with missing edges', async (t) => {
   const arborist = new Arborist({ path: pkg })
   const tree = await arborist.loadActual()
 
-  const files = await packlist({ path: pkg, tree })
+  const files = await packlist(tree)
   t.same(files, [
     'index.js',
     'package.json',

test/bundled-cycle.js

@@ -44,7 +44,7 @@ t.test('correctly bundles cyclic deps', async (t) => {
 
   const arborist = new Arborist({ path: pkg })
   const tree = await arborist.loadActual()
-  const files = await packlist({ path: pkg, tree })
+  const files = await packlist(tree)
   t.same(files, [
     'index.js',
     'node_modules/a/index.js',

test/bundled-file-in-workspace.js

@@ -32,7 +32,7 @@ t.test('correctly filters files from workspace subdirectory', async (t) => {
 
   const arborist = new Arborist({ path: pkg })
   const tree = await arborist.loadActual()
-  const files = await packlist({ path: pkg, tree })
+  const files = await packlist(tree)
   t.same(files, [
     'index.js',
     'package.json',
@@ -81,7 +81,7 @@ t.test('does not filter based on package.json if subdirectory is not a workspace
 
   const arborist = new Arborist({ path: pkg })
   const tree = await arborist.loadActual()
-  const files = await packlist({ path: pkg, tree })
+  const files = await packlist(tree)
   t.same(files, [
     'index.js',
     'package.json',

test/bundled-files.js

@@ -39,7 +39,7 @@ t.test('includes bundled dependency using bundleDependencies', async (t) => {
 
   const arborist = new Arborist({ path: pkg })
   const tree = await arborist.loadActual()
-  const files = await packlist({ path: pkg, tree })
+  const files = await packlist(tree)
   t.same(files, [
     'elf.js',
     'node_modules/history/index.js',
@@ -78,7 +78,7 @@ t.test('includes bundled dependency using bundledDependencies', async (t) => {
 
   const arborist = new Arborist({ path: pkg })
   const tree = await arborist.loadActual()
-  const files = await packlist({ path: pkg, tree })
+  const files = await packlist(tree)
   t.same(files, [
     'elf.js',
     'node_modules/history/index.js',

test/bundled-scoped-symlink.js

@@ -54,7 +54,7 @@ const pkg = t.testdir({
 t.test('includes bundled dependency', async (t) => {
   const arborist = new Arborist({ path: pkg })
   const tree = await arborist.loadActual()
-  const files = await packlist({ path: pkg, tree })
+  const files = await packlist(tree)
   t.same(files, [
     'elf.js',
     'node_modules/@npmwombat/history/index.js',

test/bundled-scoped.js

@@ -40,7 +40,7 @@ const pkg = t.testdir({
 t.test('includes bundled dependency', async (t) => {
   const arborist = new Arborist({ path: pkg })
   const tree = await arborist.loadActual()
-  const files = await packlist({ path: pkg, tree })
+  const files = await packlist(tree)
   t.same(files, [
     'elf.js',
     'node_modules/@npmwombat/history/index.js',

test/bundled-symlink.js

@@ -52,7 +52,7 @@ const pkg = t.testdir({
 t.test('includes bundled dependency', async (t) => {
   const arborist = new Arborist({ path: pkg })
   const tree = await arborist.loadActual()
-  const files = await packlist({ path: pkg, tree })
+  const files = await packlist(tree)
   t.same(files, [
     'elf.js',
     'node_modules/history/index.js',