Vite 中文文档

vite-plugin-eslint


ESLint plugin for vite.

Install


  1. ``` shell
  2. npm install eslint vite-plugin-eslint --save-dev
  3. # or
  4. yarn add eslint vite-plugin-eslint -D
  5. ```

Usage


  1. ``` js
  2. import { defineConfig } from 'vite'
  3. import eslint from 'vite-plugin-eslint'

  5. export default defineConfig({
  6.   plugins: [eslint()]
  7. })
  8. ```

If you do not want the plugin to break dev, you can configure the plugin this way:

  1. ``` js
  2. import { defineConfig } from 'vite';
  3. import eslint from 'vite-plugin-eslint';

  5. export default defineConfig({
  6.   plugins: [
  7.     { // default settings on build (i.e. fail on error)
  8.       ...eslint(),
  9.       apply: 'build',
  10.     },
  11.     { // do not fail on serve (i.e. local development)
  12.       ...eslint({
  13.         failOnWarning: false,
  14.         failOnError: false,
  15.       }),
  16.       apply: 'serve',
  17.       enforce: 'post'
  18.     }
  19.   ],
  20. });
  21. ```

Options


You can pass eslint options.

cache


Type: boolean
Default: false

Decrease execution time, Beta Cache now correctly recognizes file changes, you can try it out.

fix


Type: boolean
Default: false

Auto fix source code.

eslintPath


Type: string
Default: eslint

Path to eslint instance that will be used for linting.

lintOnStart


Type: boolean
Default: false

Check all matching files on project startup, too slow, turn on discreetly.

include


Type: string | string[]
Default: `['*/.js', '*/.jsx', '*/.ts', '*/.tsx', '*/.vue', '*/.svelte']`

A single file, or array of files, to include when linting.

exclude


Type: string | string[]
Default: `['/node_modules/']`

A single file, or array of files, to exclude when linting.

formatter


Type: string | ESLint.Formatter['format']
Default: stylish

Custom error formatter or the name of a built-in formatter.

emitWarning


Type: boolean
Default: true

The warings found will be printed.

emitError


Type: boolean
Default: true

The errors found will be printed.

failOnWarning


Type: boolean
Default: false

Will cause the module build to fail if there are any warnings, based on emitWarning.

failOnError


Type: boolean
Default: true

Will cause the module build to fail if there are any errors, based on emitError.

License


MIT