@rsbuild/plugin-type-check 1.1.0-beta.1 → 1.2.0

package/README.md

@@ -12,7 +12,7 @@ An Rsbuild plugin to run TypeScript type checker in a separate process.
 
 ## Introduction
 
-This plugin internally integrates with [ts-checker-rspack-plugin](https://github.com/rspack-team/ts-checker-rspack-plugin).
+This plugin internally integrates with [ts-checker-rspack-plugin](https://github.com/rspack-contrib/ts-checker-rspack-plugin).
 
 The type checking logic of `ts-checker-rspack-plugin` is similar to the native `tsc` command of TypeScript. It automatically reads the configuration options from `tsconfig.json` and can also be modified via the configuration options provided by the Type Check plugin.
 
@@ -96,9 +96,9 @@ pluginTypeCheck({
 });
 ```
 
-### forkTsCheckerOptions
+### tsCheckerOptions
 
-To modify the options of `ts-checker-rspack-plugin`, please refer to [ts-checker-rspack-plugin - README](https://github.com/rspack-team/ts-checker-rspack-plugin#readme) to learn about available options.
+Modify the options of `ts-checker-rspack-plugin`, please refer to [ts-checker-rspack-plugin - README](https://github.com/rspack-contrib/ts-checker-rspack-plugin#readme) to learn about available options.
 
 - **Type:** `Object | Function`
 - **Default:**
@@ -136,11 +136,11 @@ const defaultOptions = {
 
 #### Object Type
 
-When the value of `forkTsCheckerOptions` is an object, it will be deeply merged with the default configuration.
+When the value of `tsCheckerOptions` is an object, it will be deeply merged with the default configuration.
 
 ```ts
 pluginTypeCheck({
-  forkTsCheckerOptions: {
+  tsCheckerOptions: {
     issue: {
       exclude: [({ file = "" }) => /[\\/]some-folder[\\/]/.test(file)],
     },
@@ -150,11 +150,11 @@ pluginTypeCheck({
 
 #### Function Type
 
-When the value of `forkTsCheckerOptions` is a function, the default configuration will be passed as the first argument. You can directly modify the configuration object or return an object as the final configuration.
+When the value of `tsCheckerOptions` is a function, the default configuration will be passed as the first argument. You can directly modify the configuration object or return an object as the final configuration.
 
 ```ts
 pluginTypeCheck({
-  forkTsCheckerOptions(options) {
+  tsCheckerOptions(options) {
     options.async = false;
     return options;
   },
@@ -169,7 +169,7 @@ For example, the type mismatch error can be excluded using `code: 'TS2345'`:
 
 ```ts
 pluginTypeCheck({
-  forkTsCheckerOptions: {
+  tsCheckerOptions: {
     issue: {
       // Ignore "Argument of type 'string' is not assignable to parameter of type 'number'.ts(2345)"
       exclude: [{ code: "TS2345" }],
@@ -182,7 +182,7 @@ Or exclude files under `/some-folder/` using `file`:
 
 ```ts
 pluginTypeCheck({
-  forkTsCheckerOptions: {
+  tsCheckerOptions: {
     issue: {
       exclude: [({ file = "" }) => /[\\/]some-folder[\\/]/.test(file)],
     },
@@ -190,6 +190,20 @@ pluginTypeCheck({
 });
 ```
 
+#### Disable type errors from the error overlay
+
+By default, type errors will be reported to Dev Server and displayed in the Rsbuild error overlay in development mode.
+
+If you don't want type errors to be displayed in the error overlay, you can disable it by setting `devServer: false`:
+
+```ts
+pluginTypeCheck({
+  tsCheckerOptions: {
+    async: true,
+    devServer: false,
+  },
+});
+```
 ## Notes
 
 - If you have enabled `ts-loader` in your project and manually configured `compileOnly: false`, please disable the Type Check plugin to avoid duplicate type checking.

package/dist/index.cjs

@@ -1,14 +1,17 @@
 "use strict";
+const __rslib_import_meta_url__ = /*#__PURE__*/ function() {
+    return 'undefined' == typeof document ? new (require('url'.replace('', ''))).URL('file:' + __filename).href : document.currentScript && document.currentScript.src || new URL('main.js', document.baseURI).href;
+}();
 // The require scope
 var __webpack_require__ = {};
 /************************************************************************/ // webpack/runtime/compat_get_default_export
 (()=>{
     // getDefaultExport function for compatibility with non-ESM modules
-    __webpack_require__.n = function(module1) {
-        var getter = module1 && module1.__esModule ? function() {
-            return module1['default'];
+    __webpack_require__.n = function(module) {
+        var getter = module && module.__esModule ? function() {
+            return module['default'];
         } : function() {
-            return module1;
+            return module;
         };
         __webpack_require__.d(getter, {
             a: getter
@@ -61,9 +64,7 @@ const external_json5_namespaceObject = require("json5");
 var external_json5_default = /*#__PURE__*/ __webpack_require__.n(external_json5_namespaceObject);
 const external_reduce_configs_namespaceObject = require("reduce-configs");
 const external_ts_checker_rspack_plugin_namespaceObject = require("ts-checker-rspack-plugin");
-const src_require = (0, external_node_module_namespaceObject.createRequire)(/*#__PURE__*/ function() {
-    return 'undefined' == typeof document ? new (module.require('url'.replace('', ''))).URL('file:' + __filename).href : document.currentScript && document.currentScript.src || new URL('main.js', document.baseURI).href;
-}());
+const src_require = (0, external_node_module_namespaceObject.createRequire)(__rslib_import_meta_url__);
 const PLUGIN_TYPE_CHECK_NAME = 'rsbuild:type-check';
 const pluginTypeCheck = (options = {})=>({
         name: PLUGIN_TYPE_CHECK_NAME,
@@ -72,7 +73,10 @@ const pluginTypeCheck = (options = {})=>({
             const checkedTsconfig = new Map();
             api.modifyBundlerChain(async (chain, { isProd, environment, CHAIN_ID })=>{
                 const { enable = true, forkTsCheckerOptions } = options;
+                let { tsCheckerOptions } = options;
                 const { tsconfigPath } = environment;
+                // compatible with the legacy option
+                if (void 0 === tsCheckerOptions && void 0 !== forkTsCheckerOptions) tsCheckerOptions = forkTsCheckerOptions;
                 if (!tsconfigPath || false === enable) return;
                 // If there are identical tsconfig.json files,
                 // apply type checker only once to avoid duplicate checks.
@@ -122,20 +126,20 @@ const pluginTypeCheck = (options = {})=>({
                         }
                     }
                 };
-                const typeCheckerOptions = (0, external_reduce_configs_namespaceObject.reduceConfigs)({
+                const mergedOptions = (0, external_reduce_configs_namespaceObject.reduceConfigs)({
                     initial: defaultOptions,
-                    config: forkTsCheckerOptions,
+                    config: tsCheckerOptions,
                     mergeFn: external_deepmerge_default()
                 });
                 if (isProd) core_namespaceObject.logger.info('Type checker is enabled. It may take some time.');
                 chain.plugin(CHAIN_ID.PLUGIN.TS_CHECKER).use(external_ts_checker_rspack_plugin_namespaceObject.TsCheckerRspackPlugin, [
-                    typeCheckerOptions
+                    mergedOptions
                 ]);
             });
         }
     });
 var __webpack_export_target__ = exports;
-for(var i in __webpack_exports__)__webpack_export_target__[i] = __webpack_exports__[i];
+for(var __webpack_i__ in __webpack_exports__)__webpack_export_target__[__webpack_i__] = __webpack_exports__[__webpack_i__];
 if (__webpack_exports__.__esModule) Object.defineProperty(__webpack_export_target__, '__esModule', {
     value: true
 });

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { type RsbuildPlugin } from '@rsbuild/core';
 import { type ConfigChain } from 'reduce-configs';
 import { TsCheckerRspackPlugin } from 'ts-checker-rspack-plugin';
-type ForkTsCheckerOptions = NonNullable<ConstructorParameters<typeof TsCheckerRspackPlugin>[0]>;
+type TsCheckerOptions = NonNullable<ConstructorParameters<typeof TsCheckerRspackPlugin>[0]>;
 export type PluginTypeCheckerOptions = {
     /**
      * Whether to enable TypeScript type checking.
@@ -12,7 +12,11 @@ export type PluginTypeCheckerOptions = {
      * To modify the options of `ts-checker-rspack-plugin`.
      * @see https://github.com/rspack-contrib/ts-checker-rspack-plugin#readme
      */
-    forkTsCheckerOptions?: ConfigChain<ForkTsCheckerOptions>;
+    tsCheckerOptions?: ConfigChain<TsCheckerOptions>;
+    /**
+     * @deprecated use `tsCheckerOptions` instead.
+     */
+    forkTsCheckerOptions?: ConfigChain<TsCheckerOptions>;
 };
 export declare const PLUGIN_TYPE_CHECK_NAME = "rsbuild:type-check";
 export declare const pluginTypeCheck: (options?: PluginTypeCheckerOptions) => RsbuildPlugin;

package/dist/index.js

@@ -14,7 +14,10 @@ const pluginTypeCheck = (options = {})=>({
             const checkedTsconfig = new Map();
             api.modifyBundlerChain(async (chain, { isProd, environment, CHAIN_ID })=>{
                 const { enable = true, forkTsCheckerOptions } = options;
+                let { tsCheckerOptions } = options;
                 const { tsconfigPath } = environment;
+                // compatible with the legacy option
+                if (void 0 === tsCheckerOptions && void 0 !== forkTsCheckerOptions) tsCheckerOptions = forkTsCheckerOptions;
                 if (!tsconfigPath || false === enable) return;
                 // If there are identical tsconfig.json files,
                 // apply type checker only once to avoid duplicate checks.
@@ -64,14 +67,14 @@ const pluginTypeCheck = (options = {})=>({
                         }
                     }
                 };
-                const typeCheckerOptions = (0, __WEBPACK_EXTERNAL_MODULE_reduce_configs__.reduceConfigs)({
+                const mergedOptions = (0, __WEBPACK_EXTERNAL_MODULE_reduce_configs__.reduceConfigs)({
                     initial: defaultOptions,
-                    config: forkTsCheckerOptions,
+                    config: tsCheckerOptions,
                     mergeFn: __WEBPACK_EXTERNAL_MODULE_deepmerge__["default"]
                 });
                 if (isProd) __WEBPACK_EXTERNAL_MODULE__rsbuild_core__.logger.info('Type checker is enabled. It may take some time.');
                 chain.plugin(CHAIN_ID.PLUGIN.TS_CHECKER).use(__WEBPACK_EXTERNAL_MODULE_ts_checker_rspack_plugin__.TsCheckerRspackPlugin, [
-                    typeCheckerOptions
+                    mergedOptions
                 ]);
             });
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rsbuild/plugin-type-check",
-  "version": "1.1.0-beta.1",
+  "version": "1.2.0",
   "repository": "https://github.com/rspack-contrib/rsbuild-plugin-type-check",
   "license": "MIT",
   "type": "module",
@@ -36,22 +36,22 @@
   },
   "dependencies": {
     "deepmerge": "^4.3.1",
-    "ts-checker-rspack-plugin": "^1.0.0",
+    "ts-checker-rspack-plugin": "^1.1.0",
     "json5": "^2.2.3",
-    "reduce-configs": "^1.0.0"
+    "reduce-configs": "^1.1.0"
   },
   "devDependencies": {
     "@biomejs/biome": "^1.9.4",
-    "@playwright/test": "^1.48.2",
-    "@rsbuild/core": "^1.0.19",
-    "@rslib/core": "^0.0.16",
+    "@playwright/test": "^1.49.0",
+    "@rsbuild/core": "^1.1.6",
+    "@rslib/core": "^0.1.1",
     "@types/fs-extra": "^11.0.4",
-    "@types/node": "^22.8.6",
+    "@types/node": "^22.10.1",
     "fs-extra": "^11.2.0",
     "nano-staged": "^0.8.0",
-    "playwright": "^1.48.2",
+    "playwright": "^1.49.0",
     "simple-git-hooks": "^2.11.1",
-    "typescript": "^5.6.3"
+    "typescript": "^5.7.2"
   },
   "peerDependencies": {
     "@rsbuild/core": "1.x"
@@ -61,7 +61,7 @@
       "optional": true
     }
   },
-  "packageManager": "pnpm@9.12.3",
+  "packageManager": "pnpm@9.14.4",
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org/"