Change exitCode default value

Author: ehmicky

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 - [`modern-errors@5`](https://github.com/ehmicky/modern-errors/releases/tag/5.0.0)
   is now required
+- The default value for the [`exitCode` option](README.md#-exitcode) is now `1`
 
 # 1.4.0
 

README.md

@@ -95,12 +95,12 @@ _Type_: `object`
 
 ### 🚨 exitCode
 
-_Type_: `integer`
+_Type_: `integer`\
+_Default_: `1`
 
 Process [exit code](https://en.wikipedia.org/wiki/Exit_status).
 
-By default, each error class has its own exit code: `1` for the first one
-declared, `2` for the next one, and so on.
+Note: when passing invalid `options`, the exit code is always `125`.
 
 ### 📕 stack
 

src/main.js

@@ -10,21 +10,9 @@ const getOptions = function (options = {}) {
   return options
 }
 
-// The default value of `exitCode` is 1 for the first declared class, then
-// incrementing from there.
-//  - If some of the classes define their `exitCode`, it does not change the
-//    default `exitCode` of others
 // Stack traces and error properties are displayed by default.
-const exit = function ({
-  ErrorClasses,
-  error,
-  options: {
-    stack = true,
-    exitCode = Object.keys(ErrorClasses).indexOf(error.name) + 1,
-    ...options
-  },
-}) {
-  handleCliError(error, { ...options, stack, exitCode })
+const exit = function ({ error, options: { stack = true, ...options } }) {
+  handleCliError(error, { ...options, stack })
 }
 
 export default {

test/main.js

@@ -1,21 +1,18 @@
 import test from 'ava'
-import modernErrors from 'modern-errors'
+import ModernError from 'modern-errors'
 import modernErrorsCli from 'modern-errors-cli'
 import { each } from 'test-each'
 
 import { errorExit } from './helpers/main.js'
 
-const globalOpts = { cli: { timeout: 0 } }
 const exitCode = 5
 const message = 'test'
 
-const BaseError = modernErrors([modernErrorsCli], globalOpts)
-const UnknownError = BaseError.subclass('UnknownError')
-const OneError = BaseError.subclass('OneError')
-const TwoError = BaseError.subclass('TwoError', { cli: { exitCode } })
-const ThreeError = BaseError.subclass('ThreeError')
-
-const error = new OneError(message)
+const BaseError = ModernError.subclass('BaseError', {
+  plugins: [modernErrorsCli],
+  cli: { timeout: 0 },
+})
+const error = new BaseError(message)
 
 each(
   [true, { timeout: 'true' }, { unknown: true }, { classes: {} }],
@@ -30,16 +27,19 @@ test.serial('Call process.exit()', (t) => {
   t.true(Number.isInteger(errorExit(error).exitCode))
 })
 
-test.serial('Can pass "exitCode"', (t) => {
+test.serial('Can pass "exitCode" as instance option', (t) => {
   t.is(errorExit(error, { exitCode }).exitCode, exitCode)
 })
 
-test.serial('"exitCode" defaults to incrementing number', (t) => {
-  t.is(errorExit(new UnknownError('')).exitCode, 1)
-  t.is(errorExit(new OneError('')).exitCode, 2)
-  t.is(errorExit(new TwoError('')).exitCode, exitCode)
-  // eslint-disable-next-line no-magic-numbers
-  t.is(errorExit(new ThreeError('')).exitCode, 4)
+test.serial('Can pass "exitCode" as class option', (t) => {
+  const ExitCodeError = BaseError.subclass('ExitCodeError', {
+    cli: { exitCode },
+  })
+  t.is(errorExit(new ExitCodeError('')).exitCode, exitCode)
+})
+
+test.serial('"exitCode" defaults to 1', (t) => {
+  t.is(errorExit(new BaseError('')).exitCode, 1)
 })
 
 test.serial('Can pass "stack"', (t) => {