vite-plugin-checker
Advanced tools
Comparing version 0.1.0-beta.3 to 0.1.0
@@ -5,2 +5,4 @@ # Changelog | ||
## [0.1.0](https://github.com/fi3ework/vite-plugin-checker/compare/v0.1.0-beta.3...v0.1.0) (2021-06-14) | ||
## [0.1.0-beta.3](https://github.com/fi3ework/vite-plugin-checker/compare/v0.1.0-beta.2...v0.1.0-beta.3) (2021-06-13) | ||
@@ -7,0 +9,0 @@ |
{ | ||
"name": "vite-plugin-checker", | ||
"version": "0.1.0-beta.3", | ||
"version": "0.1.0", | ||
"description": "Vite plugin that runs TypeScript type checker on a separate process.", | ||
@@ -5,0 +5,0 @@ "main": "lib/main.js", |
# vite-plugin-checker | ||
A Vite plugin that runs TypeScript / Vue / ... checks in worker thread. | ||
A Vite plugin that runs TypeScript, VLS, vue-tsc and other checkers in worker thread. | ||
## Features | ||
- 📦 Out of the box | ||
- 🌗 Support React & Vue2/3 | ||
- 🕸 Vite HMR overlay | ||
- 🛠 Support serve & build mode | ||
- ⚡️ Speeds up TypeScirpt, VLS, etc. checkers by running in worker thread in serve mode | ||
- 🌈 Works good with vanilla TypeScript, React, Vue2, Vue3 | ||
- ❄️ Prompt errors in Vite HMR overlay and terminal console | ||
- 🌗 Support serve and build mode | ||
@@ -18,3 +18,3 @@ <p align="center"> | ||
### Install plugin | ||
Install plugin. | ||
@@ -25,6 +25,4 @@ ```bash | ||
### Config `vite.config.js` | ||
Add it to Vite config file. | ||
Add `vite-plugin-checker` to plugin filed of Vite config file. | ||
```ts | ||
@@ -39,5 +37,5 @@ // vite.config.js | ||
## Framework configuration | ||
## Configuration | ||
> See detailed configuration in [advanced config](#advanced-config) section. | ||
> See detail options in [advanced config](#advanced-config) section. | ||
@@ -48,7 +46,7 @@ ### React / Vanilla TypeScript | ||
2. Modify Vite config file. | ||
2. Add `typescript` field to plugin config. | ||
```js | ||
export default { | ||
plugins: [Checker({ typescript: true })], | ||
plugins: [Checker({ typescript: true } /** TS options */)], | ||
} | ||
@@ -59,3 +57,3 @@ ``` | ||
1. Install [VLS](https://www.npmjs.com/package/vls) checker checker. | ||
1. Install [VLS](https://www.npmjs.com/package/vls) checker. | ||
@@ -66,3 +64,3 @@ ```bash | ||
2. Modify Vite config file. | ||
2. Add `vls` field to plugin config. | ||
@@ -76,3 +74,3 @@ ```js | ||
Checker({ | ||
vls: VlsChecker(/** VLS options */), | ||
vls: VlsChecker(/** advanced VLS options */), | ||
}), | ||
@@ -89,4 +87,6 @@ ], | ||
2. The type check is powered by `vue-tsc` so it supports Vue2 according to the [documentation](https://github.com/johnsoncodehk/volar#using), you need to install `@vue/runtime-dom` by yourself. | ||
2. Add `vueTsc` field to plugin config. | ||
3. (Optional) The type check is powered by `vue-tsc` so it supports Vue2 according to the [documentation](https://github.com/johnsoncodehk/volar#using), you need to install `@vue/runtime-dom` by yourself. | ||
```js | ||
@@ -168,2 +168,3 @@ export default { | ||
pnpm i | ||
npm run build | ||
cd ./examples/<ONE_EXAMPLE> # react / vls / vue-tsc | ||
@@ -176,2 +177,2 @@ npm run dev # for development | ||
MIT | ||
MIT License © 2021 [fi3ework](https://github.com/fi3ework) |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
43928
169