feat!: remove synchronous interface (#80)

BREAKING CHANGE: this module no longer supports synchronous usage

Author: nlf

bin/index.js

@@ -1,4 +1,5 @@
 #!/usr/bin/env node
+const packlist = require('../')
 
 const dirs = []
 let doSort = false
@@ -15,12 +16,22 @@ process.argv.slice(2).forEach(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)
+})

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')
@@ -418,26 +416,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) => {
@@ -452,16 +430,6 @@ 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
@@ -477,6 +445,4 @@ const sort = (a, b) => {
 }
 
 module.exports = walk
-walk.sync = walkSync
 walk.Walker = Walker
-walk.WalkerSync = WalkerSync

map.js

@@ -0,0 +1 @@
+module.exports = () => ['bin/index.js', 'lib/index.js']

package.json

@@ -46,11 +46,6 @@
   "tap": {
     "test-env": [
       "LC_ALL=sk"
-    ],
-    "check-coverage": true,
-    "nyc-arg": [
-      "--include=index.js",
-      "--include=bin/index.js"
     ]
   },
   "bin": {
@@ -59,6 +54,9 @@
   "engines": {
     "node": "^12.13.0 || ^14.15.0 || >=16.0.0"
   },
+  "tap": {
+    "coverage-map": "map.js"
+  },
   "templateOSS": {
     "//@npmcli/template-oss": "This file is partially managed by @npmcli/template-oss. Edits may be overwritten.",
     "version": "3.2.0"

tap-snapshots/test/bin.js.test.cjs

@@ -59,14 +59,14 @@ Object {
   "stderr": "",
   "stdout": String(
     > .
-    lib/cat.js
-    lib/chai.js
-    lib/dog.js
-    index.js
-    lib/index.js
-    package.json
-    README.md
-    LICENSE.txt
+      lib/cat.js
+      lib/chai.js
+      lib/dog.js
+      index.js
+      lib/index.js
+      package.json
+      README.md
+      LICENSE.txt
     
   ),
 }

tap-snapshots/test/bundled-files.js.test.cjs

@@ -14,15 +14,6 @@ Array [
 ]
 `
 
-exports[`test/bundled-files.js TAP includes bundled dependency using bundleDependencies sync > must match snapshot 1`] = `
-Array [
-  "elf.js",
-  "node_modules/history/index.js",
-  "node_modules/history/package.json",
-  "package.json",
-]
-`
-
 exports[`test/bundled-files.js TAP includes bundled dependency using bundledDependencies async > must match snapshot 1`] = `
 Array [
   "elf.js",
@@ -31,12 +22,3 @@ Array [
   "package.json",
 ]
 `
-
-exports[`test/bundled-files.js TAP includes bundled dependency using bundledDependencies sync > must match snapshot 1`] = `
-Array [
-  "elf.js",
-  "node_modules/history/index.js",
-  "node_modules/history/package.json",
-  "package.json",
-]
-`

tap-snapshots/test/bundled-scoped-symlink.js.test.cjs

@@ -13,12 +13,3 @@ Array [
   "package.json",
 ]
 `
-
-exports[`test/bundled-scoped-symlink.js TAP includes bundled dependency sync > must match snapshot 1`] = `
-Array [
-  "elf.js",
-  "node_modules/@npmwombat/history/index.js",
-  "node_modules/@npmwombat/history/package.json",
-  "package.json",
-]
-`

tap-snapshots/test/bundled-scoped.js.test.cjs

@@ -13,12 +13,3 @@ Array [
   "package.json",
 ]
 `
-
-exports[`test/bundled-scoped.js TAP includes bundled dependency sync > must match snapshot 1`] = `
-Array [
-  "elf.js",
-  "node_modules/@npmwombat/history/index.js",
-  "node_modules/@npmwombat/history/package.json",
-  "package.json",
-]
-`

tap-snapshots/test/bundled-symlink.js.test.cjs

@@ -13,12 +13,3 @@ Array [
   "package.json",
 ]
 `
-
-exports[`test/bundled-symlink.js TAP includes bundled dependency sync > must match snapshot 1`] = `
-Array [
-  "elf.js",
-  "node_modules/history/index.js",
-  "node_modules/history/package.json",
-  "package.json",
-]
-`

tap-snapshots/test/bundled.js.test.cjs

@@ -14,15 +14,6 @@ Array [
 ]
 `
 
-exports[`test/bundled.js TAP includes bundled dependency using bundleDependencies sync > must match snapshot 1`] = `
-Array [
-  "elf.js",
-  "node_modules/history/index.js",
-  "node_modules/history/package.json",
-  "package.json",
-]
-`
-
 exports[`test/bundled.js TAP includes bundled dependency using bundledDependencies async > must match snapshot 1`] = `
 Array [
   "elf.js",
@@ -31,12 +22,3 @@ Array [
   "package.json",
 ]
 `
-
-exports[`test/bundled.js TAP includes bundled dependency using bundledDependencies sync > must match snapshot 1`] = `
-Array [
-  "elf.js",
-  "node_modules/history/index.js",
-  "node_modules/history/package.json",
-  "package.json",
-]
-`