README
@fromage/cli-plugin-eslint
eslint plugin for vue-cli
Injected Commands
vue-cli-service lint
Usage: vue-cli-service lint [options] [...files] Options: --format [formatter] specify formatter (default: codeframe) --no-fix do not fix errors --max-errors specify number of errors to make build failed (default: 0) --max-warnings specify number of warnings to make build failed (default: Infinity)
Lints and fixes files. If no specific files are given, it lints all files in
src
andtest
.Other ESLint CLI options are also supported.
Configuration
ESLint can be configured via .eslintrc
or the eslintConfig
field in package.json
.
Lint-on-save during development with eslint-loader
is enabled by default. It can be disabled with the lintOnSave
option in vue.config.js
:
module.exports = {
lintOnSave: false
}
When set to true
, eslint-loader
will emit lint errors as warnings. By default, warnings are only logged to the terminal and does not fail the compilation.
To make lint errors show up in the browser overlay, you can use lintOnSave: 'error'
. This will force eslint-loader
to always emit errors. this also means lint errors will now cause the compilation to fail.
Alternatively, you can configure the overlay to display both warnings and errors:
// vue.config.js
module.exports = {
devServer: {
overlay: {
warnings: true,
errors: true
}
}
}
When lintOnSave
is a truthy value, eslint-loader
will be applied in both development and production. If you want to disable eslint-loader
during production build, you can use the following config:
// vue.config.js
module.exports = {
lintOnSave: process.env.NODE_ENV !== 'production'
}
Installing in an Already Created Project
vue add eslint
Injected webpack-chain Rules
config.module.rule('eslint')
config.module.rule('eslint').use('eslint-loader')