thoughtbot / stylelint-config

A shareable stylelint configuration that enforces thoughtbot’s Sass guides.
https://thoughtbot.com
MIT License
9 stars 2 forks source link
code-quality css sass scss stylelint stylelint-config

thoughtbot stylelint Config

A sharable stylelint configuration that enforces thoughtbot’s Sass guides.

Installation

If using npm, run:

npm install @thoughtbot/stylelint-config --save-dev

If using Yarn, run:

yarn add @thoughtbot/stylelint-config --dev

Usage

Set your stylelint configuration to:

{
  "extends": "@thoughtbot/stylelint-config"
}

You can override rules from the shared configuration, by setting your own values within the rules property:

{
  "extends": "@thoughtbot/stylelint-config",
  "rules": {
    "string-quotes": "single"
  }
}

You can also turn a rule off, by setting the value of the rule to null:

{
  "extends": "@thoughtbot/stylelint-config",
  "rules": {
    "string-quotes": null
  }
}

License

thoughtbot stylelint Config is copyright (c) 2020 thoughtbot, inc. It is free software, and may be redistributed under the terms specified in the LICENSE file.

About thoughtbot

thoughtbot

This repo is maintained and funded by thoughtbot, inc. The names and logos for thoughtbot are trademarks of thoughtbot, inc.

We love open source software! See our other projects. We are available for hire.