A Vite plugin that can run TypeScript, VLS, vue-tsc, ESLint in worker thread.

• ⚡️ Speeds up TypeScript, VLS, etc. checkers by running in worker thread in serve mode
• 🌈 Works good with vanilla JS / TS, React, Vue2, Vue3
• ❄️ Prompt errors in Vite HMR overlay and terminal console
• 🌗 Support both serve and build mode

History version documentations 0.1 | 0.2

Install plugin.

yarn add 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 })], // e.g. use TypeScript check
}

Open localhost page and start development 🚀.

It's recommended to open browser for a better terminal display, see #27.

Detailed configuration is 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. Make sure vls is installed as a peer dependency, plugin will use vls as the check server.

yarn add vls -D

2. Add vls field to plugin config.

module.exports = {
  plugins: [checker({ vls: true })],
}

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 })],
}

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

2. Add eslint field to plugin config.

export default {
  plugins: [
    checker({
      eslint: {
        files: ['./src'],
        extensions: '.ts',
      },
    }),
  ],
}

Plugin can accept an object configuration.

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

For each checker config fields below:

• If the filed is not falsy. The corresponding checker server should be installed as a peer dependency.
• Set to true to use checker with it's default values
• Leave the field blank or a falsy value to disable the checker
• Enable with an object advanced config

coming soon.

coming soon.

Run projects in playground/* to try it out.

pnpm i
npm run build
cd ./playground/<ONE_EXAMPLE>   # ts / vls / vue-tsc / vanilla ts
npm run dev                     # test serve
npm run build                   # test build

MIT License © 2021 fi3ework