Skip to content

Latest commit

 

History

History
285 lines (211 loc) · 9.11 KB

README.md

File metadata and controls

285 lines (211 loc) · 9.11 KB
Raw

User Guide

💿 Installation

Via vue-cli (Recommended):

vue add @vue/cli-plugin-eslint

Via npm:

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

Via yarn:

yarn add -D eslint eslint-plugin-vue@next

::: tip Requirements

  • ESLint v6.0.0 and above
  • Node.js v8.10.0 and above :::

📖 Usage

Configuration

Use .eslintrc.* file to configure rules. See also: https://eslint.org/docs/user-guide/configuring.

Example .eslintrc.js:

module.exports = {
  extends: [
    // add more generic rulesets here, such as:
    // 'eslint:recommended',
    'plugin:vue/vue3-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.

:::warning 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 information here. :::

Running ESLint from the command line

If you want to run eslint from the 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.

Examples:

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

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

How to use a custom parser?

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

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

How does ESLint detect components?

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

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

However, if you want to take advantage of the rules in any of your custom objects that are Vue components, you might need to use the special comment // @vue/component that marks an 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
    resolve({
      name: 'async-component',
      template: '<div></div>'
    })
  }, 500)
})

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

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

For example:

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

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

💻 Editor integrations

Visual Studio Code

Use the 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": [
    "javascript",
    "javascriptreact",
    "vue"
  ]
}

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

Sublime Text

Use Package Control to install SublimeLinter and its ESLint extension SublimeLinter-eslint.

In the menu go to Preferences > Package Settings > SublimeLinter > Settings and paste in this:

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

Atom editor

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 in the context menu.

read more: JetBrains - ESLint

❓ FAQ

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

Most eslint-plugin-vue rules require vue-eslint-parser to check <template> ASTs.

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

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

If you already use another 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",
+ "parser": "vue-eslint-parser",
  "parserOptions": {
+     "parser": "babel-eslint",
      "ecmaVersion": 2020,
      "sourceType": "module"
  }

See also: "How to use a custom parser?" section.

Why doesn't it work on .vue files?

  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": [
    "vue",
-   "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 with the --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

Conflict with Prettier.

If the Prettier conflicts with the shareable config provided by this plugin, use eslint-config-prettier to resolve it.

Example .eslintrc.js:

module.exports = {
  // ...
  extends: [
    // ...
    // 'eslint:recommended',
    // ...
    'plugin:vue/vue3-recommended',
    // ...
    "prettier",
    "prettier/vue",
    // "prettier/@typescript-eslint", // required if you are using @typescript-eslint.
    // Other settings may be required depending on the plugin you are using. See the eslint-config-prettier documentation for more details.
  ],
  // ...
}

If the Prettier conflicts with the rule you have set, turn off that rule.

Example .eslintrc.js:

When the vue/html-indent rule conflict with Prettier.

module.exports = {
  // ...
  rules: {
    // ...
-    "vue/html-indent": "error",
+    "vue/html-indent": "off",
    // ...
  },
  // ...
}

Using JSX.

If you are using JSX, you need to enable JSX in your ESLint configuration.

  "parserOptions": {
      "ecmaVersion": 2020,
      "ecmaFeatures": {
+         "jsx": true
      }
  }

See also ESLint - Specifying Parser Options.

The same configuration is required when using JSX with TypeScript (TSX) in the .vue file.
See also here.
Note that you cannot use angle-bracket type assertion style (var x = <foo>bar;) when using jsx: true.