Merge pull request #160 from ethdebug/increments

Enable incremental TypeScript compilation with project references

Author: gnidan

.gitignore

@@ -1 +1,2 @@
 node_modules/
+*.tsbuildinfo

package.json

@@ -5,6 +5,7 @@
     "packages/*"
   ],
   "scripts": {
+    "build": "tsc --build packages/format packages/pointers",
     "bundle": "tsx ./bin/bundle-schema.ts",
     "test": "vitest",
     "start": "./bin/start",

packages/format/bin/generate-schema-yamls.js

@@ -33,7 +33,7 @@ const rawSchemas = Object.entries(schemaYamls)
   .map(([id, yaml]) => ({ [id]: YAML.parse(yaml) }))
   .reduce((a, b) => ({ ...a, ...b }), {});
 
-console.log(`// THIS FILE GETS AUTO-GENERATED AS PART OF THIS PACKAGE'S BUILD PROCESS
+const output = `// THIS FILE GETS AUTO-GENERATED AS PART OF THIS PACKAGE'S BUILD PROCESS
 // Please do not modify it directly or allow it to get checked into source control.
 
 export type SchemaYamlsById = {
@@ -50,4 +50,11 @@ const rawSchemas = ${JSON.stringify(rawSchemas, undefined, 2)} as const;
 
 export type Schema<Id extends keyof typeof rawSchemas> =
   (typeof rawSchemas)[Id];
-`);
+`;
+
+const outputPath = path.resolve(__dirname, "../src/schemas/yamls.ts");
+const tempPath = outputPath + ".tmp";
+
+// Write to temp file, then rename atomically to avoid race conditions
+fs.writeFileSync(tempPath, output);
+fs.renameSync(tempPath, outputPath);

packages/format/package.json

@@ -9,13 +9,13 @@
     "dist"
   ],
   "scripts": {
-    "prepare:yamls": "node ./bin/generate-schema-yamls.js > src/schemas/yamls.ts",
+    "prepare:yamls": "node ./bin/generate-schema-yamls.js",
     "prepare": "yarn prepare:yamls && tsc",
     "clean": "rm -rf dist && rm src/schemas/yamls.ts",
     "test": "vitest",
     "watch:typescript": "tsc --watch",
     "watch:schemas": "nodemon --watch ../../schemas -e 'yaml' --exec 'yarn prepare:yamls'",
-    "watch": "concurrently --names=tsc,schemas \"yarn watch:typescript\" \"yarn watch:schemas\""
+    "watch": "yarn prepare && concurrently --names=tsc,schemas \"yarn watch:typescript\" \"yarn watch:schemas\""
   },
   "dependencies": {
     "json-schema-typed": "^8.0.1",

packages/format/test/guards.ts

@@ -8,7 +8,7 @@ export interface SchemaGuard extends DescribeSchemaOptions {
 
 export const testSchemaGuards = (
   namespace: string,
-  schemaGuards: SchemaGuard[],
+  schemaGuards: readonly SchemaGuard[],
 ) => {
   describe(`type guards for ${namespace} schemas`, () => {
     for (const { guard, ...describeSchemaOptions } of schemaGuards) {

packages/format/tsconfig.json

@@ -8,5 +8,5 @@
     "rootDir": "./",
     "outDir": "./dist/"
   },
-  "include": ["./src/**/*.ts", "vitest.d.ts", "yamls.ts"]
+  "include": ["./src/**/*.ts", "./test/**/*.ts", "./*.ts"]
 }

packages/pointers/package.json

@@ -7,8 +7,8 @@
   "license": "MIT",
   "scripts": {
     "run-example": "node ./dist/bin/run-example.js",
-    "prepare": "tsc",
-    "watch": "yarn prepare --watch",
+    "prepare": "tsc --build",
+    "watch": "tsc --build --watch",
     "test": "vitest"
   },
   "devDependencies": {

packages/pointers/tsconfig.json

@@ -3,5 +3,6 @@
   "compilerOptions": {
     "rootDir": "./",
     "outDir": "./dist/"
-  }
+  },
+  "references": [{ "path": "../format" }]
 }

tsconfig.base.json

@@ -3,8 +3,8 @@
     /* Visit https://aka.ms/tsconfig to read more about this file */
 
     /* Projects */
-    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
-    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    "incremental": true /* Save .tsbuildinfo files to allow for incremental compilation of projects. */,
+    "composite": true /* Enable constraints that allow a TypeScript project to be used with project references. */,
     // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
     // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
     // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */