Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@double-great/stylelint-a11y

Package Overview
Dependencies
Maintainers
2
Versions
6
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@double-great/stylelint-a11y

Plugin for stylelint with a11y rules

  • 3.0.2
  • latest
  • Source
  • npm
  • Socket score

Version published
Maintainers
2
Created
Source

@double-great/stylelint-a11y

Installation and usage

npm i --save-dev stylelint @double-great/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

Rule IDDescription
content-property-no-static-valueDisallow unaccessible CSS generated content in pseudo-elements
font-size-is-readableDisallow font sizes less than 15px
line-height-is-vertical-rhythmedDisallow not vertical rhythmed line-height
media-prefers-reduced-motionRequire certain styles if the animation or transition in media featuresRecommended, Fixable
media-prefers-color-schemeRequire implementation of certain styles for selectors with colors.
no-display-noneDisallow content hiding with display: none property
no-obsolete-attributeDisallow obsolete attribute using
no-obsolete-elementDisallow obsolete selectors using
no-spread-textRequire width of text in a comfortable range
no-outline-noneDisallow outline clearingRecommended
no-text-align-justifyDisallow content with text-align: justify
selector-pseudo-class-focusRequire or disallow a pseudo-element to the selectors with :hoverRecommended, Fixable

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

@double-great/stylelint-a11y/recommended

This shareable config contains the following:

{
  "plugins": ["@double-great/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.

Keywords

FAQs

Package last updated on 14 Feb 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc