Skip to content
Plugin for stylelint with a11y rules
Branch: master
Clone or download
Latest commit a7f8931 May 4, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src Stylelint 10.x upgrade (#41) May 4, 2019
.babelrc
.eslintignore wip: Add deps, focus rule Jun 4, 2018
.eslintrc.js chore: Remove deps with flow support Jun 5, 2018
.gitignore chore: Move stylelint from deps to peerDeps, add coveralls and rimraf Jun 4, 2018
.travis.yml Stylelint 10.x upgrade (#41) May 4, 2019
LICENSE Create LICENSE Jun 9, 2018
README.md HTTPS links in README (#37) Apr 5, 2019
jest.config.js wip: Add deps, focus rule Jun 4, 2018
jest.setup.js wip: Add deps, focus rule Jun 4, 2018
package-lock.json Update to 1.1.10 Jan 19, 2019
package.json Update to 1.2.0 May 4, 2019
recommended.js Add recommended shareable config (#36) Feb 11, 2019
yarn.lock

README.md

stylelint-a11y

NPM version npm PRs Welcome Build Status

Installation and usage

yarn add --dev stylelint stylelint-a11y

Create the .stylelintrc.json config file (or open the existing one), add stylelint-a11y to the plugins array and the rules you need to the rules list. All rules from stylelint-a11y need to be namespaced with a11y.

Please refer to stylelint docs for the detailed info on using this linter.

Rules

  • ⭐️ - the mark of recommended rules.
  • ✒️ - the mark of fixable rules.
Rule ID Description
content-property-no-static-value Disallow unaccessible CSS generated content in pseudo-elements
font-size-is-readable Disallow font sizes less than 15px
line-height-is-vertical-rhythmed Disallow not vertical rhythmed line-height
⭐️✒️ media-prefers-reduced-motion Require certain styles if the animation or transition in media features
media-prefers-color-scheme Require implementation of certain styles for selectors with colors.
no-display-none Disallow content hiding with display: none property
no-obsolete-attribute Disallow obsolete attribute using
no-obsolete-element Disallow obsolete selectors using
no-spread-text Require width of text in a comfortable range
⭐️ no-outline-none Disallow outline clearing
no-text-align-justify Disallow content with text-align: justify
⭐️✒️ selector-pseudo-class-focus Require or disallow a pseudo-element to the selectors with :hover

Recommended config

Add recommended configuration by simply adding the following to extends in your stylelint configuration:

stylelint-a11y/recommended

This shareable config contains the following:

{
  "plugins": ["stylelint-a11y"],
  "rules": {
    "a11y/media-prefers-reduced-motion": true,
    "a11y/no-outline-none": true,
    "a11y/selector-pseudo-class-focus": true
  }
}

Since it adds stylelint-a11y to plugins, you don't have to do this yourself when extending this config.

Help out

There work on the plugin's rules is still in progress, so if you feel like it, you're welcome to help out in any of these (the plugin follows stylelint guidelines so most part of this is based on its docs):

  • Create, enhance, and debug rules (see stylelint's guide to "Working on rules").
  • Improve documentation.
  • Chime in on any open issue or pull request.
  • Open new issues about your ideas on new rules, or for how to improve the existing ones, and pull requests to show us how your idea works.
  • Add new tests to absolutely anything.
  • Work on improving performance of rules.
  • Contribute to stylelint
  • Spread the word.

We communicate via issues and pull requests.

There is also stackoverflow, which would be the preferred QA forum.

You can’t perform that action at this time.