@vue/eslint-config-airbnb

eslint-config-airbnb for Vue

This config is specifically designed to be used by @vue/cli & create-vue setups and is not meant for outside use (it can be used but some adaptations on the user side might be needed - for details see the config file).

A part of its design is that this config may implicitly depend on other parts of @vue/cli/create-vue setups, such as eslint-plugin-vue being extended in the same resulting config.

Installation

In order to work around a known limitation in ESLint, we recommend you to use this package alongside @rushstack/eslint-patch, so that you don't have to install too many dependencies:

1npm add --dev @vue/eslint-config-airbnb @rushstack/eslint-patch

Usage

An example .eslintrc.cjs:

1require("@rushstack/eslint-patch/modern-module-resolution")
2
3module.exports = {
4  root: true,
5  extends: [
6    'plugin:vue/vue3-essential',
7    '@vue/eslint-config-airbnb'
8  ]
9}

Aliases

The base airbnb config includes rules that need to actually resolve the imported module on the filesystem, such as import/no-unresolved.

If you use aliases in your project, you need to configure ESLint to resolve the aliases, and we've provided a helper function for the task.

For example, it is a widely accepted convention to use @ as an alias to the src folder in the Vue ecosystem. To enable this, you can use the following config:

1require('@rushstack/eslint-patch/modern-module-resolution')
2
3const path = require('node:path')
4const createAliasSetting = require('@vue/eslint-config-airbnb/createAliasSetting')
5
6module.exports = {
7  root: true,
8  extends: [
9    'plugin:vue/vue3-essential',
10    '@vue/eslint-config-airbnb'
11  ],
12  rules: {
13    'import/no-unresolved': 'error'
14  },
15  settings: {
16    ...createAliasSetting({
17      '@': `${path.resolve(__dirname, './src')}`
18    })
19  }
20}

createAliasSetting accepts a map of aliases and their corresponding paths, and returns a settings object to be spread in to the settings field of the ESLint config.

IE 11 support

IE 11 reached End-of-Life on June 15, 2022, so this configuration doesn't include any rules that are specific to IE 11.

If your project still has to support IE 11, we recommend you to add the following 2 rules to your config:

1module.exports = {
2   // ...
3
4   rules: {
5    // Enforce `rel="noopener noreferrer"` on external links in `<template>`
6    // https://eslint.vuejs.org/rules/no-template-target-blank.html
7    'vue/no-template-target-blank': 'error',
8    // Enforce `rel="noopener noreferrer"` on external links in JSX
9    // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/jsx-no-target-blank.md
10    'react/jsx-no-target-blank': 'error',
11   }
12}