Plugin for stylelint with a11y rules
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

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

{
  "plugins": ["stylelint-a11y"],
  "rules": {
    "a11y/media-prefers-reduced-motion": true,
    "a11y/no-outline-none": true,
    "a11y/selector-pseudo-class-focus": true,
    "a11y/content-property-no-static-value": [true, { "severity": "warning" }],
    "a11y/font-size-is-readable": [true, { "severity": "warning" }],
    "a11y/line-height-is-vertical-rhythmed": [true, { "severity": "warning" }],
    "a11y/no-display-none": [true, { "severity": "warning" }],
    "a11y/no-spread-text": [true, { "severity": "warning" }],
    "a11y/no-obsolete-attribute": [true, { "severity": "warning" }],
    "a11y/no-obsolete-element": [true, { "severity": "warning" }],
    "a11y/no-text-align-justify": [true, { "severity": "warning" }],
    "a11y/media-prefers-color-scheme": [true, { "severity": "warning" }]
  }
}

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.