refactor(types)!: improve type implementations and tests

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

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

Author: unicornware

.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,9 +40,9 @@ branches:
           - context: test (18)
           - context: test (19)
           - context: test (20)
-          - context: typescript (5.1.0-beta)
+          - context: typescript (5.0.4)
+          - context: typescript (5.1.6)
           - context: typescript (latest)
-          - context: typescript (~4.9.0)
         strict: true
       restrictions: null
 # https://docs.github.com/rest/deployments/environments#create-or-update-an-environment

.github/workflows/ci.yml

@@ -236,7 +236,7 @@ jobs:
         typescript-version:
           - ${{ needs.preflight.outputs.version-typescript }}
           - latest
-          - ~4.9.0
+          - 5.0.4
     steps:
       - id: checkout
         name: Checkout ${{ env.REF_NAME }}
@@ -268,15 +268,10 @@ jobs:
         if: steps.test-files-check.outputs.files_exists == 'true'
         name: Install typescript@${{ matrix.typescript-version }}
         run: yarn add -D typescript@${{ matrix.typescript-version }}
-      - id: set-typescript-version
-        if: steps.test-files-check.outputs.files_exists == 'true'
-        name: Set env.TYPESCRIPT_VERSION
-        run: |
-          echo "TYPESCRIPT_VERSION=$(jq .devDependencies.typescript package.json -r)" >>$GITHUB_ENV
       - id: print-typescript-version
         if: steps.test-files-check.outputs.files_exists == 'true'
         name: Print TypeScript version
-        run: echo $TYPESCRIPT_VERSION
+        run: jq .devDependencies.typescript package.json -r
       - id: typecheck
         if: steps.test-files-check.outputs.files_exists == 'true'
         name: Run typecheck
@@ -352,6 +347,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 +371,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 }}

.github/workflows/typescript-canary.yml

@@ -21,7 +21,7 @@ name: typescript-canary
 on:
   schedule:
     # every day, 3 hours after typescript@next release
-    # https://github.com/microsoft/TypeScript/blob/v4.9.5/.github/workflows/nightly.yaml
+    # https://github.com/microsoft/TypeScript/blob/v5.0.4/.github/workflows/nightly.yaml
     - cron: 0 10 * * *
   workflow_dispatch:
 permissions:
@@ -65,13 +65,9 @@ jobs:
       - id: typescript
         name: Install typescript@${{ matrix.typescript-version }}
         run: yarn add -D typescript@${{ matrix.typescript-version }}
-      - id: set-typescript-version
-        name: Set env.TYPESCRIPT_VERSION
-        run: |
-          echo "TYPESCRIPT_VERSION=$(jq .devDependencies.typescript package.json -r)" >>$GITHUB_ENV
       - id: print-typescript-version
         name: Print TypeScript version
-        run: echo $TYPESCRIPT_VERSION
+        run: jq .devDependencies.typescript package.json -r
       - id: build
         name: Build project
         run: yarn build

.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__/ordered-pair.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 }