https://github.com/thoughtbot/stylelint-config

A shareable stylelint configuration that enforces thoughtbot’s Sass guides.
https://github.com/thoughtbot/stylelint-config

code-quality css sass scss stylelint stylelint-config

Last synced: 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/thoughtbot/stylelint-config
• Owner: thoughtbot
• License: mit
• Created: 2018-10-26T16:50:21.000Z (about 6 years ago)
• Default Branch: main
• Last Pushed: 2024-08-16T18:56:06.000Z (5 months ago)
• Last Synced: 2024-09-17T00:18:17.724Z (4 months ago)
• Topics: code-quality, css, sass, scss, stylelint, stylelint-config
• Language: JavaScript
• Homepage: https://thoughtbot.com
• Size: 306 KB
• Stars: 9
• Watchers: 4
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# thoughtbot stylelint Config

A sharable [stylelint][stylelint] configuration that enforces

[thoughtbot’s Sass guides][thoughtbot-sass-guides].

[stylelint]: https://stylelint.io/

[thoughtbot-sass-guides]: https://github.com/thoughtbot/guides/tree/main/sass

## Installation

If using **npm**, run:

```bash

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

```

If using **Yarn**, run:

```bash

yarn add @thoughtbot/stylelint-config --dev

```

## Usage

Set your [stylelint configuration][stylelint-configuration] to:

```json

{

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

}

```

You can override rules from the shared configuration, by setting your

own values within the `rules` property:

```json

{

  "extends": "@thoughtbot/stylelint-config",

  "rules": {

    "string-quotes": "single"

  }

}

```

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

```json

{

  "extends": "@thoughtbot/stylelint-config",

  "rules": {

    "string-quotes": null

  }

}

```

[stylelint-configuration]: https://stylelint.io/user-guide/configuration/

## 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.

[LICENSE]: /LICENSE.md

## About thoughtbot

![thoughtbot](https://thoughtbot.com/thoughtbot-logo-for-readmes.svg)

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][community].

We are [available for hire][hire].

[community]: https://thoughtbot.com/community?utm_source=github

[hire]: https://thoughtbot.com/hire-us?utm_source=github