https://github.com/vue-a11y/eslint-plugin-vuejs-accessibility

An eslint plugin for checking Vue.js files for accessibility
https://github.com/vue-a11y/eslint-plugin-vuejs-accessibility

a11y-lint eslint eslint-plugin-vuejs-accessibility hacktoberfest vuejs

Last synced: about 2 months ago
JSON representation

An eslint plugin for checking Vue.js files for accessibility

• Host: GitHub
• URL: https://github.com/vue-a11y/eslint-plugin-vuejs-accessibility
• Owner: vue-a11y
• License: mit
• Created: 2020-04-20T22:54:24.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-04-11T02:17:14.000Z (6 months ago)
• Last Synced: 2024-04-14T06:55:26.656Z (5 months ago)
• Topics: a11y-lint, eslint, eslint-plugin-vuejs-accessibility, hacktoberfest, vuejs
• Language: TypeScript
• Homepage: https://vue-a11y.github.io/eslint-plugin-vuejs-accessibility/
• Size: 5.61 MB
• Stars: 238
• Watchers: 4
• Forks: 23
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-a11y-vue - eslint-plugin-vuejs-accessibility - An [eslint](https://eslint.org/) plugin for checking accessibility rules from within `.vue` files. (Components and plugins / Development)
• awesome-access - eslint-plugin-vuejs-accessibility - An [eslint](https://eslint.org/) plugin for checking accessibility rules from within `.vue` files. (Components and plugins / Development)

README

        
# eslint-plugin-vuejs-accessibility

[![Build Status](https://github.com/vue-a11y/eslint-plugin-vuejs-accessibility/workflows/Main/badge.svg)](https://github.com/vue-a11y/eslint-plugin-vuejs-accessibility/actions)

[![Package Version](https://img.shields.io/npm/v/eslint-plugin-vuejs-accessibility.svg)](https://www.npmjs.com/package/eslint-plugin-vuejs-accessibility)

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

## 📚 Documentation

Please refer to the [official website](https://vue-a11y.github.io/eslint-plugin-vuejs-accessibility/).

## 💻 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](https://opensource.org/licenses/MIT).

## 🏆 Credit

The work for this plugin was largely based on previous work done on [eslint-plugin-vue-a11y](https://github.com/maranran/eslint-plugin-vue-a11y), as well as various other tools, including:

- [eslint-plugin-jsx-a11y](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y)

- [eslint-plugin-vue](https://github.com/vuejs/eslint-plugin-vue)

- [jsx-ast-utils](https://github.com/vuejs/eslint-plugin-vue)