Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@thoughtbot/stylelint-config

thoughtbot6.9kMIT5.0.0

A sharable [stylelint][stylelint] configuration that enforces [thoughtbot’s Sass guides][thoughtbot-sass-guides].

stylelint, stylelint-config

readme

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.

changelog

Change Log

All notable changes to this project will be documented in this file. This project adheres to Semantic Versioning.

Unreleased (main)

Nothing at the moment.

5.0.0 - 2025-0512

stylelint-config-recommend dropped support for Node.js less than 22, so we switched to testing against the current LTS (v22.15.0)

  • Upgrade stylelint-config-recommended from v14.0.0 to v16.0.0
  • Upgrade stylelint-config-standard-scss from v13.0.0 to v15.0.0
  • Upgrade stylelint-order from v6.0.4 to v7.0.0
  • Upgrade Node to v22.15.0 (#85)
  • Specify Node version manually (#87)
  • Upgrade actions/checkout from v3 to v4 (#86)
  • Narrowly specify the desired transition declaration (#80)
  • Add security.yml and SECURITY.md (#62)
  • Create CODEOWNERS
  • Add an additional space to the README (#60)
  • Refresh README dynamic section (#59)
  • Call dynamic-readme reusable workflow (#57)

4.0.0 - 2024-02-02

  • Add a script to automate building the CHANGELOG (#56)
  • Allow !default annotations (#55)
  • Upgrade Stylelint to v16.2.0 (#54)
  • Lint JavaScript with eslint/prettier (#53)
  • Remove deprecated rules, but test for future ones (#52)
  • Start testing against a sample (#51)
  • Remove Atom editor configuration (#49)
  • Fix thoughtbot README logo (#50)
  • Fix link to Sass guides (#48)
  • Upgrade Node to v20.11.0 (#47)
  • Add Dependabot for dependency checking (#40)

3.0.1 - 2023-07-14

Changed

  • Updated stylelint to v15.10.1
  • Updated stylelint-config-recommended to v13.0.0
  • Updated stylelint-order to v6.0.0
  • Updated stylelint-scss to v5.0.0

3.0.0 - 2022-04-22

Changed

2.0.0 - 2020-03-09

Added

Changed

1.2.0 - 2019-12-15

Changed

  • Updated stylelint-config-recommended to v3.0.0
  • Updated stylelint-order to v3.1.1
  • Updated stylelint-scss to v3.13.0
  • Updated stylelint-declaration-block-no-ignored-properties to v2.2.0

1.1.0 - 2019-09-09

Added

1.0.2 - 2019-08-06

Changed

  • Use a >= stylelint peer dependency to be more flexible in which stylelint version consumers can use.

1.0.1 - 2019-04-18

Fixed

  • Added missing stylelint-config-recommended dependency.

1.0.0 - 2019-03-23

Added

0.2.0 - 2019-01-18

Added

Changed

  • Bump stylelint-order to 2.0.0
  • Bump stylelint-scss to 3.5.1