libnpmexec 1.0.1 → 2.0.0

package/README.md

@@ -17,7 +17,8 @@ The `npm exec` (`npx`) Programmatic API
 const libexec = require('libnpmexec')
 await libexec({
   args: ['yosay', 'Bom dia!'],
-  cache: '~/.npm',
+  cache: '~/.npm/_cacache',
+  npxCache: '~/.npm/_npx',
   yes: true,
 })
 ```
@@ -30,8 +31,9 @@ await libexec({
   - `args`: List of pkgs to execute **Array<String>**, defaults to `[]`
   - `call`: An alternative command to run when using `packages` option **String**, defaults to empty string.
   - `cache`: The path location to where the npm cache folder is placed **String**
+  - `npxCache`: The path location to where the npx cache folder is placed **String**
   - `color`: Output should use color? **Boolean**, defaults to `false`
-  - `localBin`: Location to the `node_modules/.bin` folder of the local project **String**, defaults to empty string.
+  - `localBin`: Location to the `node_modules/.bin` folder of the local project to start scanning for bin files **String**, defaults to `./node_modules/.bin`. **libexec** will walk up the directory structure looking for `node_modules/.bin` folders in parent folders that might satisfy the current `arg` and will use that bin if found.
   - `locationMsg`: Overrides "at location" message when entering interactive mode **String**
   - `log`: Sets an optional logger **Object**, defaults to `proc-log` module usage.
   - `globalBin`: Location to the global space bin folder, same as: `$(npm bin -g)` **String**, defaults to empty string.
@@ -39,7 +41,7 @@ await libexec({
   - `packages`: A list of packages to be used (possibly fetch from the registry) **Array<String>**, defaults to `[]`
   - `path`: Location to where to read local project info (`package.json`) **String**, defaults to `.`
   - `runPath`: Location to where to execute the script **String**, defaults to `.`
-  - `scriptShell`: Default shell to be used **String**
+  - `scriptShell`: Default shell to be used **String**, defaults to `sh` on POSIX systems, `process.env.ComSpec` OR `cmd` on Windows
   - `yes`: Should skip download confirmation prompt when fetching missing packages from the registry? **Boolean**
   - `registry`, `cache`, and more options that are forwarded to [@npmcli/arborist](https://github.com/npm/arborist/) and [pacote](https://github.com/npm/pacote/#options) **Object**
 

package/lib/cache-install-dir.js

@@ -2,17 +2,17 @@ const crypto = require('crypto')
 
 const { resolve } = require('path')
 
-const cacheInstallDir = ({ cache, packages }) => {
-  if (!cache)
-    throw new Error('Must provide a valid cache path')
+const cacheInstallDir = ({ npxCache, packages }) => {
+  if (!npxCache)
+    throw new Error('Must provide a valid npxCache path')
 
   // only packages not found in ${prefix}/node_modules
-  return resolve(cache, '_npx', getHash(packages))
+  return resolve(npxCache, getHash(packages))
 }
 
 const getHash = (packages) =>
   crypto.createHash('sha512')
-    .update(packages.sort((a, b) => a.localeCompare(b)).join('\n'))
+    .update(packages.sort((a, b) => a.localeCompare(b, 'en')).join('\n'))
     .digest('hex')
     .slice(0, 16)
 

package/lib/file-exists.js

@@ -0,0 +1,29 @@
+const { resolve } = require('path')
+const { promisify } = require('util')
+const stat = promisify(require('fs').stat)
+const walkUp = require('walk-up-path')
+
+const fileExists = (file) => stat(file)
+  .then((stat) => stat.isFile())
+  .catch(() => false)
+
+const localFileExists = async (dir, binName, root = '/') => {
+  root = resolve(root).toLowerCase()
+
+  for (const path of walkUp(resolve(dir))) {
+    const binDir = resolve(path, 'node_modules', '.bin')
+
+    if (await fileExists(resolve(binDir, binName)))
+      return binDir
+
+    if (path.toLowerCase() === root)
+      return false
+  }
+
+  return false
+}
+
+module.exports = {
+  fileExists,
+  localFileExists,
+}

package/lib/index.js

@@ -1,7 +1,6 @@
-const { delimiter, resolve } = require('path')
+const { delimiter, dirname, resolve } = require('path')
 const { promisify } = require('util')
 const read = promisify(require('read'))
-const stat = promisify(require('fs').stat)
 
 const Arborist = require('@npmcli/arborist')
 const ciDetect = require('@npmcli/ci-detect')
@@ -12,14 +11,12 @@ const pacote = require('pacote')
 const readPackageJson = require('read-package-json-fast')
 
 const cacheInstallDir = require('./cache-install-dir.js')
+const { fileExists, localFileExists } = require('./file-exists.js')
 const getBinFromManifest = require('./get-bin-from-manifest.js')
 const manifestMissing = require('./manifest-missing.js')
 const noTTY = require('./no-tty.js')
 const runScript = require('./run-script.js')
-
-const fileExists = (file) => stat(file)
-  .then((stat) => stat.isFile())
-  .catch(() => false)
+const isWindows = require('./is-windows.js')
 
 /* istanbul ignore next */
 const PATH = (
@@ -31,14 +28,14 @@ const exec = async (opts) => {
     args = [],
     call = '',
     color = false,
-    localBin = '',
+    localBin = resolve('./node_modules/.bin'),
     locationMsg = undefined,
     globalBin = '',
     output,
     packages: _packages = [],
     path = '.',
     runPath = '.',
-    scriptShell = undefined,
+    scriptShell = isWindows ? process.env.ComSpec || 'cmd' : 'sh',
     yes = undefined,
     ...flatOptions
   } = opts
@@ -72,8 +69,10 @@ const exec = async (opts) => {
   // the behavior of treating the single argument as a package name
   if (needPackageCommandSwap) {
     let binExists = false
-    if (await fileExists(`${localBin}/${args[0]}`)) {
-      pathArr.unshift(localBin)
+    const dir = dirname(dirname(localBin))
+    const localBinPath = await localFileExists(dir, args[0])
+    if (localBinPath) {
+      pathArr.unshift(localBinPath)
       binExists = true
     } else if (await fileExists(`${globalBin}/${args[0]}`)) {
       pathArr.unshift(globalBin)
@@ -125,8 +124,8 @@ const exec = async (opts) => {
     manis.some(manifest => manifestMissing({ tree, manifest }))
 
   if (needInstall) {
-    const { cache } = flatOptions
-    const installDir = cacheInstallDir({ cache, packages })
+    const { npxCache } = flatOptions
+    const installDir = cacheInstallDir({ npxCache, packages })
     await mkdirp(installDir)
     const arb = new Arborist({
       ...flatOptions,
@@ -145,7 +144,7 @@ const exec = async (opts) => {
       },
     }))
       .map(mani => mani._from)
-      .sort((a, b) => a.localeCompare(b))
+      .sort((a, b) => a.localeCompare(b, 'en'))
 
     // no need to install if already present
     if (add.length) {

package/lib/is-windows.js

@@ -0,0 +1 @@
+module.exports = process.platform === 'win32'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "libnpmexec",
-  "version": "1.0.1",
+  "version": "2.0.0",
   "files": [
     "lib"
   ],
@@ -46,7 +46,7 @@
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^5.1.0",
     "eslint-plugin-standard": "^5.0.0",
-    "tap": "^15.0.2"
+    "tap": "^15.0.6"
   },
   "dependencies": {
     "@npmcli/arborist": "^2.3.0",
@@ -58,6 +58,7 @@
     "pacote": "^11.3.1",
     "proc-log": "^1.0.0",
     "read": "^1.0.7",
-    "read-package-json-fast": "^2.0.2"
+    "read-package-json-fast": "^2.0.2",
+    "walk-up-path": "^1.0.0"
   }
 }

package/CHANGELOG.md

@@ -1,8 +0,0 @@
-# Changelog
-
-## v1.0.0
-
-- Initial implementation, moves the code that used to live in the **npm cli**,
-ref: https://github.com/npm/cli/blob/release/v7.10.0/lib/exec.js into this
-separate module, providing a programmatic API to the **npm exec** functionality.
-