feat(testing): createThenable

Signed-off-by: Lexus Drumgold <unicornware@flexdevelopment.llc>

Author: unicornware

.attw.json

@@ -2,6 +2,10 @@
   "color": true,
   "emoji": true,
   "format": "ascii",
-  "ignoreRules": ["cjs-resolves-to-esm", "internal-resolution-error"],
+  "ignoreRules": [
+    "cjs-resolves-to-esm",
+    "internal-resolution-error",
+    "no-resolution"
+  ],
   "summary": true
 }

.commitlintrc.ts

@@ -15,7 +15,10 @@ import { scopes } from '@flex-development/commitlint-config'
 const config: UserConfig = {
   extends: ['@flex-development'],
   rules: {
-    'scope-enum': [RuleConfigSeverity.Error, 'always', scopes(['chore'])]
+    'scope-enum': [RuleConfigSeverity.Error, 'always', scopes([
+      'chore',
+      'testing'
+    ])]
   }
 }
 

README.md

@@ -597,7 +597,7 @@ Attach a callback only for the rejection of a [`Thenable`][thenable] (`type`).
 
 ```ts
 type Catch<T = unknown, Reason = any> = <Next = never>(
-  this: unknown,
+  this: any,
   onrejected?: OnRejected<Next, Reason> | null | undefined
 ) => Thenable<Next | T>
 ```
@@ -741,7 +741,7 @@ Attach a callback that is invoked only when a [`Thenable`][thenable] is settled
 
 ```ts
 type Finally<T = unknown> = (
-  this: unknown,
+  this: any,
   onfinally?: OnFinally | null | undefined
 ) => Thenable<T>
 ```
@@ -901,7 +901,7 @@ Attach callbacks for the resolution and/or rejection of a [`Thenable`][thenable]
 
 ```ts
 type Then<T = unknown, Reason = any> = <Succ = T, Fail = never>(
-  this: unknown,
+  this: any,
   onfulfilled?: OnFulfilled<T, Succ> | null | undefined,
   onrejected?: OnRejected<Fail, Reason> | null | undefined
 ) => Thenable<Fail | Succ>

__fixtures__/.gitkeep

@@ -0,0 +1,11 @@
+/**
+ * @file Fixtures - error
+ * @module fixtures/error
+ */
+
+/**
+ * A test error.
+ *
+ * @type {Error}
+ */
+export default new Error('boom!', { cause: { test: true } })

__fixtures__/boom.mts

@@ -0,0 +1,14 @@
+/**
+ * @file Fixtures - resolved
+ * @module fixtures/resolved
+ */
+
+import type ThenableType from '#tests/types/thenable-type'
+
+/**
+ * Record, where each key is a {@linkcode ThenableType}
+ * and each value is a resolved value.
+ *
+ * @type {Record<ThenableType, boolean>}
+ */
+export default { fail: false, succ: true }

__fixtures__/resolved.mts

@@ -0,0 +1,11 @@
+/**
+ * @file Type Aliases - ThenableType
+ * @module tests/types/ThenableType
+ */
+
+/**
+ * Union of thenable types.
+ */
+type ThenableType = 'fail' | 'succ'
+
+export type { ThenableType as default }

__tests__/types/thenable-type.mts

@@ -0,0 +1,21 @@
+/**
+ * @file Test Utilities - thrower
+ * @module tests/utils/thrower
+ */
+
+import error from '#fixtures/boom'
+
+/**
+ * Throw the test error.
+ *
+ * @this {void}
+ *
+ * @return {never}
+ *  Never; throws test error
+ * @throws {Error}
+ */
+function thrower(this: void): never {
+  throw error
+}
+
+export default thrower

__tests__/utils/thrower.mts

@@ -45,11 +45,24 @@ const config = [
     }
   },
   {
-    files: ['src/lib/when.mts'],
+    files: [
+      'src/lib/when.mts',
+      'src/testing/lib/__tests__/create-thenable.functional.spec.mts'
+    ],
     rules: {
       'promise/prefer-await-to-then': 0
     }
   },
+  {
+    files: ['src/testing/lib/create-thenable.mts'],
+    rules: {
+      '@typescript-eslint/only-throw-error': 0,
+      '@typescript-eslint/promise-function-async': 0,
+      'promise/prefer-await-to-then': 0,
+      'unicorn/catch-error-name': 0,
+      'unicorn/no-thenable': 0
+    }
+  },
   {
     files: ['src/types/chain.mts'],
     rules: {

eslint.config.mjs

@@ -55,7 +55,11 @@
       "when": "./src/index.mts",
       "default": "./dist/index.mjs"
     },
-    "./package.json": "./package.json"
+    "./package.json": "./package.json",
+    "./testing": {
+      "when": "./src/testing/index.mts",
+      "default": "./dist/testing/index.mjs"
+    }
   },
   "imports": {
     "#fixtures/*": "./__fixtures__/*.mts",
@@ -67,6 +71,10 @@
       "when": "./src/lib/*.mts",
       "default": "./dist/lib/*.mjs"
     },
+    "#testing/*": {
+      "when": "./src/testing/*.mts",
+      "default": "./dist/testing/*.mjs"
+    },
     "#tests/*": "./__tests__/*.mts",
     "#types/*": {
       "when": "./src/types/*.mts",
@@ -82,7 +90,7 @@
   },
   "scripts": {
     "build": "yarn clean:build && tsc -p tsconfig.build.json --noEmit false && yarn bundle:dts",
-    "bundle:dts": "rollup --config=rollup.config.mts && trash dist/{interfaces,types} && trash dist/{internal,lib}/*.d.mts",
+    "bundle:dts": "rollup --config=rollup.config.mts && trash dist/**/{interfaces,types} && trash dist/**/lib/*.d.mts",
     "check:ci": "yarn dedupe --check && yarn check:format && yarn check:lint && yarn check:spelling && yarn typecheck && yarn check:types && yarn test:cov && yarn pack && yarn check:types:build && attw package.tgz && yarn clean:pack",
     "check:format": "dprint check --incremental=false",
     "check:lint": "eslint --exit-on-fatal-error --max-warnings 0 .",
@@ -124,6 +132,7 @@
     "@commitlint/cli": "20.4.2",
     "@commitlint/types": "20.4.0",
     "@edge-runtime/vm": "5.0.0",
+    "@faker-js/faker": "10.3.0",
     "@flex-development/commitlint-config": "1.0.1",
     "@flex-development/eslint-config": "1.1.1",
     "@flex-development/grease": "3.0.0-alpha.9",