Add option log

Author: ehmicky

src/main.js

@@ -11,25 +11,24 @@ const handleCliError = (error, opts) => {
   const errorA = normalizeException(error)
   const {
     error: errorB,
-    opts: { silent, exitCode, timeout },
+    opts: { silent, exitCode, timeout, log },
     beautifulErrorOpts,
   } = getOpts(errorA, opts)
 
-  printError(errorB, silent, beautifulErrorOpts)
+  printError({ error: errorB, silent, log, beautifulErrorOpts })
   exitProcess(exitCode, timeout)
 }
 
 // We pass the `error` instance to `console.error()`, so it prints not only its
 // `message` and `stack` but also its properties, `cause`, aggregate `errors`,
 // add colors, inline preview, etc. using `util.inspect()`
-const printError = (error, silent, beautifulErrorOpts) => {
+const printError = ({ error, silent, log, beautifulErrorOpts }) => {
   if (silent) {
     return
   }
 
   const errorString = beautifulError(error, beautifulErrorOpts)
-  // eslint-disable-next-line no-restricted-globals, no-console
-  console.error(errorString)
+  log(errorString)
 }
 
 export default handleCliError

src/main.test.js

@@ -1,6 +1,7 @@
 import test from 'ava'
 import figures from 'figures'
 import { validateOptions } from 'handle-cli-error'
+import { spy } from 'sinon'
 import { each } from 'test-each'
 
 import { handleError } from './helpers/main.test.js'
@@ -39,3 +40,12 @@ test.serial('Does not log if "silent" is true', (t) => {
   const { consoleArg } = handleError(error, { silent: true })
   t.is(consoleArg, undefined)
 })
+
+test.serial('Can pass custom log function', (t) => {
+  const error = new TypeError('test')
+  const log = spy()
+  handleError(error, { log })
+  t.true(log.calledOnce)
+  t.is(log.args.length, 1)
+  t.true(log.firstCall.args[0].includes('TypeError: test'))
+})

src/options/default.js

@@ -14,6 +14,11 @@ export const DEFAULT_OPTS = {
   silent: false,
   exitCode: DEFAULT_EXIT_CODE,
   timeout: DEFAULT_TIMEOUT,
+  // Do not pass `console.error` directly, to allow monkey-patching
+  log(message) {
+    // eslint-disable-next-line no-console, no-restricted-globals
+    console.error(message)
+  },
 }
 
 // Remove `undefined` values of an object

src/options/validate.js

@@ -22,11 +22,9 @@ export const validateOptions = (opts = {}) => {
 }
 
 export const normalizeOptions = (name, opts) => {
-  const { silent, exitCode, timeout, ...beautifulErrorOpts } = applyClassesOpts(
-    name,
-    opts,
-  )
-  const optsA = { silent, exitCode, timeout }
+  const { silent, exitCode, timeout, log, ...beautifulErrorOpts } =
+    applyClassesOpts(name, opts)
+  const optsA = { silent, exitCode, timeout, log }
   Object.entries(optsA).forEach(validateOpt)
   validateBeautifulOptions(beautifulErrorOpts)
   return { opts: optsA, beautifulErrorOpts }
@@ -44,8 +42,15 @@ const validateBooleanOpt = (value, optName) => {
   }
 }
 
+const validateFunction = (value, optName) => {
+  if (typeof value !== 'function') {
+    throw new TypeError(`"${optName}" must be a function: ${value}`)
+  }
+}
+
 const VALIDATORS = {
   silent: validateBooleanOpt,
   exitCode: validateExitCode,
   timeout: validateTimeout,
+  log: validateFunction,
 }