Allow exit codes from 125 to 255

Author: ehmicky

README.md

@@ -92,7 +92,12 @@ _Default_: `1`
 
 Process [exit code](https://en.wikipedia.org/wiki/Exit_status).
 
-Note: when passing invalid [`options`](#options), the exit code is always `125`.
+We recommend values between 1 and 124 because the following exit codes have some
+special meaning:
+
+- 0: success
+- 125: invalid [`options`](#options)
+- 126 to 255: used by shells like Bash
 
 #### 📕 stack
 

src/exit.js

@@ -25,10 +25,8 @@ export const exitProcess = (exitCode, timeout) => {
   })
 }
 
-// Minimum exit code
 const MIN_EXIT_CODE = 0
-// 126-255 have special meaning in Bash.
-const MAX_EXIT_CODE = 124
+export const MAX_EXIT_CODE = 255
 // 125 is reserved for invalid options with `handle-cli-error` itself.
 export const INVALID_OPTS_EXIT_CODE = 125
 // `options.exitCode` default value

src/exit.test.js

@@ -1,7 +1,12 @@
 import test from 'ava'
+import { each } from 'test-each'
 
 // eslint-disable-next-line no-restricted-imports
-import { DEFAULT_EXIT_CODE } from './exit.js'
+import {
+  DEFAULT_EXIT_CODE,
+  INVALID_OPTS_EXIT_CODE,
+  MAX_EXIT_CODE,
+} from './exit.js'
 import { handleError } from './helpers/main.test.js'
 
 test.serial('Default exit code', (t) => {
@@ -10,11 +15,15 @@ test.serial('Default exit code', (t) => {
   t.is(exitCodeAfter, DEFAULT_EXIT_CODE)
 })
 
-test.serial('Custom exit code', (t) => {
-  const customExitCode = 2
-  const { exitCode, exitCodeAfter } = handleError('', {
-    exitCode: customExitCode,
-  })
-  t.is(exitCode, customExitCode)
-  t.is(exitCodeAfter, customExitCode)
-})
+each(
+  [0, 2, INVALID_OPTS_EXIT_CODE, MAX_EXIT_CODE],
+  ({ title }, customExitCode) => {
+    test.serial(`Custom exit code | ${title}`, (t) => {
+      const { exitCode, exitCodeAfter } = handleError('', {
+        exitCode: customExitCode,
+      })
+      t.is(exitCode, customExitCode)
+      t.is(exitCodeAfter, customExitCode)
+    })
+  },
+)

src/main.d.ts

@@ -12,7 +12,12 @@ export type Options = BeautifulErrorOptions & {
   /**
    * Process [exit code](https://en.wikipedia.org/wiki/Exit_status).
    *
-   * Note: when passing invalid `options`, the exit code is always `125`.
+   * We recommend values between 1 and 124 because the following exit codes have
+   * some special meaning:
+   *
+   * - 0: success
+   * - 125: invalid [`options`](#options)
+   * - 126 to 255: used by shells like Bash
    *
    * @default 1
    */

src/options/validate.test.js

@@ -22,8 +22,7 @@ each(
     { exitCode: Number.POSITIVE_INFINITY },
     { exitCode: Number.NEGATIVE_INFINITY },
     { exitCode: -1 },
-    { exitCode: 125 },
-    { exitCode: 126 },
+    { exitCode: 256 },
     { timeout: '0' },
     { timeout: 0.1 },
     { timeout: Number.NaN },