User Guide

💿 Installation

Via vue-cli (Recommended):

vue add @vue/cli-plugin-eslint

Via npm:

npm install --save-dev eslint eslint-plugin-vue

Via yarn:

yarn add -D eslint eslint-plugin-vue


  • ESLint v5.0.0 or later
  • Node.js v6.5.0 or later

📖 Usage


Use .eslintrc.* file to configure rules. See also:

Example .eslintrc.js:

module.exports = {
  extends: [
    // add more generic rulesets here, such as:
    // 'eslint:recommended',
  rules: {
    // override/add rules settings here, such as:
    // 'vue/no-unused-vars': 'error'

See the rule list to get the extends & rules that this plugin provides.

Reporting rules

By default all rules from base and essential categories report ESLint errors. Other rules - because they're not covering potential bugs in the application report warnings. What does it mean? By default - nothing, but if you want - you can set up a treshold and break the build after a certain amount of warnings, instead of any. More informations here.

Running ESLint from command line

If you want to run eslint from command line, make sure you include the .vue extension using the --ext option or a glob pattern because ESLint targets only .js files by default.


eslint --ext .js,.vue src
eslint "src/**/*.{js,vue}"


If you installed @vue/cli-plugin-eslint you should have lint script added in your package.json. That means you can just run yarn lint or npm run lint.

How to use custom parser?

If you want to use custom parsers such as babel-eslint or typescript-eslint-parser, you have to use parserOptions.parser option instead of parser option. Because this plugin requires vue-eslint-parser to parse .vue files, so this plugin doesn't work if you overwrote parser option.

- "parser": "babel-eslint",
  "parserOptions": {
+     "parser": "babel-eslint",
      "sourceType": "module"

How ESLint detects components?

All component-related rules are being applied to code that passes any of the following checks:

  • Vue.component() expression
  • Vue.extend() expression
  • Vue.mixin() expression
  • export default {} in .vue or .jsx file

If you however want to take advantage of our rules in any of your custom objects that are Vue components, you might need to use special comment // @vue/component that marks object in the next line as a Vue component in any file, e.g.:

// @vue/component
const CustomComponent = {
  name: 'custom-component',
  template: '<div></div>'
Vue.component('AsyncComponent', (resolve, reject) => {
  setTimeout(() => {
    // @vue/component
      name: 'async-component',
      template: '<div></div>'
  }, 500)

Disabling rules via <!-- eslint-disable -->

You can use <!-- eslint-disable -->-like HTML comments in <template> of .vue files to disable a certain rule temporarily.

For example:

  <!-- eslint-disable-next-line vue/max-attributes-per-line -->
  <div a="1" b="2" c="3" d="4">

If you want to disallow eslint-disable functionality in <template>, disable vue/comment-directive rule.

💻 Editor integrations

Visual Studio Code

Use dbaeumer.vscode-eslint extension that Microsoft provides officially.

You have to configure the eslint.validate option of the extension to check .vue files because the extension targets only *.js or *.jsx files by default.

Example .vscode/settings.json:

  "eslint.validate": [
    { "language": "vue", "autoFix": true }

If you use Vetur plugin, set "vetur.validation.template": false to avoid default Vetur template validation. Check out vetur documentation for more info.

Sublime Text

Use SublimeLinter-eslint extension that SublimeLinter provides for eslint.

You have to open command-palette via Cmd/Ctrl+Shift+P and type Preferences: SublimeLinter Settings, paste to the config on the right side:

  "linters": {
    "eslint": {
      "selector": "text.html.vue, source.js - meta.attribute-with-value"

Atom editor

You need to go into Settings -> Packages -> linter-eslint, under the option "List of scopes to run eslint on", add text.html.vue. You may need to restart Atom.

IntelliJ IDEA / JetBrains WebStorm

In the Settings/Preferences dialog (Cmd+,/Ctrl+Alt+S), choose JavaScript under Languages and Frameworks and then choose ESLint under Code Quality Tools. On the ESLint page that opens, select the Enable checkbox.

If your ESLint configuration is updated (manually or from your version control), open it in the editor and choose Apply ESLint Code Style Rules on the context menu.

read more: JetBrains - ESLint


What is the "Use the latest vue-eslint-parser" error?

The most rules of eslint-plugin-vue require vue-eslint-parser to check <template> ASTs.

Make sure you have one of the following settings in your .eslintrc:

  • "extends": ["plugin:vue/recommended"]
  • "extends": ["plugin:vue/base"]

If you already use other parser (e.g. "parser": "babel-eslint"), please move it into parserOptions, so it doesn't collide with the vue-eslint-parser used by this plugin's configuration:

- "parser": "babel-eslint",
  "parserOptions": {
+     "parser": "babel-eslint",
      "ecmaVersion": 2017,
      "sourceType": "module"

See also: "Use together with custom parsers" section.

Why doesn't it work on .vue file?

  1. Make sure you don't have eslint-plugin-html in your config. The eslint-plugin-html extracts the content from <script> tags, but eslint-plugin-vue requires <script> tags and <template> tags in order to distinguish template and script in single file components.
  "plugins": [
-   "html"
  1. Make sure your tool is set to lint .vue files.
  • CLI targets only .js files by default. You have to specify additional extensions by --ext option or glob patterns. E.g. eslint "src/**/*.{js,vue}" or eslint src --ext .vue. If you use @vue/cli-plugin-eslint and the vue-cli-service lint command - you don't have to worry about it.
  • If you are having issues with configuring editor please read editor integrations
Last Updated: 1/9/2019, 10:35:04 AM