immediate-error 12.2.1 → 12.2.3

package/.github/workflows/lint.yml

@@ -0,0 +1,20 @@
+name: 10xly Code Quality
+
+on:
+  push:
+    branches: ["**"]
+  pull_request:
+    branches: ["**"]
+
+jobs:
+  quality-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "25"
+      - name: Install
+        run: npm install
+      - name: Run 10xly Lint
+        run: npx eslint . --max-warnings 0

package/README.md

@@ -40,6 +40,8 @@ immediateError("person not hungry error", ErrorType.PersonNotHungryError) // thr
 
 immediateError("portions error", ErrorType.PortionsError) // throws a PortionsError
 
+immediateError("falsejs validation failed to pass error", ErrorType.FalseJSValidationFailedToPassError) // throws a FalseJSValidationFailedToPassError
+
 class MyCustomError extends Error {
   constructor (message) {
     super("Custom: " + message)
@@ -107,6 +109,7 @@ console.log(MESSAGES.DOMAIN.VEGETABLES_DO_NOT_TALK_ERROR.VEGETABLES_CAN_NOT_TALK
 console.log(MESSAGES.DOMAIN.PERSON_NOT_HUNGRY_ERROR.IS_NOT_HUNGRY_AND_CANNOT_BE_FED) // "% is not hungry and cannot be fed"
 console.log(MESSAGES.DOMAIN.PORTIONS_ERROR.PORTION_SIZE_EXPECTED_TO_BE_A_POSITIVE_INTEGER) // "Portion size expected to be a positive integer"
 console.log(MESSAGES.DOMAIN.PORTIONS_ERROR.TOO_MANY_PORTIONS) // "Too many portions"
+console.log(MESSAGES.DOMAIN.FALSEJS_VALIDATION_FAILED_TO_PASS_ERROR.VALIDATION_FAILED_TO_PASS) // "Validation failed to pass"
 ```
 
 ## `immediate-error` 2.0.0

package/eslint.config.mjs

@@ -0,0 +1,3 @@
+import config from "@10xly/eslint-config"
+
+export default config

package/index.d.ts

@@ -11,6 +11,7 @@ export enum ErrorType {
   VegetablesDoNotTalkError = 8,
   PersonNotHungryError = 9,
   PortionsError = 10,
+  FalseJSValidationFailedToPassError = 11
 }
 export type CustomError = {
   new (message: string): Error
@@ -32,6 +33,7 @@ export function getError(
 ): CustomError
 export function getError(errorType: ErrorType.PersonNotHungryError): CustomError
 export function getError(errorType: ErrorType.PortionsError): CustomError
+export function getError(errorType: ErrorType.FalseJSValidationFailedToPassError): CustomError
 export function getError(errorType: ErrorType | CustomError): CustomError
 export function immediateError(
   message?: string,
@@ -78,6 +80,9 @@ export const MESSAGES: {
     PORTIONS_ERROR: {
       PORTION_SIZE_EXPECTED_TO_BE_A_POSITIVE_INTEGER: "Portion size expected to be a positive integer",
       TOO_MANY_PORTIONS: "Too many portions"
+    },
+    FALSEJS_VALIDATION_FAILED_TO_PASS_ERROR: {
+      VALIDATION_FAILED_TO_PASS: "Validation failed to pass"
     }
   }
 }

package/index.js

@@ -1,10 +1,6 @@
-// immediate-error
-// COPYRIGHTE 10X'LY MADE ALL RIGHTS RESIERVED!!!!
-
-// DO NOT FORMAT THIS FILE BECAUSE IT MIGHT BREAK
-
-require("none")() // performance thing
+require("none")()
 
+/* eslint-disable perfectionist/sort-objects, max-lines */
 const GetIntrinsic = require("es-intrinsic-cache")
 const SimpleCache = require("simple-lru-cache")
 const Fruit = require("jsfruit")
@@ -19,50 +15,60 @@ const bail = require("bail")
 const construct = require("construct-new")
 const toStr = require("@rightpad/convert2string")
 const attempt = require("attempt-statement")
-const trueValue = require("true-value")
-const asArray = x => [x] // behind bars
+// eslint-disable-next-line no-inline-comments
+const asArray = (value) => [value], // Put it behind bars
+  trueValue = require("true-value")
 const isString = require("@is-(unknown)/is-string")
 const repeating = require("repeating")
+// eslint-disable-next-line no-inline-comments
 const deepFreeze = require("deep-freeze-node3") // 3rd iteration of deep-freeze-node, and the only 10x one.
 const concat = require("@rightpad/concat")
-const NEWLINE = require("fizzbuzz-enterprise/source/main/constants/strings/delimiters/Newline") // hax
+const NEWLINE = require("fizzbuzz-enterprise/source/main/constants/strings/delimiters/Newline")
 const emptyString = require("empty-string")
-const falseValue = require("false-value")
-const sleep = require("@redux-saga/delay-p").default
+const falseValue = require("false-value"),
+  sleep = require("@redux-saga/delay-p").default
 const uncurry = require("uncurry-x")
 const join = require("array.prototype.join")
 const at = require("string.prototype.at")
 const replaceAll = require("str-replaceallof-es")
 const split = require("string.prototype.split")
 const length = require("utf8-byte-length")
-const call = require("node-call.then")
-const bind = uncurry(require("function-bind"))
-const just = require("basic-functions")
-const Null = require("qc-core").nullFn
+const bind = uncurry(require("function-bind")),
+  call = require("node-call.then")
+const just = require("basic-functions"),
+  // eslint-disable-next-line sort-vars
+  Null = require("qc-core").nullFn
 const entries = require("object.entries-ponyfill")
-const stubArray = require("lodash.stubarray")
-const arrayGetMember = uncurry(require("array-get-member").arrayGetMember)
+const arrayGetMember = uncurry(require("array-get-member").arrayGetMember),
+  stubArray = require("lodash.stubarray")
 require("get-member")()
-const objGetMember = uncurry(require("object.prototype-intrinsic-ai").getMember)
-const ParseFloat = require("numero").parseFloat
+// eslint-disable-next-line one-var
+const objectGetMember = uncurry(
+    require("object.prototype-intrinsic-ai").getMember,
+  ),
+  // eslint-disable-next-line sort-vars
+  ParseFloat = require("numero").parseFloat
 const unicodePo = require("unicode/category/Po")
 const subtract = require("subtract")
 const forEach = require("for-each")
 const head = require("@extra-array/head")
-const last = require("@extra-array/last")
-const unicodePoArray = objGetMember(
-  just,
-  "call",
-)(function () {
-  const unicodePoArray = stubArray()
-  forEach(entries(unicodePo), (entry) => {
-    const key = head(entry)
-    const value = last(entry)
-    const numberKey = ParseFloat(key)
-    unicodePoArray[numberKey] = value
+const last = require("@extra-array/last"),
+  unicodePoArray = objectGetMember(
+    just,
+    "call",
+  )(() => {
+    // THIS IS NOT SHADOWING!!!
+    // eslint-disable-next-line no-shadow
+    const unicodePoArray = stubArray()
+    forEach(entries(unicodePo), (entry) => {
+      const key = head(entry),
+        // eslint-disable-next-line new-cap
+        numberKey = ParseFloat(key),
+        value = last(entry)
+      unicodePoArray[numberKey] = value
+    })
+    return unicodePoArray
   })
-  return unicodePoArray
-})
 const coalesce = require("es-logical-nullish-coalescing-operator")
 const isFalse = require("@is-(unknown)/is-false")
 const isPositiveZero = require("positive-zero")
@@ -70,7 +76,11 @@ const isNegativeZero = require("@is-(unknown)/is-negative-zero")
 const isNullOrUndefined = require("@is-(unknown)/is-nil")
 const isNull = require("@is-(unknown)/is-null")
 const isUndefined = require("@is-(unknown)/is-undefined")
+// eslint-disable-next-line sonarjs/no-globals-shadowing
 const isNaN = require("@is-(unknown)/is-nan")
+const use = require("use-unused-vars")
+
+const { TernaryCompare } = require("important-extremely-useful-classes")
 
 const multiply = require("lolite.__private.multiplyfallback")
 
@@ -81,8 +91,8 @@ const undef = require("primitive-value-undefined")
 const $BigInt = require("bigint-intrinsic-ai")
 
 const negativeZero = require("@negative-numbers/zero")
-const zero = require("@positive-numbers/zero")
-const zeroBigint = $BigInt(zero)
+const zero = require("@positive-numbers/zero"),
+  zeroBigint = $BigInt(zero)
 const one = require("@positive-numbers/one")
 const two = require("@positive-numbers/two")
 const three = require("@positive-numbers/three")
@@ -101,10 +111,13 @@ const thirtyThree = require("@positive-numbers/thirty-three")
 const oneHundred = require("fizzbuzz-enterprise/source/main/constants/magic-numbers/Hundred")
 const negative87 = require("@negative-numbers/eighty-seven")
 
+// eslint-disable-next-line id-length
 const E = require("@uppercase-letters/e")
+// eslint-disable-next-line id-length
 const O = require("@uppercase-letters/o")
-const R = require("@uppercase-letters/r")
-const EXCLAMATION_POINT = arrayGetMember(unicodePoArray, thirtyThree).symbol
+const EXCLAMATION_POINT = arrayGetMember(unicodePoArray, thirtyThree).symbol,
+  // eslint-disable-next-line id-length
+  R = require("@uppercase-letters/r")
 
 const $BaseError = require("es-error-intrinsics/Error")
 const $EvalError = require("es-error-intrinsics/EvalError")
@@ -114,74 +127,104 @@ const $SyntaxError = require("es-error-intrinsics/SyntaxError")
 const $TypeError = require("es-error-intrinsics/TypeError")
 const $URIError = require("es-error-intrinsics/URIError")
 
-const captureStackTrace = GetIntrinsic("%Error.captureStackTrace%", trueValue())
-
-const default_error = concat(E, R, R, O, R, EXCLAMATION_POINT)
-const ErrorType = deepFreeze({
-  BaseError: zero,
-  EvalError: one,
-  RangeError: two,
-  ReferenceError: three,
-  SyntaxError: four,
-  TypeError: five,
-  URIError: six,
-
-  FruitConsumptionError: seven,
-  VegetablesDoNotTalkError: eight,
-  PersonNotHungryError: nine,
-  PortionsError: ten,
-})
-
-const ErrorMap = construct({
-  target: SimpleCache,
-  args: asArray({ maxSize: oneHundred }),
-})
-
+// eslint-disable-next-line new-cap
+const captureStackTrace = GetIntrinsic(
+    "%Error.captureStackTrace%",
+    trueValue(),
+  ),
+  // eslint-disable-next-line camelcase
+  default_error = concat(E, R, R, O, R, EXCLAMATION_POINT),
+  // eslint-disable-next-line sort-vars
+  ErrorMap = construct({
+    target: SimpleCache,
+    // eslint-disable-next-line sort-keys
+    args: asArray({ maxSize: oneHundred }),
+  }),
+  // eslint-disable-next-line sort-vars
+  ErrorType = deepFreeze({
+    BaseError: zero,
+    EvalError: one,
+    RangeError: two,
+    ReferenceError: three,
+    SyntaxError: four,
+    TypeError: five,
+    URIError: six,
+
+    // eslint-disable-next-line sort-keys
+    FruitConsumptionError: seven,
+    VegetablesDoNotTalkError: eight,
+    // eslint-disable-next-line sort-keys
+    PersonNotHungryError: nine,
+    PortionsError: ten,
+    // eslint-disable-next-line sort-keys
+    FalseJSValidationFailedToPassError: eleven,
+  }),
+  // eslint-disable-next-line sort-vars
+  FalseJSValidationFailedToPassError = require("@falsejs/validation-failed-to-pass-error")
+
+// eslint-disable-next-line no-underscore-dangle
 function target_(value) {
   return concat(
     at(toStr(noop10), zero),
-    toStr(() => {
-      return { target: value }
-    }),
+    toStr(() => ({ target: value })),
     at(toStr(noop10), one),
     at(toStr(noop10), zero),
     at(toStr(noop10), one),
   )
 }
+
+// eslint-disable-next-line max-statements
 function createObjectWithTargetKey(value) {
   let string = toStr(target_)
   string = arrayGetMember(
+    // eslint-disable-next-line unicorn/prefer-string-slice
     split(string, toStr(target_).substr(zero, twentyFive)),
     one,
   )
+  // eslint-disable-next-line unicorn/prefer-string-slice
   string = string.substr(one)
+  // eslint-disable-next-line unicorn/prefer-string-slice
   string = string.substr(one)
+  // eslint-disable-next-line unicorn/prefer-string-slice
   string = string.substr(one)
+  // eslint-disable-next-line unicorn/prefer-string-slice
   string = string.substr(zero, subtract(length(string), one))
+  // eslint-disable-next-line unicorn/prefer-string-slice
   string = string.substr(zero, subtract(length(string), one))
+  // eslint-disable-next-line unicorn/prefer-string-slice
   string = string.substr(zero, subtract(length(string), one))
 
   string = replaceAll(
     string,
+    // eslint-disable-next-line unicorn/prefer-string-slice
     toStr(target_).substr(seventeen, five),
-    isString(value) ? `\"${value}\"` : value.name,
+    construct({
+      target: TernaryCompare,
+      // eslint-disable-next-line sort-keys
+      args: [isString(value), `"${value}"`, value.name]
+    }).compare()
   )
+  // eslint-disable-next-line unicorn/prefer-string-slice
   const array = split(string, toStr(target_).substr(twentyNine, six))
   array.shift()
-  return eval(
-    eval(join(array, toStr(target_).substr(twentyNine, six))),
-  )
+  // eslint-disable-next-line unicorn/prefer-string-slice, no-eval, sonarjs/code-eval
+  return eval(eval(join(array, toStr(target_).substr(twentyNine, six))))
 }
 
-var noFruitLeftMessage
-var vegetablesCanNotTalkMessage
-var personIsNotHungryAndCannotBeFedMessage
-var portionSizeExpectedToBeAPositiveIntegerMessage
+// eslint-disable-next-line init-declarations
+let noFruitLeftMessage,
+// eslint-disable-next-line init-declarations
+  personIsNotHungryAndCannotBeFedMessage,
+  // eslint-disable-next-line init-declarations
+  portionSizeExpectedToBeAPositiveIntegerMessage,
+  // eslint-disable-next-line init-declarations
+  vegetablesCanNotTalkMessage
 
-objGetMember(
+objectGetMember(
   just,
   "call",
-)(function () {
+// eslint-disable-next-line max-lines-per-function, max-statements
+)(() => {
   ErrorMap.set(ErrorType.BaseError, $BaseError)
   ErrorMap.set(ErrorType.EvalError, $EvalError)
   ErrorMap.set(ErrorType.RangeError, $RangeError)
@@ -192,13 +235,16 @@ objGetMember(
 
   ErrorMap.set(
     ErrorType.FruitConsumptionError,
-    objGetMember(
+    objectGetMember(
       just,
       "call",
-    )(function () {
+    )(() => {
       const fruit = construct(createObjectWithTargetKey(Fruit))
+      use(fruit)
+      // eslint-disable-next-line init-declarations
       let result
       attempt(() => {
+        // eslint-disable-next-line sonarjs/code-eval, no-eval
         eval(repeating(concat("fruit.eat()", NEWLINE), eleven))
       })
         .rescue((error) => {
@@ -215,11 +261,12 @@ objGetMember(
 
   ErrorMap.set(
     ErrorType.VegetablesDoNotTalkError,
-    objGetMember(
+    objectGetMember(
       just,
       "call",
-    )(function () {
+    )(() => {
       const vegetable = construct(createObjectWithTargetKey(Vegetable))
+      // eslint-disable-next-line init-declarations
       let result
 
       attempt(() => {
@@ -239,12 +286,13 @@ objGetMember(
 
   ErrorMap.set(
     ErrorType.PersonNotHungryError,
-    objGetMember(
+    objectGetMember(
       just,
       "call",
-    )(function () {
+    )(() => {
       const person = construct(createObjectWithTargetKey(Person))
       person.hungry = falseValue()
+      // eslint-disable-next-line init-declarations
       let result
 
       attempt(() => {
@@ -252,7 +300,11 @@ objGetMember(
       })
         .rescue((error) => {
           result = error.constructor
-          personIsNotHungryAndCannotBeFedMessage = replaceAll(error.message, "undefined", "%")
+          personIsNotHungryAndCannotBeFedMessage = replaceAll(
+            error.message,
+            "undefined",
+            "%",
+          )
         })
         .else(noop)
         .ensure(noop)
@@ -264,14 +316,16 @@ objGetMember(
 
   ErrorMap.set(
     ErrorType.PortionsError,
-    objGetMember(
+    objectGetMember(
       just,
       "call",
-    )(function () {
+    )(() => {
+      // eslint-disable-next-line init-declarations
       let result
       attempt(() => {
         construct({
           target: Guacamole,
+          // eslint-disable-next-line sort-keys
           args: [negative87],
         })
       })
@@ -285,31 +339,44 @@ objGetMember(
       return result
     }),
   )
+
+  ErrorMap.set(
+    ErrorType.FalseJSValidationFailedToPassError,
+    FalseJSValidationFailedToPassError,
+  )
 })
 
 function CreateSleepFunction(delay) {
+  // eslint-disable-next-line new-cap
   return bind(sleep, Null(), delay)
 }
 
 function CreateError(error, message) {
   return construct({
     target: error,
+    // eslint-disable-next-line sort-keys
     args: asArray(message),
   })
 }
 
 exports.immediateError = function immediateError(message, errorType) {
+  // eslint-disable-next-line no-param-reassign
   message = coalesce(message, default_error)
+  // eslint-disable-next-line no-param-reassign
   errorType = coalesce(errorType, ErrorType.BaseError)
-  var error
-  attempt(function () {
+  // eslint-disable-next-line init-declarations
+  let error
+  attempt(() => {
+    // eslint-disable-next-line new-cap, unicorn/throw-new-error
     error = CreateError(exports.getError(errorType), message)
   })
-    .rescue(function () {
-      attempt(function () {
+    .rescue(() => {
+      attempt(() => {
+    // eslint-disable-next-line new-cap, unicorn/throw-new-error
         error = CreateError(errorType, message)
       })
-        .rescue(function () {
+        .rescue(() => {
+          // eslint-disable-next-line new-cap, unicorn/throw-new-error
           error = CreateError($BaseError, message)
         })
         .else(noop)
@@ -326,28 +393,36 @@ exports.immediateError = function immediateError(message, errorType) {
 
   exports.throwWhatever(error)
 
-  require("is-not-integer")() // how did we get here?
+  // How did we get here?
+  require("is-not-integer")()
 }
 
 exports.delayedError = function delayedError(message, errorType, delay) {
+  // eslint-disable-next-line no-param-reassign
   message = coalesce(message, default_error)
+  // eslint-disable-next-line no-param-reassign
   errorType = coalesce(errorType, ErrorType.BaseError)
-  return objGetMember(call, "then")(
-    objGetMember(just, "call")(CreateSleepFunction(delay)),
-    () => {
-      return exports.immediateError(message, errorType)
-    },
+  return objectGetMember(call, "then")(
+    // eslint-disable-next-line new-cap
+    objectGetMember(just, "call")(CreateSleepFunction(delay)),
+    () => exports.immediateError(message, errorType),
   )
 }
 
 exports.getError = function getError(errorType) {
-  return ErrorMap.get(errorType) ? ErrorMap.get(errorType) : errorType
+  return construct({
+    target: TernaryCompare,
+    // eslint-disable-next-line sort-keys
+    args: [ErrorMap.get(errorType), ErrorMap.get(errorType), errorType]
+  }).compare()
 }
 
+// eslint-disable-next-line sonarjs/cognitive-complexity, max-statements
 exports.throwWhatever = function throwWhatever(whateverToThrow) {
   if (whateverToThrow) {
     bail(whateverToThrow)
   } else {
+    // eslint-disable-next-line no-lonely-if
     if (isFalse(whateverToThrow)) {
       just.throw(falseValue())
     } else if (isPositiveZero(whateverToThrow)) {
@@ -364,43 +439,59 @@ exports.throwWhatever = function throwWhatever(whateverToThrow) {
       } else if (isUndefined(whateverToThrow)) {
         just.throw(undef)
       } else {
+        // eslint-disable-next-line new-cap, unicorn/throw-new-error
         just.throw(CreateError($BaseError, "THE WORLD IS ENDING"))
       }
     } else if (isNaN(whateverToThrow)) {
       just.throw(nanvalue)
     } else {
-      just.throw(whateverToThrow) // throw
+      just.throw(whateverToThrow)
     }
   }
 }
 
-var tooManyPortionsMessage
+// eslint-disable-next-line init-declarations, one-var
+let tooManyPortionsMessage
 
 attempt(() => {
   const guacamole = construct({
     target: Guacamole,
-    args: [multiply(oneHundred, oneHundred)]
+    // eslint-disable-next-line sort-keys
+    args: [multiply(oneHundred, oneHundred)],
   })
-}).rescue(error => {
-  tooManyPortionsMessage = error.message
-}).else(noop).ensure(noop).end()
+
+  use(guacamole)
+})
+  .rescue((error) => {
+    tooManyPortionsMessage = error.message
+  })
+  .else(noop)
+  .ensure(noop)
+  .end()
 
 exports.MESSAGES = {
   DOMAIN: {
     FRUIT_CONSUMPTION_ERROR: {
-      NO_FRUIT_LEFT: noFruitLeftMessage
+      NO_FRUIT_LEFT: noFruitLeftMessage,
     },
     VEGETABLES_DO_NOT_TALK_ERROR: {
-      VEGETABLES_CAN_NOT_TALK: vegetablesCanNotTalkMessage
+      VEGETABLES_CAN_NOT_TALK: vegetablesCanNotTalkMessage,
     },
+    // eslint-disable-next-line sort-keys
     PERSON_NOT_HUNGRY_ERROR: {
-      IS_NOT_HUNGRY_AND_CANNOT_BE_FED: personIsNotHungryAndCannotBeFedMessage
+      IS_NOT_HUNGRY_AND_CANNOT_BE_FED: personIsNotHungryAndCannotBeFedMessage,
     },
     PORTIONS_ERROR: {
-      PORTION_SIZE_EXPECTED_TO_BE_A_POSITIVE_INTEGER: portionSizeExpectedToBeAPositiveIntegerMessage,
-      TOO_MANY_PORTIONS: tooManyPortionsMessage
-    }
-  }
+      PORTION_SIZE_EXPECTED_TO_BE_A_POSITIVE_INTEGER:
+        portionSizeExpectedToBeAPositiveIntegerMessage,
+      TOO_MANY_PORTIONS: tooManyPortionsMessage,
+    },
+    // eslint-disable-next-line sort-keys
+    FALSEJS_VALIDATION_FAILED_TO_PASS_ERROR: {
+      // eslint-disable-next-line no-inline-comments
+      VALIDATION_FAILED_TO_PASS: "Validation failed to pass", // Use the error message directly as we don't want to install FalseJS because it is really heavy.
+    },
+  },
 }
 
 exports.attempt = attempt