refactor(types): improve type implementations and tests

- dropped EnsureString, Keys, MergeDefaults, OmitNative, Omit, PickNative, Pick
- MergeDefaults functionality was merged into Merge
- TupleLength -> Length
- TupleToUnion -> ArrayToUnion
- Omit and Pick were improved, but still under review
- added several new types

Signed-off-by: Lexus Drumgold <[email protected]>

.attw.json

@@ -0,0 +1,7 @@
+{
+  "color": true,
+  "emoji": true,
+  "format": "ascii",
+  "ignoreRules": [],
+  "summary": true
+}

.codecov.yml

@@ -89,6 +89,6 @@ ignore:
   - '**/__mocks__/**'
   - '**/__tests__/**'
   - '**/index.ts'
-  - src/interfaces/
-  - src/types/
+  - '**/interfaces'
+  - '**/types'
   - src/utils/*.options.ts

.dictionary.txt

@@ -1,4 +1,6 @@
+abcdefghijklmnopqrstuvwyz
 ardatan
+attw
 bdougie
 booleanish
 cefc
@@ -31,6 +33,9 @@ promisable
 stringafiable
 tryit
 tscu
+uncapitalize
 unstub
 vates
+vitest
 yarnrc
+zyxwvutsrqponmlkjihgfedcba

.eslintrc.base.cjs

@@ -1166,7 +1166,9 @@ const config = {
       implementsReplacesDocs: true,
       overrideReplacesDocs: true,
       preferredTypes: {
-        '*': false
+        '*': false,
+        '.<>': false,
+        'Array<>': { replacement: '[]' }
       },
       structuredTags: {
         const: {

.eslintrc.cjs

@@ -13,35 +13,19 @@ const config = {
   overrides: [
     ...require('./.eslintrc.base.cjs').overrides,
     {
-      files: [
-        'src/types/built-in.ts',
-        'src/types/fn.ts',
-        'src/types/simplify.ts'
-      ],
-      rules: {
-        '@typescript-eslint/ban-types': 0
-      }
-    },
-    {
-      files: ['src/types/built-in.ts'],
+      files: ['src/interfaces/map-like.ts'],
       rules: {
-        '@typescript-eslint/array-type': 0
+        '@typescript-eslint/consistent-indexed-object-style': 0
       }
     },
     {
       files: [
-        'src/types/head.ts',
-        'src/types/is-tuple.ts',
-        'src/types/tail.ts'
+        'src/types/built-in.ts',
+        'src/types/fn.ts',
+        'src/types/is-index-signature.ts'
       ],
       rules: {
-        '@typescript-eslint/no-unused-vars': 0
-      }
-    },
-    {
-      files: ['src/interfaces/map-like.ts'],
-      rules: {
-        '@typescript-eslint/consistent-indexed-object-style': 0
+        '@typescript-eslint/ban-types': 0
       }
     }
   ],

.github/dependabot.yml

@@ -30,6 +30,8 @@ updates:
       prefix: build
       include: scope
     directory: /
+    ignore:
+      - dependency-name: vitest
     labels:
       - scope:dependencies
       - type:build

.github/infrastructure.yml

@@ -40,7 +40,7 @@ branches:
           - context: test (18)
           - context: test (19)
           - context: test (20)
-          - context: typescript (5.1.0-beta)
+          - context: typescript (5.1.6)
           - context: typescript (latest)
           - context: typescript (~4.9.0)
         strict: true

.github/workflows/ci.yml

@@ -352,6 +352,10 @@ jobs:
       - gitguardian
       - preflight
     runs-on: ubuntu-latest
+    env:
+      TARFILE: |
+        (startsWith(github.ref_name, 'release/') && ${{ format('@{0}-{1}-{2}.tgz', github.repository_owner, github.event.repository.name, needs.preflight.outputs.version) }})
+        || ${{ format('@{0}-{1}-{2}+{3}.tgz', github.repository_owner, github.event.repository.name, needs.preflight.outputs.version, github.event.pull_request.head.sha || github.sha) }}
     steps:
       - id: checkout
         name: Checkout ${{ env.REF_NAME }}
@@ -372,19 +376,24 @@ jobs:
         with:
           key: ${{ runner.os }}-${{ github.run_id }}
           path: ${{ env.CACHE_PATH }}
+      - id: local-binaries
+        name: Add local binaries to $PATH
+        run: echo "$GITHUB_WORKSPACE/$CACHE_PATH/.bin" >> $GITHUB_PATH
       - id: pack
         name: Pack project
-        run: yarn pack -o %s-%v.tgz
+        run: yarn pack -o ${{ env.TARFILE }}
       - id: typecheck
         name: Run typecheck
         run: yarn check:types:build
+      - id: attw
+        name: Analyze types distribution
+        run: attw ${{ env.TARFILE }}
       - id: pkg-size-report
         name: Package size report
         run: yarn pkg-size
       - id: archive
         name: Archive production artifacts
         uses: actions/[email protected]
         with:
-          name: |
-            ${{ format('@{0}-{1}-{2}', github.repository_owner, github.event.repository.name, needs.preflight.outputs.version) }}
-          path: '*.tgz'
+          name: ${{ env.TARFILE }}
+          path: ${{ env.TARFILE }}

.vscode/settings.json

@@ -256,6 +256,7 @@
   "shellformat.flag": "-ci -fn -i=2 -sr",
   "shellformat.useEditorConfig": true,
   "terminal.integrated.copyOnSelection": true,
+  "terminal.integrated.scrollback": 10000,
   "todo-tree.filtering.ignoreGitSubmodules": true,
   "todo-tree.filtering.includeHiddenFiles": false,
   "todo-tree.filtering.useBuiltInExcludes": "file and search excludes",

__fixtures__/book.interface.ts

@@ -3,6 +3,7 @@
  * @module tests/fixtures/Book
  */
 
+import type { Nullable, Simplify } from '#src/types'
 import type Author from './author.interface'
 import type Publisher from './publisher.interface'
 
@@ -23,7 +24,7 @@ interface Book {
   /**
    * Book publisher.
    */
-  publisher?: Publisher
+  publisher?: Nullable<Simplify<Publisher>>
 
   /**
    * Book readers.

__fixtures__/vehicle.ts

@@ -0,0 +1,31 @@
+/**
+ * @file Test Fixtures - Vehicle
+ * @module tests/fixtures/Vehicle
+ */
+
+/**
+ * Object representing a vehicle.
+ */
+type Vehicle = {
+  /**
+   * Vehicle brand.
+   */
+  make: string
+
+  /**
+   * Vehicle model.
+   */
+  model: string
+
+  /**
+   * Vehicle identification number.
+   */
+  vin: string
+
+  /**
+   * Vehicle model year.
+   */
+  year: number
+}
+
+export type { Vehicle as default }

__tests__/reporters/notifier.ts

@@ -20,22 +20,28 @@ import type { File, Reporter, Task, Test, Vitest } from 'vitest'
  */
 class Notifier implements Reporter {
   /**
+   * Test reporter context.
+   *
    * @public
-   * @member {Vitest} ctx - Test reporter context
+   * @member {Vitest} ctx
    */
-  public ctx: Vitest = {} as Vitest
+  public ctx!: Vitest
 
   /**
+   * Test run end time (in milliseconds).
+   *
    * @public
-   * @member {number} end - Test run end time (in milliseconds)
+   * @member {number} end
    */
-  public end: number = 0
+  public end!: number
 
   /**
+   * Test run start time (in milliseconds).
+   *
    * @public
-   * @member {number} start - Test run start time (in milliseconds)
+   * @member {number} start
    */
-  public start: number = 0
+  public start!: number
 
   /**
    * Sends a notification.
@@ -52,19 +58,39 @@ class Notifier implements Reporter {
     files: File[] = this.ctx.state.getFiles(),
     errors: unknown[] = this.ctx.state.getUnhandledErrors()
   ): Promise<void> {
-    /** @const {Test[]} tests - Tests run */
+    /**
+     * Tests that have been run.
+     *
+     * @const {Test[]} tests
+     */
     const tests: Test[] = this.tests(files)
 
-    /** @const {number} fails - Total number of failed tests */
+    /**
+     * Total number of failed tests.
+     *
+     * @const {number} fails
+     */
     const fails: number = tests.filter(t => t.result?.state === 'fail').length
 
-    /** @const {number} passes - Total number of passed tests */
+    /**
+     * Total number of passed tests.
+     *
+     * @const {number} passes
+     */
     const passes: number = tests.filter(t => t.result?.state === 'pass').length
 
-    /** @var {string} message - Notification message */
+    /**
+     * Notification message.
+     *
+     * @var {string} message
+     */
     let message: string = ''
 
-    /** @var {string} title - Notification title */
+    /**
+     * Notification title.
+     *
+     * @var {string} title
+     */
     let title: string = ''
 
     // get notification title and message based on number of failed tests
@@ -76,7 +102,11 @@ class Notifier implements Reporter {
 
       title = '\u274C Failed'
     } else {
-      /** @const {number} time - Time to run all tests (in milliseconds) */
+      /**
+       * Time to run all tests (in milliseconds).
+       *
+       * @const {number} time
+       */
       const time: number = this.end - this.start
 
       message = dedent`
@@ -128,7 +158,7 @@ class Notifier implements Reporter {
    */
   public onInit(context: Vitest): void {
     this.ctx = context
-    return void (this.start = performance.now())
+    return void ((this.start = performance.now()) && (this.end = 0))
   }
 
   /**
@@ -140,17 +170,13 @@ class Notifier implements Reporter {
    * @return {Test[]} `Test` object array
    */
   protected tests(tasks: OneOrMany<Task> = []): Test[] {
-    const { mode } = this.ctx
-
     return (isArray<Task>(tasks) ? tasks : [tasks]).flatMap(task => {
-      const { type } = task
-
-      return mode === 'typecheck' && type === 'suite' && task.tasks.length === 0
-        ? ([task] as unknown as [Test])
-        : type === 'test'
+      return task.type === 'custom'
+        ? [task as unknown as Test]
+        : task.type === 'test'
         ? [task]
         : 'tasks' in task
-        ? task.tasks.flatMap(t => (t.type === 'test' ? [t] : this.tests(t)))
+        ? task.tasks.flatMap(task => this.tests(task))
         : []
     })
   }