fix(dev): using TypeScript Go typechecker / compiler in "start:dev:quick" mode during watcher process (single pass for entire codebase, in-terminal reporting, not interrupting in React GUI, unlike "start:dev")

danielweck · danielweck · commit aa7adcfc9006 · 2025-05-23T22:44:48.000+01:00
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -411,6 +411,7 @@
     "markdown-loader": "^8.0.0",
     "mini-css-extract-plugin": "^2.9.2",
     "ncp": "^2.0.0",
+    "node-pty": "^1.0.0",
     "npm-scripts-lifecycle": "^1.0.0",
     "prettier": "^3.5.3",
     "remote-redux-devtools": "^0.5.16",
diff --git a/scripts/go-ts-checker-webpack-plugin.js b/scripts/go-ts-checker-webpack-plugin.js
@@ -0,0 +1,140 @@
+// https://github.com/piecyk/tsc-webpack-plugin/blob/main/index.js
+
+const path = require("path");
+const os = require("os");
+const pty = require("node-pty");
+
+class TsgoError extends Error {
+  constructor(message) {
+    super(message);
+    this.name = "TsgoError";
+    this.stack = "";
+  }
+}
+
+const removeNewLinesAtEnd = (str) => str.replace(/(\r\n|\n|\r)+$/g, "");
+
+const PLUGIN_NAME = "tsgo-plugin";
+
+class TsgoWebpackPlugin {
+  constructor(options = {}) {
+    this.name = options.name;
+    if (options.name) {
+        options.name = undefined;
+        delete options.name;
+    }
+    this.options = options;
+    this.initialized = false;
+  }
+  async apply(compiler) {
+    const isWatch = await new Promise((resolve) => {
+      compiler.hooks.run.tap(PLUGIN_NAME, () => {
+        if (!this.initialized) {
+          this.initialized = true;
+
+          resolve(false);
+        }
+      });
+
+      compiler.hooks.watchRun.tap(PLUGIN_NAME, () => {
+        if (!this.initialized) {
+          this.initialized = true;
+
+          resolve(true);
+        }
+      });
+    });
+
+    const file = path.resolve(
+      compiler.context,
+      `./node_modules/.bin/tsgo${os.platform() === "win32" ? ".exe" : ""}`
+    );
+
+    const options = {
+      ...this.options,
+      ...(isWatch ? { watch: "", preserveWatchOutput: "" } : {}),
+    };
+
+    const args = [
+      ...new Set(
+        Object.keys(options)
+          .reduce((acc, key) => [...acc, `--${key}`, String(options[key])], [])
+          .filter(Boolean)
+      ),
+    ];
+
+    const ptyProcess = pty.spawn(file, args, {
+      name: "xterm-color",
+    });
+
+    process.once("exit", () => {
+      ptyProcess.emit("exit");
+    });
+
+    const logger = compiler.getInfrastructureLogger(PLUGIN_NAME);
+
+    let messages = [];
+
+    ptyProcess.onData((data) => {
+      const d = removeNewLinesAtEnd(data);
+      if (!d.includes("build starting") && (!d.includes("build finished") || d.includes("error"))) {
+        process.stderr.write("\x07"); // beep
+      }
+
+      // console.log(`==TSGO[${this.name}] data:`);
+      // logger.info(`--TSGO[${this.name}] data:`);
+      // console.log(d);
+      logger.info(d);
+      if (!isWatch) {
+        messages.push(data);
+      }
+    });
+
+    if (isWatch) {
+      // console.log(`==TSGO[${this.name}] start (watch)...`);
+      logger.info(`--TSGO[${this.name}] start (watch)...`);
+
+      ptyProcess.onExit((e) => {
+        process.exit(e.exitCode);
+      });
+    } else {
+      // console.log(`==TSGO[${this.name}] start (not watch)...`);
+      logger.info(`--TSGO[${this.name}] start (not watch)...`);
+
+      compiler.hooks.afterEmit.tapPromise(PLUGIN_NAME, async (compilation) => {
+        // console.log(`==TSGO[${this.name}] compiler.hooks.afterEmit.tapPromise...`);
+        logger.info(`--TSGO[${this.name}] compiler.hooks.afterEmit.tapPromise...`);
+
+        await new Promise((resolve) => {
+          ptyProcess.onExit(() => {
+            resolve();
+          });
+        });
+
+        if (messages.length > 0) {
+          // console.log(`==TSGO[${this.name}] ${messages.length} errors!`);
+          logger.info(`--TSGO[${this.name}] ${messages.length} errors!`);
+
+          messages
+            .map((m) =>
+              removeNewLinesAtEnd(
+                m
+                  .split("\r\n")
+                  .map((s) => s.replace(/^Found \d+ errors?\b.$/, ""))
+                  .join("\r\n")
+              )
+            )
+            .filter(Boolean)
+            .map((m) => compilation.errors.push(new TsgoError(m)));
+
+          messages = [];
+        } else {
+          // console.log(`--TSGO[${this.name}] zero errors.`);
+          logger.info(`==TSGO[${this.name}] zero errors.`);
+        }
+      });
+    }
+  }
+}
+
+module.exports = TsgoWebpackPlugin;
diff --git a/tsconfig-cli.json b/tsconfig-cli.json
@@ -1,7 +1,7 @@
 {
   "extends": "./tsconfig",
   "compilerOptions": {
-    "skipLibCheck": true,
+    // "skipLibCheck": true,
     // NODENEXT works because "typed-redux-saga/macro" in WebPack Babel config is not used when compiling from the CLI with tsc or tsgo
     // "module": "esnext", // 99
     // "module": "ES2020", // 6
diff --git a/tsconfig.json b/tsconfig.json
@@ -42,7 +42,7 @@
     "traceResolution": false,
     "disableSizeLimit": false,
     "removeComments": true,
-    "skipLibCheck": false,
+    "skipLibCheck": true,
     // NODENEXT does not work because of "typed-redux-saga/macro" in WebPack Babel config
     "module": "esnext", // 99
     // "module": "ES2020", // 6
diff --git a/webpack.config.main.js b/webpack.config.main.js
@@ -13,6 +13,7 @@ console.log(`MAIN nodeEnv: ${nodeEnv}`);
 
 // https://github.com/edrlab/thorium-reader/issues/1097#issuecomment-643406149
 const useLegacyTypeScriptLoader = process.env.USE_LEGACY_TYPESCRIPT_LOADER ? true : false;
+const GoTsCheckerWebpackPlugin = require("./scripts/go-ts-checker-webpack-plugin");
 const ForkTsCheckerWebpackPlugin = require("fork-ts-checker-webpack-plugin");
 ForkTsCheckerWebpackPlugin.prototype[require("util").inspect.custom] = (_depth, _options) => {
     return "ForkTsCheckerWebpackPlugin";
@@ -254,7 +255,11 @@ config.plugins.push(new webpack.IgnorePlugin({ resourceRegExp: /^.\/runtime-fs$/
 
 config.plugins.push(new webpack.IgnorePlugin({ resourceRegExp: /^canvas$/ })); // pdfjs
 
-if (!checkTypeScriptSkip) {
+if (checkTypeScriptSkip) {
+    // config.plugins.push(
+    //     new GoTsCheckerWebpackPlugin({name: "MAIN"}),
+    // );
+} else {
     config.plugins.push(
         new ForkTsCheckerWebpackPlugin({
             // measureCompilationTime: true,
diff --git a/webpack.config.renderer-library.js b/webpack.config.renderer-library.js
@@ -32,6 +32,7 @@ console.log(`LIBRARY nodeEnv: ${nodeEnv}`);
 
 // https://github.com/edrlab/thorium-reader/issues/1097#issuecomment-643406149
 const useLegacyTypeScriptLoader = process.env.USE_LEGACY_TYPESCRIPT_LOADER ? true : false;
+const GoTsCheckerWebpackPlugin = require("./scripts/go-ts-checker-webpack-plugin");
 const ForkTsCheckerWebpackPlugin = require("fork-ts-checker-webpack-plugin");
 ForkTsCheckerWebpackPlugin.prototype[require("util").inspect.custom] = (_depth, _options) => {
     return "ForkTsCheckerWebpackPlugin";
@@ -407,7 +408,12 @@ let config = Object.assign(
     },
 );
 
-if (!checkTypeScriptSkip) {
+
+if (checkTypeScriptSkip) {
+    config.plugins.push(
+        new GoTsCheckerWebpackPlugin({name: "LIBRARY"}), // we use a single-pass fast-compile/typecheck in this LIBRARY watcher, no need in READER (and MAIN + PDF configs do not activate a watcher)
+    );
+} else {
     config.plugins.push(
         new ForkTsCheckerWebpackPlugin({
             // measureCompilationTime: true,
diff --git a/webpack.config.renderer-pdf.js b/webpack.config.renderer-pdf.js
@@ -23,6 +23,7 @@ console.log(`PDF nodeEnv: ${nodeEnv}`);
 
 // https://github.com/edrlab/thorium-reader/issues/1097#issuecomment-643406149
 const useLegacyTypeScriptLoader = process.env.USE_LEGACY_TYPESCRIPT_LOADER ? true : false;
+const GoTsCheckerWebpackPlugin = require("./scripts/go-ts-checker-webpack-plugin");
 const ForkTsCheckerWebpackPlugin = require("fork-ts-checker-webpack-plugin");
 ForkTsCheckerWebpackPlugin.prototype[require("util").inspect.custom] = (_depth, _options) => {
     return "ForkTsCheckerWebpackPlugin";
@@ -183,7 +184,11 @@ let config = Object.assign(
     },
 );
 
-if (!checkTypeScriptSkip) {
+if (checkTypeScriptSkip) {
+    // config.plugins.push(
+    //     new GoTsCheckerWebpackPlugin({name: "PDF"}),
+    // );
+} else {
     config.plugins.push(
         new ForkTsCheckerWebpackPlugin({
             // measureCompilationTime: true,
diff --git a/webpack.config.renderer-reader.js b/webpack.config.renderer-reader.js
@@ -33,6 +33,7 @@ console.log(`READER nodeEnv: ${nodeEnv}`);
 
 // https://github.com/edrlab/thorium-reader/issues/1097#issuecomment-643406149
 const useLegacyTypeScriptLoader = process.env.USE_LEGACY_TYPESCRIPT_LOADER ? true : false;
+const GoTsCheckerWebpackPlugin = require("./scripts/go-ts-checker-webpack-plugin");
 const ForkTsCheckerWebpackPlugin = require("fork-ts-checker-webpack-plugin");
 ForkTsCheckerWebpackPlugin.prototype[require("util").inspect.custom] = (_depth, _options) => {
     return "ForkTsCheckerWebpackPlugin";
@@ -394,7 +395,11 @@ let config = Object.assign(
     },
 );
 
-if (!checkTypeScriptSkip) {
+if (checkTypeScriptSkip) {
+    // config.plugins.push(
+    //     new GoTsCheckerWebpackPlugin({name: "READER"}),
+    // );
+} else {
     config.plugins.push(
         new ForkTsCheckerWebpackPlugin({
             // measureCompilationTime: true,

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"extends": "./tsconfig",`
`3`	`3`	`"compilerOptions": {`
`4`		`- "skipLibCheck": true,`
	`4`	`+ // "skipLibCheck": true,`
`5`	`5`	`// NODENEXT works because "typed-redux-saga/macro" in WebPack Babel config is not used when compiling from the CLI with tsc or tsgo`
`6`	`6`	`// "module": "esnext", // 99`
`7`	`7`	`// "module": "ES2020", // 6`