Getting Started

An eslint plugin for checking accessibility rules from within .vue files.

💿 Installation

::: code-group

yarn add --dev eslint-plugin-vuejs-accessibility

npm install --save-dev eslint-plugin-vuejs-accessibility

pnpm add -D eslint-plugin-vuejs-accessibility

:::

Add vuejs-accessibility to the plugins section of your eslint configuration. You can omit the eslint-plugin- prefix:

{
  "plugins": ["vuejs-accessibility"]
}

Then configure the rules you want to use under the rules section.

{
  "rules": {
    "vuejs-accessibility/rule-name": "error"
  }
}

You can also enable all the recommended rules at once. Add plugin:vuejs-accessibility/recommended in extends:

{
  "extends": ["plugin:vuejs-accessibility/recommended"]
}