chore: migrate to ts project reference, new eslint config, and swc compiler

Author: tinesoft

.github/workflows/smoke-tests.yml

@@ -14,6 +14,7 @@ jobs:
       NX_CLOUD_ACCESS_TOKEN: ${{ secrets.NX_CLOUD_ACCESS_TOKEN }}
       npm_config_registry: http://localhost:4873
       YARN_REGISTRY: http://localhost:4873
+      NODE_OPTIONS: '--max-old-space-size=32768'
     timeout-minutes: 60
     strategy:
       matrix:

.gitignore

@@ -1,14 +1,12 @@
 # See http://help.github.com/ignore-files/ for more about ignoring files.
 
 # compiled output
-/dist
+dist
 tmp
-/out-tsc
-/bin
+out-tsc
 
 # dependencies
-/node_modules
-.pnpm-store
+node_modules
 
 # IDEs and editors
 /.idea

bun.lockb

@@ -3,6 +3,12 @@
   "files": [],
   "include": [],
   "references": [
+    {
+      "path": "../../packages/common"
+    },
+    {
+      "path": "../../packages/common-cli"
+    },
     {
       "path": "./tsconfig.spec.json"
     }

e2e/nx-flutter-e2e/tsconfig.json

@@ -3,6 +3,12 @@
   "files": [],
   "include": [],
   "references": [
+    {
+      "path": "../../packages/common-jvm"
+    },
+    {
+      "path": "../../packages/common-cli"
+    },
     {
       "path": "./tsconfig.spec.json"
     }

e2e/nx-ktor-e2e/tsconfig.json

@@ -3,6 +3,9 @@
   "files": [],
   "include": [],
   "references": [
+    {
+      "path": "../../packages/common"
+    },
     {
       "path": "./tsconfig.spec.json"
     }

e2e/nx-melos-e2e/tsconfig.json

@@ -3,6 +3,12 @@
   "files": [],
   "include": [],
   "references": [
+    {
+      "path": "../../packages/common-jvm"
+    },
+    {
+      "path": "../../packages/common-cli"
+    },
     {
       "path": "./tsconfig.spec.json"
     }

e2e/nx-micronaut-e2e/tsconfig.json

@@ -3,6 +3,12 @@
   "files": [],
   "include": [],
   "references": [
+    {
+      "path": "../../packages/common-jvm"
+    },
+    {
+      "path": "../../packages/common-cli"
+    },
     {
       "path": "./tsconfig.spec.json"
     }

e2e/nx-quarkus-e2e/tsconfig.json

@@ -3,6 +3,12 @@
   "files": [],
   "include": [],
   "references": [
+    {
+      "path": "../../packages/common-jvm"
+    },
+    {
+      "path": "../../packages/common-cli"
+    },
     {
       "path": "./tsconfig.spec.json"
     }

e2e/nx-spring-boot-e2e/tsconfig.json

@@ -3,6 +3,9 @@
   "files": [],
   "include": [],
   "references": [
+    {
+      "path": "../../packages/common"
+    },
     {
       "path": "./tsconfig.spec.json"
     }

e2e/smoke/tsconfig.json

@@ -15,7 +15,6 @@
       "preVersionCommand": "bunx nx run-many -t build",
       "conventionalCommits": true,
       "generatorOptions": {
-        "packageRoot": "dist/packages/{projectName}",
         "updateDependents": "auto"
       }
     }
@@ -36,6 +35,7 @@
   "$schema": "./node_modules/nx/schemas/nx-schema.json",
   "targetDefaults": {
     "test": {
+      "dependsOn": ["^build"],
       "options": {
         "passWithNoTests": true,
         "detectOpenHandles": true,
@@ -48,6 +48,9 @@
         }
       }
     },
+    "test-ci--**/**": {
+      "dependsOn": ["^build"]
+    },
     "e2e": {
       "inputs": ["e2eInputs", "^production"],
       "options": {
@@ -70,34 +73,33 @@
       "parallelism": false,
       "dependsOn": ["nxrocks:populate-local-registry"]
     },
-    "nx-release-publish": {
-      "options": {
-        "packageRoot": "dist/packages/{projectName}"
-      }
-    },
-    "@nx/js:tsc": {
+    "@nx/js:swc": {
       "cache": true,
       "dependsOn": ["^build"],
       "inputs": ["production", "^production"]
-    },
-    "@nx/eslint:lint": {
-      "cache": true,
-      "inputs": [
-        "default",
-        "{workspaceRoot}/.eslintrc.json",
-        "{workspaceRoot}/.eslintignore",
-        "{workspaceRoot}/eslint.config.js"
-      ]
     }
   },
   "nxCloudAccessToken": "ZDRmZDczZWUtMDU2My00YzQ0LTlkMWEtZjM2YjZlZWNmNGIxfHJlYWQ=",
   "parallel": 1,
   "plugins": [
+    {
+      "plugin": "@nx/js/typescript",
+      "options": {
+        "typecheck": {
+          "targetName": "typecheck"
+        },
+        "build": {
+          "targetName": "build",
+          "configName": "tsconfig.lib.json",
+          "buildDepsName": "build-deps",
+          "watchDepsName": "watch-deps"
+        }
+      }
+    },
     {
       "plugin": "@nx/eslint/plugin",
       "options": {
-        "targetName": "lint",
-        "extensions": ["ts", "tsx", "js", "jsx", "html", "vue"]
+        "targetName": "lint"
       }
     },
     {
@@ -147,7 +149,7 @@
     "production": [
       "default",
       "!{projectRoot}/.eslintrc.json",
-      "!{projectRoot}/eslint.config.js",
+      "!{projectRoot}/eslint.config.mjs",
       "!{projectRoot}/**/?(*.)+(spec|test).[jt]s?(x)?(.snap)",
       "!{projectRoot}/tsconfig.spec.json",
       "!{projectRoot}/jest.config.[jt]s",
@@ -183,6 +185,5 @@
   "defaultBase": "develop",
   "cli": {
     "packageManager": "bun"
-  },
-  "useLegacyCache": false
+  }
 }

nx.json

@@ -21,20 +21,19 @@
     "run-migrate": "nx migrate --run-migrations --if-exists",
     "graph": "nx graph",
     "help": "nx help",
-    "release": "nx release --dry-run -- --skip-nx-cache",
+    "release": "nx release --dry-run --verbose",
     "prepare": "husky",
     "smoke": "FORCE_SMOKE_TESTS=true nx e2e smoke",
     "smoke-keep": "KEEP_SMOKE_TESTS_DIR=true bun smoke",
     "sync-preset-schemas": "ts-node -P ./tools/tsconfig.tools.json ./tools/scripts/sync-preset-schemas.ts",
-    "nuke": "rm -rf tmp/ dist/ ~/.bun/install/cache && find ./e2e -type d -name \"tmp\" -exec rm -rf {} + && nx reset && git gc",
+    "nuke": "rm -rf tmp/ dist/ ~/.bun/install/cache && find ./e2e -type d -name \"tmp\" -exec rm -rf {} + && find ./packages -type d -name \"dist\" -exec rm -rf {} + && find ./packages -type d -name \"out-tsc\" -exec rm -rf {} + && nx reset",
     "run-local-registry": "ts-node -P ./tools/tsconfig.tools.json ./tools/scripts/run-local-registry.ts",
     "start-local-registry": "ts-node -P ./tools/tsconfig.tools.json -e \"(async () => { try { const m = await import('./tools/scripts/start-local-registry'); await m.default(); process.exit(0); } catch (err) { console.error(err); process.exit(1); } })()\"",
     "stop-local-registry": "ts-node -P ./tools/tsconfig.tools.json -e \"import('./tools/scripts/stop-local-registry').then(m => m.default()).catch(console.error)\""
   },
   "private": true,
   "dependencies": {
     "@clack/prompts": "^0.10.0",
-    "@swc/helpers": "0.5.11",
     "@nx/devkit": "20.6.2",
     "create-nx-workspace": "20.6.2",
     "enquirer": "^2.4.1",
@@ -43,7 +42,6 @@
     "minimatch": "^9.0.3",
     "node-fetch": "^2.6.12",
     "terminal-link": "^2.1.1",
-    "tslib": "^2.6.1",
     "unzipper": "^0.12.3",
     "xmlbuilder2": "^3.1.1",
     "xpath": "^0.0.34",
@@ -54,15 +52,18 @@
     "@commitlint/cli": "^19.3.0",
     "@commitlint/config-angular": "^19.3.0",
     "@jest/globals": "29.7.0",
+    "@nx/eslint": "20.6.2",
     "@nx/eslint-plugin": "20.6.2",
     "@nx/jest": "20.6.2",
     "@nx/js": "20.6.2",
     "@nx/node": "20.6.2",
     "@nx/plugin": "20.6.2",
     "@nx/workspace": "20.6.2",
-    "@swc-node/register": "1.9.1",
-    "@swc/cli": "0.3.12",
-    "@swc/core": "1.5.7",
+    "@swc-node/register": "~1.9.1",
+    "@swc/cli": "~0.3.12",
+    "@swc/core": "~1.5.7",
+    "@swc/helpers": "~0.5.11",
+    "@swc/jest": "~0.2.36",
     "@types/fs-extra": "^9.0.13",
     "@types/jest": "29.5.12",
     "@types/node": "18.16.9",
@@ -71,8 +72,6 @@
     "@types/unzipper": "^0.10.5",
     "@types/xmldoc": "^1.1.6",
     "@types/yargs": "^17.0.26",
-    "@typescript-eslint/eslint-plugin": "^7.3.0",
-    "@typescript-eslint/parser": "^7.3.0",
     "eslint": "^9.8.0",
     "eslint-config-prettier": "^9.0.0",
     "fs-extra": "^10.1.0",
@@ -81,7 +80,6 @@
     "jest-environment-jsdom": "29.7.0",
     "jest-environment-node": "^29.7.0",
     "jsonc-eslint-parser": "^2.1.0",
-    "jest-mock": "29.7.0",
     "lint-staged": "^15.2.7",
     "nx": "20.6.2",
     "prettier": "2.6.2",
@@ -98,6 +96,10 @@
   "nx": {
     "includedScripts": []
   },
+  "workspaces": [
+    "packages/**",
+    "e2e/**"
+  ],
   "patchedDependencies": {
     "@nx/[email protected]": "patches/@nx%[email protected]"
   }

package.json

@@ -0,0 +1,22 @@
+{
+  "jsc": {
+    "target": "es2017",
+    "parser": {
+      "syntax": "typescript",
+      "decorators": true,
+      "dynamicImport": true
+    },
+    "transform": {
+      "decoratorMetadata": true,
+      "legacyDecorator": true
+    },
+    "keepClassNames": true,
+    "externalHelpers": true,
+    "loose": true
+  },
+  "module": {
+    "type": "es6"
+  },
+  "sourceMaps": true,
+  "exclude": []
+}

packages/common-cli/.spec.swcrc

@@ -0,0 +1,29 @@
+{
+  "jsc": {
+    "target": "es2017",
+    "parser": {
+      "syntax": "typescript",
+      "decorators": true,
+      "dynamicImport": true
+    },
+    "transform": {
+      "decoratorMetadata": true,
+      "legacyDecorator": true
+    },
+    "keepClassNames": true,
+    "externalHelpers": true,
+    "loose": true
+  },
+  "module": {
+    "type": "es6"
+  },
+  "sourceMaps": true,
+  "exclude": [
+    "jest.config.ts",
+    ".*\\.spec.tsx?$",
+    ".*\\.test.tsx?$",
+    "./src/jest-setup.ts$",
+    "./**/jest-setup.ts$",
+    ".*.js$"
+  ]
+}

packages/common-cli/.swcrc

@@ -1,11 +1,21 @@
 /* eslint-disable */
+import { readFileSync } from 'fs';
+
+// Reading the SWC compilation config for the spec files
+const swcJestConfig = JSON.parse(
+  readFileSync(`${__dirname}/.spec.swcrc`, 'utf-8')
+);
+
+// Disable .swcrc look-up by SWC core because we're passing in swcJestConfig ourselves
+swcJestConfig.swcrc = false;
+
 export default {
   displayName: 'common-cli',
   preset: '../../jest.preset.js',
   testEnvironment: 'node',
   transform: {
-    '^.+\\.[tj]s$': ['ts-jest', { tsconfig: '<rootDir>/tsconfig.spec.json' }],
+    '^.+\\.[tj]s$': ['@swc/jest', swcJestConfig],
   },
   moduleFileExtensions: ['ts', 'js', 'html'],
-  coverageDirectory: '../../coverage/packages/common-cli',
+  coverageDirectory: 'test-output/jest/coverage',
 };