Skip to content

Commit

Permalink
perf: integrate ts-checker-rspack-plugin
Browse files Browse the repository at this point in the history
  • Loading branch information
chenjiahan committed Nov 24, 2024
1 parent fa1ea42 commit 956f5da
Show file tree
Hide file tree
Showing 4 changed files with 94 additions and 689 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ An Rsbuild plugin to run TypeScript type checker in a separate process.

## Introduction

This plugin internally integrates with [fork-ts-checker-webpack-plugin](https://github.com/TypeStrong/fork-ts-checker-webpack-plugin).
This plugin internally integrates with [ts-checker-rspack-plugin](https://github.com/rspack-team/ts-checker-rspack-plugin).

The type checking logic of `fork-ts-checker-webpack-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.
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.

The behavior of the plugin differs in the development and production builds:

Expand Down Expand Up @@ -98,7 +98,7 @@ pluginTypeCheck({

### forkTsCheckerOptions

To modify the options of `fork-ts-checker-webpack-plugin`, please refer to [fork-ts-checker-webpack-plugin - README](https://github.com/TypeStrong/fork-ts-checker-webpack-plugin#readme) to learn about available options.
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.

- **Type:** `Object | Function`
- **Default:**
Expand All @@ -107,7 +107,7 @@ To modify the options of `fork-ts-checker-webpack-plugin`, please refer to [fork
const defaultOptions = {
typescript: {
// set 'readonly' to avoid emitting tsbuildinfo,
// as the generated tsbuildinfo will break fork-ts-checker
// as the generated tsbuildinfo will break ts-checker-rspack-plugin
mode: "readonly",
// enable build when using project reference
build: useReference,
Expand Down Expand Up @@ -193,7 +193,7 @@ pluginTypeCheck({
## 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.
- Some errors will be displayed as warnings in IDEs such as VS Code, but they will still be displayed as errors in the `fork-ts-checker-webpack-plugin` check. For details, please refer to: [Why are some errors reported as warnings?](https://code.visualstudio.com/docs/typescript/typescript-compiling#_why-are-some-errors-reported-as-warnings).
- Some errors will be displayed as warnings in IDEs such as VS Code, but they will still be displayed as errors in the `ts-checker-rspack-plugin` check. For details, please refer to: [Why are some errors reported as warnings?](https://code.visualstudio.com/docs/typescript/typescript-compiling#_why-are-some-errors-reported-as-warnings).

## Performance Optimization

Expand All @@ -210,7 +210,7 @@ For example, properly configuring the `include` and `exclude` scopes in `tsconfi

## Vue Components

`fork-ts-checker-webpack-plugin` does not support checking TypeScript code in `.vue` components. You can check for type issues in `.vue` files in the following ways:
`ts-checker-rspack-plugin` does not support checking TypeScript code in `.vue` components. You can check for type issues in `.vue` files in the following ways:

1. Install the [vue-tsc](https://github.com/vuejs/language-tools/tree/master/packages/tsc) package, which provides the ability to check types in `.vue` files.

Expand Down
5 changes: 2 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,9 @@
},
"dependencies": {
"deepmerge": "^4.3.1",
"fork-ts-checker-webpack-plugin": "9.0.2",
"ts-checker-rspack-plugin": "1.0.0-beta.1",
"json5": "^2.2.3",
"reduce-configs": "^1.0.0",
"webpack": "^5.96.0"
"reduce-configs": "^1.0.0"
},
"devDependencies": {
"@biomejs/biome": "^1.9.4",
Expand Down
Loading

0 comments on commit 956f5da

Please sign in to comment.