Skip to content

Latest commit

 

History

History
95 lines (67 loc) · 2.23 KB

README.md

File metadata and controls

95 lines (67 loc) · 2.23 KB

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
  }
}

Atom integration

stylelint can be integrated into Atom so that you will be alerted of any warnings and errors inline, while you work.

Install the linter and linter-stylelint packages using Atom’s package manager or enter this into your terminal:

apm install linter linter-stylelint

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 stylelint Config 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 or hire us to help build your product.