Add typescript project references (#787)

Author: JakeLane

.github/workflows/ci.yml

@@ -124,16 +124,14 @@ jobs:
       - uses: ./.github/actions/setup-node
       - run: npx eslint .
       - run: npx prettier --list-different .
-      - run: npx lerna run --parallel build-tsc
 
   check_typescript:
     name: 📋 Check TypeScript
     runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
       - uses: ./.github/actions/setup-node
-      - run: npx lerna run build-ts
-      - run: npx lerna run check-ts
+      - run: yarn build:ts
 
   lint_rust:
     name: 🦀 Lint Rust

.github/workflows/type-coverage-comment.yml

@@ -0,0 +1,65 @@
+name: Type Coverage PR Comment
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+concurrency:
+  # Cancel previous runs for the same PR
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+  pull-requests: write
+
+jobs:
+  type-coverage:
+    name: Type Coverage Report
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          # Fetch full history to enable comparison with base branch
+          fetch-depth: 0
+
+      - name: Setup Node.js
+        uses: ./.github/actions/setup-node
+
+      - name: Fetch base branch
+        run: |
+          git fetch origin ${{ github.base_ref }}:refs/remotes/origin/${{ github.base_ref }}
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+
+      - name: Build TypeScript references
+        run: yarn update-ts-references --frozen
+
+      - name: Run type coverage
+        id: type-coverage
+        uses: actions/github-script@v7
+        with:
+          result-encoding: string
+          script: |
+            const { generateTypeCoverageComment } = require('./scripts/generate-type-coverage-comment.js');
+
+            return generateTypeCoverageComment();
+
+      - name: Find existing comment
+        uses: peter-evans/find-comment@v3
+        id: find-comment
+        with:
+          issue-number: ${{ github.event.pull_request.number }}
+          comment-author: 'github-actions[bot]'
+          body-includes: '📊 Type Coverage Report'
+
+      - name: Create or update comment
+        uses: peter-evans/create-or-update-comment@v4
+        with:
+          comment-id: ${{ steps.find-comment.outputs.comment-id }}
+          issue-number: ${{ github.event.pull_request.number }}
+          body: ${{ steps.type-coverage.outputs.result }}
+          edit-mode: replace

.vscode/settings.json

@@ -1,4 +1,5 @@
 {
+  "typescript.tsdk": "node_modules/typescript/lib",
   "rust-analyzer.cargo.features": "all",
   "rust-analyzer.check.command": "clippy",
   "javascript.validate.enable": false,

crates/apvm/src/cmd/install_git.rs

@@ -58,11 +58,8 @@ pub fn install_from_git(
   println!("Building (Native)");
   exec_blocking(["yarn", "build-native-release"], &command_options)?;
 
-  println!("Building (Flow)");
-  exec_blocking(["yarn", "build"], &command_options)?;
-
   println!("Building (TypeScript)");
-  exec_blocking(["yarn", "build-ts"], &command_options)?;
+  exec_blocking(["yarn", "build"], &command_options)?;
 
   // Save a little space
   fs::remove_dir_all(inner_temp.path().join("target"))?;

nx.json

@@ -2,16 +2,6 @@
   "$schema": "https://raw.githubusercontent.com/nrwl/nx/refs/heads/master/packages/nx/schemas/nx-schema.json",
   "parallel": "200%",
   "targetDefaults": {
-    "check-ts": {
-      "dependsOn": ["^check-ts", "^dev:prepare"],
-      "inputs": [
-        "{projectRoot}/src/**/*.{ts,tsx}",
-        "{projectRoot}/tsconfig.json",
-        "{projectRoot}/package.json"
-      ],
-      "outputs": ["{projectRoot}/lib/**/*.js", "{projectRoot}/**/*.d.ts"],
-      "cache": true
-    },
     "dev:prepare": {
       "inputs": [
         "{projectRoot}/**/*.{ts,tsx}",
@@ -35,15 +25,13 @@
     "test": {
       "dependsOn": [
         {"projects": ["*"], "target": "build-native-release"},
-        {"projects": ["*"], "target": "build:lib"},
-        {"projects": ["*"], "target": "check-ts"}
+        {"projects": ["*"], "target": "build:lib"}
       ]
     },
     "test:integration": {
       "dependsOn": [
         {"projects": ["*"], "target": "build-native-release"},
-        {"projects": ["*"], "target": "build:lib"},
-        {"projects": ["*"], "target": "check-ts"}
+        {"projects": ["*"], "target": "build:lib"}
       ]
     },
     "build-native-release": {
@@ -62,8 +50,7 @@
     "test:integration:ci": {
       "dependsOn": [
         {"projects": ["*"], "target": "build-native-release"},
-        {"projects": ["*"], "target": "build:lib"},
-        {"projects": ["*"], "target": "check-ts"}
+        {"projects": ["*"], "target": "build:lib"}
       ]
     }
   }

package.json

@@ -19,13 +19,11 @@
     "@swc/core": "1.11.18"
   },
   "scripts": {
-    "build": "yarn build:clean && yarn build:prepare && yarn build:tsc && yarn build:gulp && yarn build-ts",
+    "build": "yarn build:clean && yarn build:prepare && yarn build:gulp && yarn build:ts",
     "build:clean": "node ./scripts/clean.mjs",
     "build:prepare": "lerna run dev:prepare",
-    "build:tsc": "lerna run --parallel build-tsc",
     "build:gulp": "cross-env NODE_ENV=production ATLASPACK_BUILD_ENV=production ATLASPACK_REGISTER_USE_SRC=true gulp",
-    "build-ts": "lerna run build-ts",
-    "build-dts": "yarn check-ts",
+    "build:ts": "yarn update-ts-references && tsc --build tsconfig.paths.json",
     "build-native": "node scripts/build-native.js",
     "build-native-release": "cross-env CARGO_PROFILE=release node scripts/build-native.js",
     "build-native-wasm": "cross-env CARGO_PROFILE=release RUSTUP_TARGET=wasm32-unknown-unknown scripts/build-native.js",
@@ -37,10 +35,10 @@
     "link-all": "node scripts/link-all.js packages",
     "unlink-all": "node scripts/unlink-all.js packages",
     "check": "flow check",
-    "check-ts": "lerna run check-ts",
+    "update-ts-references": "node scripts/update-ts-references.mjs",
     "lint": "node ./scripts/lint-all.mjs",
     "prepublishOnly": "yarn pre-publish",
-    "pre-publish": "yarn build && yarn build-dts && node ./scripts/rewrite-package-types.mjs && yarn build-ts",
+    "pre-publish": "yarn build && node ./scripts/rewrite-package-types.mjs",
     "changesets-publish": "yarn pre-publish && yarn changeset publish",
     "test": "yarn test:unit && yarn test:integration",
     "test:e2e": "yarn workspace @atlaspack/e2e-tests test",
@@ -61,7 +59,8 @@
     "tag:release": "lerna version --exact --force-publish=* --no-git-tag-version --no-push",
     "release": "lerna publish -y from-package --pre-dist-tag=next --no-git-tag-version --no-push",
     "prepare": "husky install",
-    "postinstall": "patch-package"
+    "postinstall": "patch-package",
+    "type-coverage": "type-coverage -b tsconfig.paths.json"
   },
   "devDependencies": {
     "@babel/core": "^7.22.11",
@@ -94,6 +93,8 @@
     "rimraf": "^5.0.5",
     "semver": "^7.5.2",
     "sinon": "^7.3.1",
+    "type-coverage": "^2.3.3",
+    "typecov": "^0.2.3",
     "typescript": "^5.8.3",
     "zx": "^8.1.9"
   },

packages/bundlers/bundler-experimental/package.json

@@ -32,7 +32,6 @@
     "@atlaspack/fs": "2.15.26"
   },
   "scripts": {
-    "check-ts": "tsc --emitDeclarationOnly --rootDir src",
     "build:lib": "gulp build --gulpfile ../../../gulpfile.js --cwd ."
   }
 }

packages/bundlers/bundler-experimental/tsconfig.json

@@ -1,4 +1,5 @@
 {
-  "extends": "../../../tsconfig.json",
-  "include": ["src"]
+  "extends": "../../../tsconfig.base.json",
+  "include": ["src"],
+  "composite": true
 }

packages/bundlers/default/package.json

@@ -30,7 +30,6 @@
     "sorted-array-functions": "^1.0.0"
   },
   "scripts": {
-    "check-ts": "tsc --emitDeclarationOnly --rootDir src",
     "build:lib": "gulp build --gulpfile ../../../gulpfile.js --cwd ."
   }
 }

packages/bundlers/default/tsconfig.json

@@ -1,4 +1,30 @@
 {
-  "extends": "../../../tsconfig.json",
-  "include": ["src"]
+  "extends": "../../../tsconfig.base.json",
+  "include": ["src"],
+  "compilerOptions": {
+    "composite": true
+  },
+  "references": [
+    {
+      "path": "../../core/diagnostic/tsconfig.json"
+    },
+    {
+      "path": "../../core/feature-flags/tsconfig.json"
+    },
+    {
+      "path": "../../core/graph/tsconfig.json"
+    },
+    {
+      "path": "../../core/plugin/tsconfig.json"
+    },
+    {
+      "path": "../../core/rust/tsconfig.json"
+    },
+    {
+      "path": "../../core/types-internal/tsconfig.json"
+    },
+    {
+      "path": "../../core/utils/tsconfig.json"
+    }
+  ]
 }