libnpmexec 1.1.0 → 2.0.1

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,6 +31,7 @@ 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 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**
@@ -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/index.js

@@ -16,6 +16,7 @@ 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 isWindows = require('./is-windows.js')
 
 /* istanbul ignore next */
 const PATH = (
@@ -34,7 +35,7 @@ const exec = async (opts) => {
     packages: _packages = [],
     path = '.',
     runPath = '.',
-    scriptShell = undefined,
+    scriptShell = isWindows ? process.env.ComSpec || 'cmd' : 'sh',
     yes = undefined,
     ...flatOptions
   } = opts
@@ -123,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,
@@ -143,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) {
@@ -164,6 +165,8 @@ const exec = async (opts) => {
           const prompt = `Need to install the following packages:\n${
           addList
         }Ok to proceed? `
+          if (typeof log.clearProgress === 'function')
+            log.clearProgress()
           const confirm = await read({ prompt, default: 'y' })
           if (confirm.trim().toLowerCase().charAt(0) !== 'y')
             throw new Error('canceled')

package/lib/is-windows.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "libnpmexec",
-  "version": "1.1.0",
+  "version": "2.0.1",
   "files": [
     "lib"
   ],

package/CHANGELOG.md

@@ -1,17 +0,0 @@
-# Changelog
-
-## v1.1.0
-
-- Add add walk up dir lookup logic to satisfy local bins,
-similar to `@npmcli/run-script`
-
-## v1.0.1
-
-- Fix `scriptShell` option name.
-
-## 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.
-