Replace chalk with built-in styleText

Author: james-pre

README.md

@@ -59,7 +59,7 @@ provided directly.
 | option   | values                               | default   | description |
 | :---     | :---                                 | :---      |:--- |
 | reporter | `install`, `detail`, `json`, `quiet` | `install` | specify which output format you want to use |
-| chalk    | `Chalk` instance                     | required  | a Chalk instance to use for colorizing strings. use `new chalk.Instance({ level: 0 })` for no colors |
+| color    | `true`, `false`                      | `false`   | indicates if ANSI color escapes should be used to colorize the report |
 | unicode  | `true`, `false`                      | `true`    | indicates if unicode characters should be used|
 | indent   | Number or String                     | `2`       | indentation for `'json'` report|
 | auditLevel | 'info', 'low', 'moderate', 'high', 'critical', 'none' | `low` (ie, exit 0 if only `info` advisories are found) | level of vulnerability that will trigger a non-zero exit code (set to 'none' to always exit with a 0 status code) |

lib/colors.js

@@ -1,14 +1,21 @@
-module.exports = (chalk) => {
-  const green = s => chalk.green.bold(s)
-  const red = s => chalk.red.bold(s)
-  const magenta = s => chalk.magenta.bold(s)
-  const yellow = s => chalk.yellow.bold(s)
-  const white = s => chalk.bold(s)
+'use strict'
+
+const { styleText } = require('node:util')
+
+module.exports = (color) => {
+  // chalk coerced non-string input (eg numbers) to strings, but styleText
+  // throws on it, so coerce here to preserve the previous behavior
+  const style = (format, s) => color ? styleText(format, String(s), { validateStream: false }) : s
+  const green = s => style(['green', 'bold'], s)
+  const red = s => style(['red', 'bold'], s)
+  const magenta = s => style(['magenta', 'bold'], s)
+  const yellow = s => style(['yellow', 'bold'], s)
+  const white = s => style('bold', s)
   const severity = (sev, s) => sev.toLowerCase() === 'moderate' ? yellow(s || sev)
     : sev.toLowerCase() === 'high' ? red(s || sev)
     : sev.toLowerCase() === 'critical' ? magenta(s || sev)
     : white(s || sev)
-  const dim = s => chalk.dim(s)
+  const dim = s => style('dim', s)
 
   return {
     dim,

lib/index.js

@@ -12,7 +12,7 @@ const exitCode = require('./exit-code.js')
 module.exports = Object.assign((data, options = {}) => {
   const {
     reporter = 'install',
-    chalk,
+    color,
     unicode = true,
     indent = 2,
   } = options
@@ -35,7 +35,7 @@ module.exports = Object.assign((data, options = {}) => {
   }
 
   return {
-    report: reporters[reporter](data, { chalk, unicode, indent }),
+    report: reporters[reporter](data, { color, unicode, indent }),
     exitCode: exitCode(data, auditLevel),
   }
 }, { reporters })

lib/reporters/detail.js

@@ -3,14 +3,14 @@
 const colors = require('../colors.js')
 const install = require('./install.js')
 
-module.exports = (data, { chalk }) => {
-  const summary = install.summary(data, { chalk })
+module.exports = (data, { color }) => {
+  const summary = install.summary(data, { color })
   const none = data.metadata.vulnerabilities.total === 0
-  return none ? summary : fullReport(data, { chalk, summary })
+  return none ? summary : fullReport(data, { color, summary })
 }
 
-const fullReport = (data, { chalk, summary }) => {
-  const c = colors(chalk)
+const fullReport = (data, { color, summary }) => {
+  const c = colors(color)
   const output = [c.white('# npm audit report'), '']
 
   const printed = new Set()

lib/reporters/install.js

@@ -1,7 +1,7 @@
 const colors = require('../colors.js')
 
-const calculate = (data, { chalk }) => {
-  const c = colors(chalk)
+const calculate = (data, { color }) => {
+  const c = colors(color)
   const output = []
   const { metadata: { vulnerabilities } } = data
   const vulnCount = vulnerabilities.total

package.json

@@ -32,7 +32,6 @@
   "devDependencies": {
     "@npmcli/eslint-config": "^7.0.0",
     "@npmcli/template-oss": "5.1.1",
-    "chalk": "^5.2.0",
     "tap": "^16.0.0"
   },
   "directories": {

test/colors.js

@@ -1,12 +1,10 @@
 const t = require('tap')
-const chalk = require('./fixtures/chalk.js')
 const colors = require('../lib/colors.js')
 
 t.formatSnapshot = ({ report, exitCode }) => `${report}\nexitCode=${exitCode}`
 
 t.test('with colors', async t => {
-  const { color } = await chalk()
-  const c = colors(color)
+  const c = colors(true)
   t.not(c.green('x'), 'x')
   t.not(c.red('x'), 'x')
   t.not(c.magenta('x'), 'x')
@@ -24,8 +22,7 @@ t.test('with colors', async t => {
 })
 
 t.test('without colors', async t => {
-  const { noColor } = await chalk()
-  const c = colors(noColor)
+  const c = colors(false)
   t.equal(c.green('x'), 'x')
   t.equal(c.red('x'), 'x')
   t.equal(c.magenta('x'), 'x')

test/fixtures/chalk.js

@@ -2,7 +2,6 @@ const t = require('tap')
 const nar = require('../')
 nar.reporters.fake = (data, options) => ({ data, options })
 const fixture = require('./fixtures/index.js')
-const chalk = require('./fixtures/chalk.js')
 
 t.equal(nar.reporters.install, require('../lib/reporters/install.js'))
 t.equal(nar.reporters.detail, require('../lib/reporters/detail.js'))
@@ -25,7 +24,7 @@ t.strictSame(nar({ foo: 'bar', metadata }, fake), {
   report: {
     data: { foo: 'bar', metadata },
     options: {
-      chalk: undefined,
+      color: undefined,
       unicode: true,
       indent: 2,
     },
@@ -37,7 +36,7 @@ t.strictSame(nar({ foo: 'bar', toJSON: () => ({ bar: 'baz', metadata }) }, fake)
   report: {
     data: { bar: 'baz', metadata },
     options: {
-      chalk: undefined,
+      color: undefined,
       unicode: true,
       indent: 2,
     },
@@ -49,7 +48,7 @@ t.strictSame(nar({ foo: 'bar', auditLevel: null, metadata: highMeta }, fake), {
   report: {
     data: { foo: 'bar', auditLevel: null, metadata: highMeta },
     options: {
-      chalk: undefined,
+      color: undefined,
       unicode: true,
       indent: 2,
     },
@@ -58,9 +57,8 @@ t.strictSame(nar({ foo: 'bar', auditLevel: null, metadata: highMeta }, fake), {
 
 t.test('install is default reporter', async t => {
   const fix = fixture('one-vuln')
-  const { color } = await chalk()
-  t.strictSame(nar(fix, { chalk: color }).report, nar.reporters.install(fix, {
-    chalk: color,
+  t.strictSame(nar(fix, { color: true }).report, nar.reporters.install(fix, {
+    color: true,
     unicode: true,
     indent: 2,
   }))

test/index.js

@@ -1,16 +1,14 @@
 const t = require('tap')
 const fixture = require('../fixtures/index.js')
-const chalk = require('../fixtures/chalk')
 const Report = require('../..')
 
 t.formatSnapshot = ({ report, exitCode }) => `${report}\nexitCode=${exitCode}`
 
 for (const f of fixture.files) {
   t.test(f, async t => {
     const data = fixture(f)
-    const { color, noColor } = await chalk()
-    t.matchSnapshot(Report(data, { reporter: 'detail', chalk: color }), 'default settings')
-    t.matchSnapshot(Report(data, { reporter: 'detail', chalk: noColor }), 'no color')
+    t.matchSnapshot(Report(data, { reporter: 'detail', color: true }), 'default settings')
+    t.matchSnapshot(Report(data, { reporter: 'detail', color: false }), 'no color')
     t.end()
   })
 }