Skip to content

vue-a11y/eslint-plugin-vuejs-accessibility

Repository files navigation

eslint-plugin-vuejs-accessibility

Build Status Package Version

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

πŸ“š Documentation

Please refer to the official website.

πŸ’» Development

Ensure you have node and yarn installed on your system. Then run yarn in the root of the repository to install the dependencies.

πŸ”§ Adding a new rule

To add a new rule, you need to take the following steps:

  • Add the configuration and require to src/index.ts.
  • Add the rule itself into src/rules.
  • Add the corresponding test in src/rules/__tests__.
  • Add the corresponding documentation in docs/rules.

πŸ‘¨β€πŸ’» Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/vue-a11y/eslint-plugin-vuejs-accessibility.

πŸ“„ License

The code is available as open source under the terms of the MIT License.

πŸ† Credit

The work for this plugin was largely based on previous work done on eslint-plugin-vue-a11y, as well as various other tools, including: