Package Exports

eslint-plugin-kdujs-accessibility
eslint-plugin-kdujs-accessibility/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (eslint-plugin-kdujs-accessibility) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

eslint-plugin-kdujs-accessibility

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

Installation

If you're using yarn:

yarn add --dev eslint-plugin-kdujs-accessibility

or if you're using npm:

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

Usage

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

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

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

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

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

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

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 documentation in docs/rules.

License

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