feat!: require passing in chalk instance

BREAKING CHANGES: libnpmexec no longer accepts a color
property and instead requires passing in a chalk instance.
To replicate the old behavior of `color: false` use
`chalk: new Chalk({ level: 0 })`.

Author: lukekarrys

workspaces/libnpmexec/README.md

@@ -31,7 +31,7 @@ await libexec({
   - `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`
+  - `chalk`: Chalk instance to use for colors? **Required**
   - `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**
   - `globalBin`: Location to the global space bin folder, same as: `$(npm bin -g)` **String**, defaults to empty string.

workspaces/libnpmexec/lib/run-script.js

@@ -1,17 +1,10 @@
-const chalk = require('chalk')
 const ciInfo = require('ci-info')
 const runScript = require('@npmcli/run-script')
 const readPackageJson = require('read-package-json-fast')
 const npmlog = require('npmlog')
 const log = require('proc-log')
 const noTTY = require('./no-tty.js')
 
-const nocolor = {
-  reset: s => s,
-  bold: s => s,
-  dim: s => s,
-}
-
 const run = async ({
   args,
   call,
@@ -25,8 +18,6 @@ const run = async ({
 }) => {
   // turn list of args into command string
   const script = call || args.shift() || scriptShell
-  const color = !!flatOptions.color
-  const colorize = color ? chalk : nocolor
 
   // do the fakey runScript dance
   // still should work if no package.json in cwd
@@ -49,14 +40,14 @@ const run = async ({
           return log.warn('exec', 'Interactive mode disabled in CI environment')
         }
 
-        locationMsg = locationMsg || ` at location:\n${colorize.dim(runPath)}`
+        locationMsg = locationMsg || ` at location:\n${flatOptions.chalk.dim(runPath)}`
 
         output(`${
-          colorize.reset('\nEntering npm script environment')
+          flatOptions.chalk.reset('\nEntering npm script environment')
         }${
-          colorize.reset(locationMsg)
+          flatOptions.chalk.reset(locationMsg)
         }${
-          colorize.bold('\nType \'exit\' or ^D when finished\n')
+          flatOptions.chalk.bold('\nType \'exit\' or ^D when finished\n')
         }`)
       }
     }

workspaces/libnpmexec/package.json

@@ -42,7 +42,6 @@
     "template-oss-apply": "template-oss-apply --force"
   },
   "tap": {
-    "color": true,
     "files": "test/*.js",
     "nyc-arg": [
       "--exclude",
@@ -54,6 +53,7 @@
     "@npmcli/mock-registry": "^1.0.0",
     "@npmcli/template-oss": "4.14.1",
     "bin-links": "^4.0.1",
+    "chalk": "^5.2.0",
     "just-extend": "^6.2.0",
     "just-safe-set": "^4.2.1",
     "minify-registry-metadata": "^3.0.0",
@@ -62,7 +62,6 @@
   "dependencies": {
     "@npmcli/arborist": "^6.2.9",
     "@npmcli/run-script": "^6.0.0",
-    "chalk": "^4.1.0",
     "ci-info": "^3.7.1",
     "npm-package-arg": "^10.1.0",
     "npmlog": "^7.0.1",

workspaces/libnpmexec/test/run-script.js

@@ -1,26 +1,30 @@
 const t = require('tap')
 
-const baseOpts = {
-  args: [],
-  call: '',
-  color: false,
-  flatOptions: {},
-  path: '',
-  runPath: '',
-  shell: process.platform === 'win32'
-    ? process.env.ComSpec || 'cmd'
-    : process.env.SHELL || 'sh',
+const mockRunScript = async (t, mocks, { level = 0 } = {}) => {
+  const runScript = t.mock('../lib/run-script.js', mocks)
+  const { Chalk } = await import('chalk')
+  return (opts) => runScript({
+    args: [],
+    call: '',
+    path: '',
+    runPath: '',
+    shell: process.platform === 'win32'
+      ? process.env.ComSpec || 'cmd'
+      : process.env.SHELL || 'sh',
+    ...opts,
+    flatOptions: { chalk: new Chalk({ level }) },
+  })
 }
 
-t.test('disable, enable log progress', t => {
+t.test('disable, enable log progress', async t => {
   t.plan(3)
 
   const path = t.testdir({
     'package.json': JSON.stringify({
       name: 'pkg',
     }),
   })
-  const runScript = t.mock('../lib/run-script.js', {
+  const runScript = await mockRunScript(t, {
     'ci-info': { isCI: false },
     '@npmcli/run-script': async () => {
       t.ok('should call run-script')
@@ -36,53 +40,53 @@ t.test('disable, enable log progress', t => {
     },
   })
 
-  runScript({
-    ...baseOpts,
-    path,
-  })
+  await runScript({ path })
 })
 
-t.test('no package.json', t => {
+t.test('no package.json', async t => {
   t.plan(1)
 
-  const runScript = t.mock('../lib/run-script.js', {
+  const path = t.testdir({
+    'package.json': JSON.stringify({
+      name: 'pkg',
+    }),
+  })
+  const runScript = await mockRunScript(t, {
     'ci-info': { isCI: false },
     '@npmcli/run-script': async () => {
       t.ok('should call run-script')
     },
     '../lib/no-tty.js': () => false,
   })
 
-  runScript(baseOpts)
+  await runScript({ path })
 })
 
 t.test('colorized interactive mode msg', async t => {
   t.plan(2)
 
-  const runScript = t.mock('../lib/run-script.js', {
+  const runScript = await mockRunScript(t, {
     'ci-info': { isCI: false },
     '@npmcli/run-script': async () => {
       t.ok('should call run-script')
     },
     '../lib/no-tty.js': () => false,
-  })
+  }, { level: 3 })
 
   const OUTPUT = []
   await runScript({
-    ...baseOpts,
     output: msg => {
       OUTPUT.push(msg)
     },
     runPath: '/foo/',
-    flatOptions: { color: true },
   })
   t.matchSnapshot(OUTPUT.join('\n'), 'should print colorized output')
 })
 
 t.test('no color interactive mode msg', async t => {
   t.plan(2)
 
-  const runScript = t.mock('../lib/run-script.js', {
+  const runScript = await mockRunScript(t, {
     'ci-info': { isCI: false },
     '@npmcli/run-script': async () => {
       t.ok('should call run-script')
@@ -92,7 +96,6 @@ t.test('no color interactive mode msg', async t => {
 
   const OUTPUT = []
   await runScript({
-    ...baseOpts,
     output: msg => {
       OUTPUT.push(msg)
     },
@@ -101,24 +104,24 @@ t.test('no color interactive mode msg', async t => {
   t.matchSnapshot(OUTPUT.join('\n'), 'should print non-colorized output')
 })
 
-t.test('no tty', t => {
+t.test('no tty', async t => {
   t.plan(1)
 
-  const runScript = t.mock('../lib/run-script.js', {
+  const runScript = await mockRunScript(t, {
     'ci-info': { isCI: false },
     '@npmcli/run-script': async () => {
       t.ok('should call run-script')
     },
     '../lib/no-tty.js': () => true,
   })
 
-  runScript(baseOpts)
+  await runScript()
 })
 
-t.test('ci env', t => {
+t.test('ci env', async t => {
   t.plan(2)
 
-  const runScript = t.mock('../lib/run-script.js', {
+  const runScript = await mockRunScript(t, {
     'ci-info': { isCI: true },
     '@npmcli/run-script': async () => {
       throw new Error('should not call run-script')
@@ -136,5 +139,5 @@ t.test('ci env', t => {
     },
   })
 
-  runScript({ ...baseOpts })
+  await runScript()
 })