@rsbuild/plugin-type-check 1.0.0 → 1.0.1-beta.0

package/README.md

@@ -4,7 +4,7 @@
 
 # Rsbuild
 
-Unleash the power of Rspack with the out-of-the-box build tool.
+The Rspack-based build tool. It's fast, out-of-the-box and extensible.
 
 ## Documentation
 

package/dist/index.cjs

@@ -0,0 +1,120 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  PLUGIN_TYPE_CHECK_NAME: () => PLUGIN_TYPE_CHECK_NAME,
+  pluginTypeCheck: () => pluginTypeCheck
+});
+module.exports = __toCommonJS(src_exports);
+var import_node_fs = __toESM(require("fs"));
+var import_core = require("@rsbuild/core");
+var import_deepmerge = __toESM(require("deepmerge"));
+var import_reduce_configs = require("reduce-configs");
+var PLUGIN_TYPE_CHECK_NAME = "rsbuild:type-check";
+var pluginTypeCheck = (options = {}) => {
+  return {
+    name: PLUGIN_TYPE_CHECK_NAME,
+    setup(api) {
+      const NODE_MODULES_REGEX = /[\\/]node_modules[\\/]/;
+      const checkedTsconfig = /* @__PURE__ */ new Map();
+      api.modifyBundlerChain(
+        async (chain, { isProd, environment, CHAIN_ID }) => {
+          const { enable = true, forkTsCheckerOptions } = options;
+          const { tsconfigPath } = environment;
+          if (!tsconfigPath || enable === false) {
+            return;
+          }
+          if (checkedTsconfig.has(tsconfigPath) && checkedTsconfig.get(tsconfigPath) !== environment.name) {
+            return;
+          }
+          checkedTsconfig.set(tsconfigPath, environment.name);
+          let typescriptPath;
+          try {
+            typescriptPath = require.resolve("typescript", {
+              paths: [api.context.rootPath]
+            });
+          } catch (err) {
+            import_core.logger.warn(
+              '"typescript" is not found in current project, Type checker will not work.'
+            );
+            return;
+          }
+          const { default: ForkTsCheckerWebpackPlugin } = await import("fork-ts-checker-webpack-plugin");
+          const { default: json5 } = await import("json5");
+          const { references } = json5.parse(
+            import_node_fs.default.readFileSync(tsconfigPath, "utf-8")
+          );
+          const useReference = Array.isArray(references) && references.length > 0;
+          const defaultOptions = {
+            typescript: {
+              // set 'readonly' to avoid emitting tsbuildinfo,
+              // as the generated tsbuildinfo will break fork-ts-checker
+              mode: "readonly",
+              // enable build when using project reference
+              build: useReference,
+              // avoid OOM issue
+              memoryLimit: 8192,
+              // use tsconfig of user project
+              configFile: tsconfigPath,
+              // use typescript of user project
+              typescriptPath
+            },
+            issue: {
+              // ignore types errors from node_modules
+              exclude: [({ file = "" }) => NODE_MODULES_REGEX.test(file)]
+            },
+            logger: {
+              log() {
+              },
+              error(message) {
+                console.error(message.replace(/ERROR/g, "Type Error"));
+              }
+            }
+          };
+          const typeCheckerOptions = (0, import_reduce_configs.reduceConfigs)({
+            initial: defaultOptions,
+            config: forkTsCheckerOptions,
+            mergeFn: import_deepmerge.default
+          });
+          if (isProd) {
+            import_core.logger.info("Type checker is enabled. It may take some time.");
+          }
+          chain.plugin(CHAIN_ID.PLUGIN.TS_CHECKER).use(ForkTsCheckerWebpackPlugin, [typeCheckerOptions]);
+        }
+      );
+    }
+  };
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  PLUGIN_TYPE_CHECK_NAME,
+  pluginTypeCheck
+});

package/dist/index.d.ts

@@ -1,12 +1,19 @@
-import { RsbuildPlugin } from '@rsbuild/core';
-import { ChainedConfig } from '@rsbuild/shared';
-import ForkTSCheckerPlugin from 'fork-ts-checker-webpack-plugin';
-
-type ForkTsCheckerOptions = ConstructorParameters<typeof ForkTSCheckerPlugin>[0];
-type PluginTypeCheckerOptions = {
+import { type RsbuildPlugin } from '@rsbuild/core';
+import type ForkTSCheckerPlugin from 'fork-ts-checker-webpack-plugin';
+import { type ConfigChain } from 'reduce-configs';
+type ForkTsCheckerOptions = NonNullable<ConstructorParameters<typeof ForkTSCheckerPlugin>[0]>;
+export type PluginTypeCheckerOptions = {
+    /**
+     * Whether to enable TypeScript type checking.
+     * @default true
+     */
     enable?: boolean;
-    forkTsCheckerOptions?: ChainedConfig<ForkTsCheckerOptions>;
+    /**
+     * To modify the options of `fork-ts-checker-webpack-plugin`.
+     * @see https://github.com/TypeStrong/fork-ts-checker-webpack-plugin#readme
+     */
+    forkTsCheckerOptions?: ConfigChain<ForkTsCheckerOptions>;
 };
-declare const pluginTypeCheck: (options?: PluginTypeCheckerOptions) => RsbuildPlugin;
-
-export { PluginTypeCheckerOptions, pluginTypeCheck };
+export declare const PLUGIN_TYPE_CHECK_NAME = "rsbuild:type-check";
+export declare const pluginTypeCheck: (options?: PluginTypeCheckerOptions) => RsbuildPlugin;
+export {};

package/dist/index.js

@@ -1,102 +1,99 @@
-"use strict";
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
-  // If the importer is in node compatibility mode or this is not an ESM
-  // file that has been converted to a CommonJS file using a Babel-
-  // compatible transform (i.e. "__esModule" has not been set), then set
-  // "default" to the CommonJS "module.exports" for node compatibility.
-  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
-  mod
-));
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+import { createRequire } from 'module';
+var require = createRequire(import.meta['url']);
 
-// src/index.ts
-var src_exports = {};
-__export(src_exports, {
-  pluginTypeCheck: () => pluginTypeCheck
+var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
+  get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
+}) : x)(function(x) {
+  if (typeof require !== "undefined")
+    return require.apply(this, arguments);
+  throw Error('Dynamic require of "' + x + '" is not supported');
 });
-module.exports = __toCommonJS(src_exports);
-var import_shared = require("@rsbuild/shared");
+
+// ../../node_modules/.pnpm/@modern-js+module-tools@2.54.6_eslint@9.6.0_typescript@5.5.2/node_modules/@modern-js/module-tools/shims/esm.js
+import { fileURLToPath } from "url";
+import path from "path";
+
+// src/index.ts
+import fs from "fs";
+import { logger } from "@rsbuild/core";
+import deepmerge from "deepmerge";
+import { reduceConfigs } from "reduce-configs";
+var PLUGIN_TYPE_CHECK_NAME = "rsbuild:type-check";
 var pluginTypeCheck = (options = {}) => {
   return {
-    name: "rsbuild:type-check",
+    name: PLUGIN_TYPE_CHECK_NAME,
     setup(api) {
-      api.modifyBundlerChain(async (chain, { target }) => {
-        const { enable = true, forkTsCheckerOptions } = options;
-        if (!api.context.tsconfigPath || enable === false) {
-          return;
-        }
-        if (Array.isArray(api.context.target) && target !== api.context.target[0]) {
-          return;
-        }
-        const { default: ForkTsCheckerWebpackPlugin } = await import("fork-ts-checker-webpack-plugin");
-        let typescriptPath;
-        try {
-          typescriptPath = require.resolve("typescript", {
-            paths: [api.context.rootPath]
-          });
-        } catch (err) {
-          import_shared.logger.warn(
-            '"typescript" is not found in current project, Type checker will not work.'
+      const NODE_MODULES_REGEX = /[\\/]node_modules[\\/]/;
+      const checkedTsconfig = /* @__PURE__ */ new Map();
+      api.modifyBundlerChain(
+        async (chain, { isProd, environment, CHAIN_ID }) => {
+          const { enable = true, forkTsCheckerOptions } = options;
+          const { tsconfigPath } = environment;
+          if (!tsconfigPath || enable === false) {
+            return;
+          }
+          if (checkedTsconfig.has(tsconfigPath) && checkedTsconfig.get(tsconfigPath) !== environment.name) {
+            return;
+          }
+          checkedTsconfig.set(tsconfigPath, environment.name);
+          let typescriptPath;
+          try {
+            typescriptPath = __require.resolve("typescript", {
+              paths: [api.context.rootPath]
+            });
+          } catch (err) {
+            logger.warn(
+              '"typescript" is not found in current project, Type checker will not work.'
+            );
+            return;
+          }
+          const { default: ForkTsCheckerWebpackPlugin } = await import("fork-ts-checker-webpack-plugin");
+          const { default: json5 } = await import("json5");
+          const { references } = json5.parse(
+            fs.readFileSync(tsconfigPath, "utf-8")
           );
-          return;
-        }
-        const defaultOptions = {
-          typescript: {
-            // avoid OOM issue
-            memoryLimit: 8192,
-            // use tsconfig of user project
-            configFile: api.context.tsconfigPath,
-            typescriptPath
-          },
-          issue: {
-            exclude: [
-              { file: "**/*.(spec|test).ts" },
-              { file: "**/node_modules/**/*" }
-            ]
-          },
-          logger: {
-            log() {
+          const useReference = Array.isArray(references) && references.length > 0;
+          const defaultOptions = {
+            typescript: {
+              // set 'readonly' to avoid emitting tsbuildinfo,
+              // as the generated tsbuildinfo will break fork-ts-checker
+              mode: "readonly",
+              // enable build when using project reference
+              build: useReference,
+              // avoid OOM issue
+              memoryLimit: 8192,
+              // use tsconfig of user project
+              configFile: tsconfigPath,
+              // use typescript of user project
+              typescriptPath
+            },
+            issue: {
+              // ignore types errors from node_modules
+              exclude: [({ file = "" }) => NODE_MODULES_REGEX.test(file)]
             },
-            error(message) {
-              console.error(message.replace(/ERROR/g, "Type Error"));
+            logger: {
+              log() {
+              },
+              error(message) {
+                console.error(message.replace(/ERROR/g, "Type Error"));
+              }
             }
+          };
+          const typeCheckerOptions = reduceConfigs({
+            initial: defaultOptions,
+            config: forkTsCheckerOptions,
+            mergeFn: deepmerge
+          });
+          if (isProd) {
+            logger.info("Type checker is enabled. It may take some time.");
           }
-        };
-        const typeCheckerOptions = (0, import_shared.mergeChainedOptions)({
-          defaults: defaultOptions,
-          options: forkTsCheckerOptions,
-          mergeFn: import_shared.deepmerge
-        });
-        if (api.context.bundlerType === "rspack" && chain.get("mode") === "production") {
-          import_shared.logger.info("Ts checker running...");
-          import_shared.logger.info(
-            "Ts checker is running slowly and will block builds until it is complete, please be patient and wait."
-          );
+          chain.plugin(CHAIN_ID.PLUGIN.TS_CHECKER).use(ForkTsCheckerWebpackPlugin, [typeCheckerOptions]);
         }
-        chain.plugin(import_shared.CHAIN_ID.PLUGIN.TS_CHECKER).use(ForkTsCheckerWebpackPlugin, [typeCheckerOptions]);
-      });
+      );
     }
   };
 };
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
+export {
+  PLUGIN_TYPE_CHECK_NAME,
   pluginTypeCheck
-});
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rsbuild/plugin-type-check",
-  "version": "1.0.0",
+  "version": "1.0.1-beta.0",
   "description": "TS checker plugin of Rsbuild",
   "homepage": "https://rsbuild.dev",
   "repository": {
@@ -9,29 +9,33 @@
     "directory": "packages/plugin-type-check"
   },
   "license": "MIT",
+  "type": "module",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
-      "import": "./dist/index.mjs",
-      "default": "./dist/index.js"
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
     }
   },
-  "main": "./dist/index.js",
+  "main": "./dist/index.cjs",
   "types": "./dist/index.d.ts",
   "files": [
     "dist"
   ],
   "dependencies": {
-    "fork-ts-checker-webpack-plugin": "9.0.0",
-    "@rsbuild/shared": "1.0.0"
+    "deepmerge": "^4.3.1",
+    "fork-ts-checker-webpack-plugin": "9.0.2",
+    "json5": "^2.2.3",
+    "reduce-configs": "^1.0.0",
+    "webpack": "^5.93.0"
   },
   "devDependencies": {
-    "typescript": "^5.3.0",
-    "@rsbuild/core": "1.0.0",
-    "@rsbuild/test-helper": "1.0.0"
+    "typescript": "^5.5.2",
+    "@rsbuild/core": "1.0.1-beta.0",
+    "@scripts/test-helper": "1.0.1-beta.0"
   },
   "peerDependencies": {
-    "@rsbuild/core": "^1.0.0"
+    "@rsbuild/core": "^1.0.1-beta.0"
   },
   "publishConfig": {
     "access": "public",

package/dist/index.mjs

@@ -1,88 +0,0 @@
-var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
-  get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
-}) : x)(function(x) {
-  if (typeof require !== "undefined")
-    return require.apply(this, arguments);
-  throw Error('Dynamic require of "' + x + '" is not supported');
-});
-
-// ../../node_modules/.pnpm/@modern-js+module-tools@2.40.0_typescript@5.3.2/node_modules/@modern-js/module-tools/shims/esm.js
-import { fileURLToPath } from "url";
-import path from "path";
-
-// ../../scripts/require_shims.js
-import { createRequire } from "module";
-global.require = createRequire(import.meta.url);
-
-// src/index.ts
-import {
-  logger,
-  CHAIN_ID,
-  deepmerge,
-  mergeChainedOptions
-} from "@rsbuild/shared";
-var pluginTypeCheck = (options = {}) => {
-  return {
-    name: "rsbuild:type-check",
-    setup(api) {
-      api.modifyBundlerChain(async (chain, { target }) => {
-        const { enable = true, forkTsCheckerOptions } = options;
-        if (!api.context.tsconfigPath || enable === false) {
-          return;
-        }
-        if (Array.isArray(api.context.target) && target !== api.context.target[0]) {
-          return;
-        }
-        const { default: ForkTsCheckerWebpackPlugin } = await import("fork-ts-checker-webpack-plugin");
-        let typescriptPath;
-        try {
-          typescriptPath = __require.resolve("typescript", {
-            paths: [api.context.rootPath]
-          });
-        } catch (err) {
-          logger.warn(
-            '"typescript" is not found in current project, Type checker will not work.'
-          );
-          return;
-        }
-        const defaultOptions = {
-          typescript: {
-            // avoid OOM issue
-            memoryLimit: 8192,
-            // use tsconfig of user project
-            configFile: api.context.tsconfigPath,
-            typescriptPath
-          },
-          issue: {
-            exclude: [
-              { file: "**/*.(spec|test).ts" },
-              { file: "**/node_modules/**/*" }
-            ]
-          },
-          logger: {
-            log() {
-            },
-            error(message) {
-              console.error(message.replace(/ERROR/g, "Type Error"));
-            }
-          }
-        };
-        const typeCheckerOptions = mergeChainedOptions({
-          defaults: defaultOptions,
-          options: forkTsCheckerOptions,
-          mergeFn: deepmerge
-        });
-        if (api.context.bundlerType === "rspack" && chain.get("mode") === "production") {
-          logger.info("Ts checker running...");
-          logger.info(
-            "Ts checker is running slowly and will block builds until it is complete, please be patient and wait."
-          );
-        }
-        chain.plugin(CHAIN_ID.PLUGIN.TS_CHECKER).use(ForkTsCheckerWebpackPlugin, [typeCheckerOptions]);
-      });
-    }
-  };
-};
-export {
-  pluginTypeCheck
-};