/stylelint

A mighty, modern CSS linter

Primary LanguageJavaScriptMIT LicenseMIT

stylelint

NPM version Build Status Build status Coverage Status NPM Downloads Bountysource

A mighty, modern CSS linter that helps you enforce consistent conventions and avoid errors in your stylesheets.

Upgrading? Please read our CHANGELOG to learn what changes to expect in the latest version, whether that's new features, bug fixes, renamed rules, or whatever else.

Features

  • Over one hundred and forty rules: Including those that:
    • Catch errors: e.g. invalid hex colors, indistinguishable colors, or overriding shorthand properties.
    • Enforce best practices: e.g. keeping specificity low or disallowing vendor prefixes in your source code.
    • Control what languages features can be used: e.g. whitelisting specific units, properties and functions, or disallowing certain selector types.
    • Enforce code style conventions: e.g. checking the spacing around the colon in declarations or specifying patterns for class selectors.
  • Support for the latest CSS syntax: Including custom properties, range context for media features, calc() and nesting.
  • Understands CSS-like syntaxes: The linter is powered by PostCSS, so it understands any syntax that PostCSS can parse, including SCSS, SugarSS, and experimental support for Less.
  • Completely unopinionated: Only enable the rules you want, and configure them with options that tailor the linter to your needs.
  • Support for plugins: It's easy to create your own rules and add them to the linter.
  • Automatically fix some stylistic warnings: By using stylefmt which supports stylelint configuration files.
  • Shareable configs: If you don't want to craft your own config, you can extend a shareable config.
  • Options validator: So that you can be confident that your config is valid.
  • Growing community: Used by Facebook, Github, Wikimedia, GSA, and WordPress among others.

Example output

Example

Getting started

With stylelint, it's easy to start linting your CSS:

  1. Decide how you want to use stylelint:

  2. Create your configuration object by either extending a shared config or crafting your own:

    • To extend a shared config, we recommend using stylelint-config-standard. It includes over 80 of stylelint's rules with sensible defaults. (You can always override specific rules after extending the config.) We update the config with each new release of stylelint. Alternately, you can search for a community config and extend that instead.
    • To craft your own config, first learn about how rules are named and how they work together, then either:
      • Start small and only learn about the rules you want to turn on and enforce. All of the rules are off by default, and so you can start small, growing your config over time as you have a chance to explore more of the rules.
      • Or copy-paste this example configuration, which lists all of stylelint's rules and their primary options. Then you can edit the options of each rule to your liking, and remove (or turn off with null) the rules that you don't care to enforce.

  3. Lint!

Be sure to specify the syntax if you're using non-standard syntax (e.g. SCSS, SugarSS or Less).

Guides

You'll find more detailed information on using stylelint and tailoring it to your needs in our guides:

  • User guide - Usage, configuration, FAQ and complementary tools.
  • Developer guide - Contributing to stylelint and writing your own plugins & formatters.

Help out

There is always a lot of work to do, and already well over 100 rules to maintain. So please help out in any way that you can:

  • Create, enhance, and debug rules (see our guide to "Working on rules").
  • Improve documentation.
  • Chime in on any open issue or pull request.
  • Open new issues about your ideas for making stylelint better, and pull requests to show us how your idea works.
  • Add new tests to absolutely anything.
  • Work on improving performance of rules.
  • Create or contribute to ecosystem tools, like the plugins for Atom and Sublime Text.
  • Spread the word.

We communicate via issues and pull requests.

There is also stackoverflow, which is our preferred QA forum. Tag your post with "stylelint".

Important documents