Getting Started

1. Install plugin (pnpm recommended 🚀).

   pnpm add vite-plugin-checker -D

   If you are using Yarn or NPM

   yarn add vite-plugin-checker -D
   npm i vite-plugin-checker -D

2. Add plugin to Vite config file and config the checker you need. We add TypeScript here as an example. See all available checkers here.

   // vite.config.js
   import checker from 'vite-plugin-checker'
   export default {
     plugins: [
       checker({
         // e.g. use TypeScript check
         typescript: true,
       }),
     ],
   }

TIP

If you'd prefer to not run the checkers during unit testing with Vitest, you can alter the config based on that. Example:

// vite.config.js
import checker from 'vite-plugin-checker'
export default {
  plugins: [!process.env.VITEST ? checker({ typescript: true }) : undefined],
}

3. You're all set. Open localhost page and start development 🚀.

TIP

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

WARNING

server.ws.on is introduced to Vite in 2.6.8. vite-plugin-checker relies on server.ws.on to make overlay visible after opening a new browser tab.