chore(ts): switch tsconfig based on typescript version

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

.github/workflows/ci.yml

@@ -216,12 +216,6 @@ jobs:
       - id: debug
         name: Print environment variables and event payload
         uses: hmarr/[email protected]
-      - id: tsconfig
-        name: Prepare tsconfig.json
-        if: matrix.typescript-version != needs.metadata.outputs.version-typescript
-        run: echo $(jq 'del(.compilerOptions.ignoreDeprecations)' $TSCONFIG) > $TSCONFIG
-        env:
-          TSCONFIG: tsconfig.json
       - id: typecheck
         name: Run typecheck
         run: yarn typecheck

.github/workflows/typescript-canary.yml

@@ -57,15 +57,13 @@ jobs:
       - id: typescript
         name: Install typescript@${{ matrix.typescript-version }}
         run: yarn add -D typescript@${{ matrix.typescript-version }}
-      - id: 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: jq .devDependencies.typescript package.json -r
-      - id: tsconfig
-        name: Prepare tsconfig.json
-        if: matrix.typescript-version != 'next'
-        run: echo $(jq 'del(.compilerOptions.ignoreDeprecations)' $TSCONFIG) > $TSCONFIG
-        env:
-          TSCONFIG: tsconfig.json
+        run: echo $TYPESCRIPT_VERSION
       - id: build
         name: Build project
         run: yarn build

config/ts/v4/tsconfig.build.json

@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "noEmitOnError": true,
+    "skipLibCheck": false,
+    "target": "es2020"
+  },
+  "exclude": ["**/__mocks__", "**/__tests__"],
+  "extends": "./tsconfig.json",
+  "include": ["../../../dist/*", "../../../src/*"]
+}

config/ts/v4/tsconfig.json

@@ -0,0 +1,53 @@
+{
+  "compilerOptions": {
+    "allowJs": true,
+    "allowUnreachableCode": false,
+    "alwaysStrict": false,
+    "baseUrl": "../../..",
+    "checkJs": false,
+    "declaration": true,
+    "declarationMap": true,
+    "emitDecoratorMetadata": true,
+    "esModuleInterop": true,
+    "exactOptionalPropertyTypes": true,
+    "experimentalDecorators": true,
+    "forceConsistentCasingInFileNames": true,
+    "importsNotUsedAsValues": "error",
+    "isolatedModules": true,
+    "lib": ["es2020"],
+    "module": "esnext",
+    "moduleDetection": "force",
+    "moduleResolution": "node",
+    "newLine": "lf",
+    "noEmit": true,
+    "noErrorTruncation": true,
+    "noFallthroughCasesInSwitch": true,
+    "noImplicitAny": true,
+    "noImplicitOverride": true,
+    "noImplicitReturns": true,
+    "noUncheckedIndexedAccess": true,
+    "noUnusedLocals": false,
+    "noUnusedParameters": false,
+    "outDir": "../../../dist",
+    "paths": {
+      "#src": ["src/index"],
+      "#src/*": ["src/*"],
+      "#tests/*": ["__tests__/*"]
+    },
+    "preserveConstEnums": true,
+    "preserveSymlinks": true,
+    "pretty": true,
+    "resolveJsonModule": true,
+    "rootDir": "../../..",
+    "skipLibCheck": true,
+    "sourceMap": true,
+    "strict": true,
+    "strictNullChecks": true,
+    "strictPropertyInitialization": true,
+    "target": "esnext",
+    "useDefineForClassFields": true,
+    "useUnknownInCatchVariables": true
+  },
+  "exclude": ["**/coverage", "**/dist", "**/node_modules"],
+  "include": ["**/**.cjs", "**/**.mjs", "**/**.ts", "**/.*.cjs"]
+}

config/ts/v4/tsconfig.typecheck.json

@@ -0,0 +1,6 @@
+{
+  "compilerOptions": {
+    "target": "es2020"
+  },
+  "extends": "./tsconfig.json"
+}

package.json

@@ -39,7 +39,7 @@
     "check:lint": "eslint --exit-on-fatal-error --ext cjs,gql,json,jsonc,md,mjs,ts,yml --max-warnings 0 .",
     "check:spelling": "cspell lint --color --no-progress --relative $@ \"**\"",
     "check:types": "tsc -p tsconfig.typecheck.json",
-    "check:types:build": "tsc -p tsconfig.build.json",
+    "check:types:build": "bash ./scripts/typecheck-build.sh",
     "check:upgrades": "yarn upgrade-interactive",
     "clean:build": "trash ./{dist,*.tgz}",
     "clean:modules": "trash ./.yarn/{cache,*.gz} ./node_modules",

scripts/typecheck-build.sh

@@ -0,0 +1,12 @@
+#!/bin/sh
+
+# Postbuild Typecheck Workflow
+
+# set initial tsconfig file
+TSCONFIG='tsconfig.build.json'
+
+# change tsconfig file if typescript version is not at least 5
+[[ ! $(jq .devDependencies.typescript package.json -r) = 5* ]] && TSCONFIG=config/ts/v4/$TSCONFIG
+
+# run typecheck
+tsc -p $TSCONFIG

tsconfig.build.json

@@ -4,7 +4,7 @@
     "skipLibCheck": false,
     "target": "es2020"
   },
-  "exclude": ["**/__mocks__/**", "**/__tests__/**"],
+  "exclude": ["**/__mocks__", "**/__tests__"],
   "extends": "./tsconfig.json",
-  "include": ["./dist", "./src"]
+  "include": ["./dist/*", "./src/*"]
 }

tsconfig.json

@@ -12,9 +12,6 @@
     "exactOptionalPropertyTypes": true,
     "experimentalDecorators": true,
     "forceConsistentCasingInFileNames": true,
-    "ignoreDeprecations": "5.0",
-    "importsNotUsedAsValues": "error",
-    "isolatedModules": true,
     "lib": ["es2020"],
     "module": "esnext",
     "moduleDetection": "force",
@@ -45,11 +42,11 @@
     "strict": true,
     "strictNullChecks": true,
     "strictPropertyInitialization": true,
-    "suppressImplicitAnyIndexErrors": true,
     "target": "esnext",
+    "verbatimModuleSyntax": true,
     "useDefineForClassFields": true,
     "useUnknownInCatchVariables": true
   },
-  "exclude": ["./coverage", "./dist", "./node_modules"],
+  "exclude": ["**/coverage", "**/dist", "**/node_modules"],
   "include": ["**/**.cjs", "**/**.mjs", "**/**.ts", "**/.*.cjs"]
 }

vitest-env.d.ts

@@ -10,6 +10,7 @@ interface ImportMetaEnv {
   readonly PWD: string
   readonly SSR: '1' | import('@flex-development/tutils').EmptyString
   readonly TEST: 'true'
+  readonly TYPESCRIPT_VERSION?: string
   readonly USER: string
   readonly VITEST: 'true'
   readonly VITEST_CLI_WRAPPER: 'true'

vitest.config.ts

@@ -30,6 +30,15 @@ const config: UserConfigExport = defineConfig((): UserConfig => {
    */
   const LINT_STAGED: boolean = !!Number.parseInt(process.env.LINT_STAGED ?? '0')
 
+  /**
+   * Boolean indicating if the currently running version of [`typescript`][1] is
+   * at least `5`.
+   *
+   * @const {boolean} TYPESCRIPT_V5
+   */
+  const TYPESCRIPT_V5: boolean =
+    process.env.TYPESCRIPT_VERSION?.startsWith('5') ?? true
+
   return {
     define: {
       'import.meta.env.NODE_ENV': JSON.stringify(NodeEnv.TEST)
@@ -117,7 +126,10 @@ const config: UserConfigExport = defineConfig((): UserConfig => {
         checker: 'tsc',
         ignoreSourceErrors: false,
         include: ['**/__tests__/*.spec-d.ts'],
-        tsconfig: path.resolve('tsconfig.typecheck.json')
+        tsconfig: path.resolve(
+          TYPESCRIPT_V5 ? '' : 'config/ts/v4/',
+          'tsconfig.typecheck.json'
+        )
       }
     }
   }