vite-plugin-checker

What is vite-plugin-checker?

vite-plugin-checker is a Vite plugin that provides various types of code checking functionalities, such as TypeScript, VLS (Vetur Language Server), and ESLint. It helps developers catch errors and enforce coding standards during the development process.

What are vite-plugin-checker's main functionalities?

TypeScript Checking

This feature enables TypeScript checking in your Vite project. It ensures that TypeScript errors are caught during the development process.

import { defineConfig } from 'vite';
import Checker from 'vite-plugin-checker';

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

VLS (Vetur Language Server) Checking

This feature integrates VLS (Vetur Language Server) checking into your Vite project, which is particularly useful for Vue.js projects. It helps catch errors and enforce coding standards for Vue components.

import { defineConfig } from 'vite';
import Checker from 'vite-plugin-checker';

export default defineConfig({
  plugins: [
    Checker({ vls: true })
  ]
});

ESLint Checking

This feature enables ESLint checking in your Vite project. It helps enforce coding standards and catch linting errors in your JavaScript/TypeScript code.

import { defineConfig } from 'vite';
import Checker from 'vite-plugin-checker';

export default defineConfig({
  plugins: [
    Checker({ eslint: { files: ['./src'] } })
  ]
});

Other packages similar to vite-plugin-checker

vite-plugin-eslint

vite-plugin-eslint is a Vite plugin that specifically focuses on integrating ESLint into your Vite project. It provides similar ESLint checking functionalities as vite-plugin-checker but does not offer TypeScript or VLS checking.

vite-plugin-ts-checker

vite-plugin-ts-checker is a Vite plugin that focuses on TypeScript type checking. It provides similar TypeScript checking functionalities as vite-plugin-checker but does not offer ESLint or VLS checking.

vite-plugin-vue

vite-plugin-vue is a Vite plugin that provides Vue.js support, including VLS (Vetur Language Server) integration. It offers similar VLS checking functionalities as vite-plugin-checker but does not provide TypeScript or ESLint checking.

README

vite-plugin-checker

A Vite plugin that runs TypeScript / Vue / ... checks in worker thread.

Features

• 📦 Out of the box
• 🌗 Support React & Vue2/3
• 🕸 Vite HMR overlay
• 🛠 Support serve & build mode

Getting Started

Install plugin

npm i vite-plugin-checker -D

Config vite.config.js

Add vite-plugin-checker to plugin filed of Vite config file.

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

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

Framework related configuration

See detailed configuration in advanced config section.

React / Vanilla TypeScript

• Make sure typescript is installed as a peer dependency.

• Modify config file

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

Vue (with Vetur / VLS)

• Install VLS checker preset.

npm i vite-plugin-checker-vls -D

• Modify config file

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

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

Vue (with Volar / vue-tsc)

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

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

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

Advanced config

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

The plugin config can be accept following fields

config.overlay

field	Type	Default value	Description
overlay	boolean	Same as server.hmr.overlay	Show overlay when has TypeScript error

config.enableBuild

field	Type	Default value	Description
enableBuild	boolean	true	Enable checking in build mode

config.typescript

• 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)

field	Type	Default value	Description
root	string	Vite config root	Root path to find tsconfig file
tsconfigPath	string	"tsconfig.json"	Relative tsconfig path to root

config.vls

import { VlsChecker } from 'vite-plugin-checker-vls'

// plugin config
{ vls?: VlsChecker() }

config.vueTsc

// plugin config
{ vueTsc?: boolean }

Examples

Run projects in examples/* to try it out.

pnpm i
cd ./examples/<ONE_EXAMPLE>
npm run dev   # for development
npm run build # for build

License

MIT

Changelog

0.1.0-beta.1 (2021-06-10)

Bug Fixes

• checker uses config right (62e8f5c)