chore: adopt typescript project references (#322)

mnahkies · web-flow · commit 86fa31f37986 · 2025-05-04T09:45:11.000Z
- adopt project references for the main packages - add `yarn build:watch` command using new config ref: https://www.typescriptlang.org/docs/handbook/project-references.html
diff --git a/e2e/tsconfig.json b/e2e/tsconfig.json
@@ -1,6 +1,7 @@
 {
-  "extends": "../tsconfig.json",
+  "extends": "../tsconfig.base.json",
   "compilerOptions": {
+    "composite": false,
     "outDir": "./dist",
     "rootDir": "./src"
   },
diff --git a/integration-tests/typescript-axios/tsconfig.json b/integration-tests/typescript-axios/tsconfig.json
@@ -1,6 +1,7 @@
 {
-  "extends": "../../tsconfig.json",
+  "extends": "../../tsconfig.base.json",
   "compilerOptions": {
+    "composite": false,
     "outDir": "./dist",
     "rootDir": "./src",
     /* exercise the code path where exactOptionalPropertyTypes is enabled */
diff --git a/integration-tests/typescript-fetch/tsconfig.json b/integration-tests/typescript-fetch/tsconfig.json
@@ -1,6 +1,7 @@
 {
-  "extends": "../../tsconfig.json",
+  "extends": "../../tsconfig.base.json",
   "compilerOptions": {
+    "composite": false,
     "outDir": "./dist",
     "rootDir": "./src",
     /* exercise the code path where exactOptionalPropertyTypes is disabled */
diff --git a/integration-tests/typescript-koa/tsconfig.json b/integration-tests/typescript-koa/tsconfig.json
@@ -1,6 +1,7 @@
 {
-  "extends": "../../tsconfig.json",
+  "extends": "../../tsconfig.base.json",
   "compilerOptions": {
+    "composite": false,
     "outDir": "./dist",
     "rootDir": "./src",
     "types": [],
diff --git a/package.json b/package.json
@@ -24,6 +24,7 @@
     "lint": "biome lint --write .",
     "format": "biome check --write .",
     "build": "node ./scripts/generate-ajv-validator.js && lerna run build  --stream --scope '@nahkies/*'",
+    "build:watch": "tsc -b tsconfig.json -w",
     "test": "NODE_OPTIONS=--experimental-vm-modules jest",
     "integration:generate": "node ./scripts/generate.mjs",
     "integration:validate": "lerna run validate --stream",
diff --git a/packages/openapi-code-generator/tsconfig.json b/packages/openapi-code-generator/tsconfig.json
@@ -1,8 +1,9 @@
 {
-  "extends": "../../tsconfig.json",
+  "extends": "../../tsconfig.base.json",
   "compilerOptions": {
     "outDir": "./dist",
     "rootDir": "./src"
   },
-  "include": ["src/**/*"]
+  "include": ["src/**/*"],
+  "references": []
 }
diff --git a/packages/typescript-axios-runtime/tsconfig.json b/packages/typescript-axios-runtime/tsconfig.json
@@ -1,8 +1,9 @@
 {
-  "extends": "../../tsconfig.json",
+  "extends": "../../tsconfig.base.json",
   "compilerOptions": {
     "outDir": "./dist",
     "rootDir": "./src"
   },
-  "include": ["src/**/*"]
+  "include": ["src/**/*"],
+  "references": []
 }
diff --git a/packages/typescript-fetch-runtime/tsconfig.json b/packages/typescript-fetch-runtime/tsconfig.json
@@ -1,8 +1,9 @@
 {
-  "extends": "../../tsconfig.json",
+  "extends": "../../tsconfig.base.json",
   "compilerOptions": {
     "outDir": "./dist",
     "rootDir": "./src"
   },
-  "include": ["src/**/*"]
+  "include": ["src/**/*"],
+  "references": []
 }
diff --git a/packages/typescript-koa-runtime/tsconfig.json b/packages/typescript-koa-runtime/tsconfig.json
@@ -1,8 +1,9 @@
 {
-  "extends": "../../tsconfig.json",
+  "extends": "../../tsconfig.base.json",
   "compilerOptions": {
     "outDir": "./dist",
     "rootDir": "./src"
   },
-  "include": ["src/**/*"]
+  "include": ["src/**/*"],
+  "references": []
 }
diff --git a/tsconfig.base.json b/tsconfig.base.json
@@ -0,0 +1,20 @@
+{
+  "extends": ["@tsconfig/strictest/tsconfig", "@tsconfig/node22/tsconfig"],
+  "compilerOptions": {
+    "composite": true,
+    "skipLibCheck": true,
+    "declaration": true,
+    "sourceMap": true,
+    "importHelpers": true,
+    "resolveJsonModule": true,
+    // prefer linter rule
+    "noUnusedLocals": false,
+    "noUnusedParameters": false,
+    // incompatible with https://biomejs.dev/linter/rules/use-literal-keys/
+    "noPropertyAccessFromIndexSignature": false,
+    "moduleResolution": "Node16",
+    "paths": {
+      "@nahkies/*": ["./packages/*/src"]
+    }
+  }
+}
diff --git a/tsconfig.json b/tsconfig.json
@@ -1,18 +1,10 @@
 {
-  "extends": ["@tsconfig/strictest/tsconfig", "@tsconfig/node22/tsconfig"],
-  "compilerOptions": {
-    "declaration": true,
-    "sourceMap": true,
-    "importHelpers": true,
-    "resolveJsonModule": true,
-    // prefer linter rule
-    "noUnusedLocals": false,
-    "noUnusedParameters": false,
-    // incompatible with https://biomejs.dev/linter/rules/use-literal-keys/
-    "noPropertyAccessFromIndexSignature": false,
-    "moduleResolution": "Node16",
-    "paths": {
-      "@nahkies/*": ["./packages/*/src"]
-    }
-  }
+  "files": [],
+  "include": [],
+  "references": [
+    { "path": "./packages/openapi-code-generator" },
+    { "path": "./packages/typescript-axios-runtime" },
+    { "path": "./packages/typescript-fetch-runtime" },
+    { "path": "./packages/typescript-koa-runtime" }
+  ]
 }

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`{`
`2`		`- "extends": "../tsconfig.json",`
	`2`	`+ "extends": "../tsconfig.base.json",`
`3`	`3`	`"compilerOptions": {`
	`4`	`+ "composite": false,`
`4`	`5`	`"outDir": "./dist",`
`5`	`6`	`"rootDir": "./src"`
`6`	`7`	`},`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`{`
`2`		`- "extends": "../../tsconfig.json",`
	`2`	`+ "extends": "../../tsconfig.base.json",`
`3`	`3`	`"compilerOptions": {`
	`4`	`+ "composite": false,`
`4`	`5`	`"outDir": "./dist",`
`5`	`6`	`"rootDir": "./src",`
`6`	`7`	`/* exercise the code path where exactOptionalPropertyTypes is enabled */`
Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,9 @@`
`1`	`1`	`{`
`2`		`- "extends": "../../tsconfig.json",`
	`2`	`+ "extends": "../../tsconfig.base.json",`
`3`	`3`	`"compilerOptions": {`
`4`	`4`	`"outDir": "./dist",`
`5`	`5`	`"rootDir": "./src"`
`6`	`6`	`},`
`7`		`- "include": ["src/*/"]`
	`7`	`+ "include": ["src/*/"],`
	`8`	`+ "references": []`
`8`	`9`	`}`