A Vite plugin that runs TypeScript, VLS, vue-tsc and other checkers in worker thread.

• ⚡️ 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

Install plugin.

npm i vite-plugin-checker -D

Add it to Vite config file.

// vite.config.js
import Checker from 'vite-plugin-checker'

export default {
  plugins: [Checker({ typescript: true })],
}

See detail options in advanced config section.

1. Make sure typescript is installed as a peer dependency.

2. Add typescript field to plugin config.

export default {
  plugins: [Checker({ typescript: true } /** TS options */)],
}

1. Install VLS checker.

npm i vite-plugin-checker-vls -D

2. Add vls field to plugin config.

import Checker from 'vite-plugin-checker'
import VlsChecker from 'vite-plugin-checker-vls'

module.exports = {
  plugins: [
    Checker({
      vls: VlsChecker(/** advanced VLS options */),
    }),
  ],
}

Only support checking in build mode since vue-tsc doesn't support watch mode for now.

1. Make sure vue-tsc is installed as a peer dependency.

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, you need to install @vue/runtime-dom by yourself.

export default {
  plugins: [Checker({ vueTsc: true })],
}

Plugin can accept an object configuration.

export default {
  plugins: [Checker(config /** Object config below */)],
}

• Set to true to use checker with all default values
• Leave the field blank or set to false to disable the checker
• Enable with an object config (all object keys are optional)

• type: VlsChecker instance.

e.g.

import Checker from 'vite-plugin-checker'
import VlsChecker from 'vite-plugin-checker-vls'

module.exports = {
  plugins: [
    Checker({
      vls: VlsChecker(/** No options for now */),
    }),
  ],
}

• type: boolean

Run projects in playground/* to try it out.

pnpm i
npm run build
cd ./playground/<ONE_EXAMPLE> # react / vls / vue-tsc
npm run dev                 # for development
npm run build               # for build

MIT License © 2021 fi3ework