npm package: @productboard/stylelint-pb
Description: [![All Contributors](https://img.shields.io/badge/all_contributors-5-orange.svg?style=flat-square)](#contributors) [![codecov](https://codecov.io/gh/productboardlabs/stylelint-pb/branch/master/graph/badge.svg)](https://codecov.io/gh/productboardlabs/style
Latest version: 1.1.0

# Stylelint-PB

[![All Contributors](https://img.shields.io/badge/all_contributors-5-orange.svg?style=flat-square)](#contributors)
[![codecov](https://codecov.io/gh/productboardlabs/stylelint-pb/branch/master/graph/badge.svg)](https://codecov.io/gh/productboardlabs/stylelint-pb)

Set (TODO) of our custom made rules for Stylelint. 🚀

## Story

...🍻

## Install

```
yarn add @productboard/stylelint-pb
```

## Rules

### smart-color-replacement

It's smart! Configuration needs to be provided in format like bellow. 👇

```json
{
  "@snowWhite": "#f4f5e2"
}
```

Example configuration. 👇

```js
{
    rules: {
        "@productboard/smart-color-replacement": [
            {
                "@snowWhite": "#f4f5e2"
            }
        ]
    }
}
```

You can also run this rule in **strict mode** which means that there is no other color than variable allowed!

```js
{
  "rules": {
    "@productboard/smart-color-replacement": [
      {
        "@white": "#ffffff"
      },
      {
        "strictMode": true
      }
    ]
  }
}
```

## Contributors

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore -->
<table><tr><td align="center"><a href="https://jukben.cz"><img src="https://avatars3.githubusercontent.com/u/8135252?v=4" width="100px;" alt="Jakub Beneš"/><br /><sub><b>Jakub Beneš</b></sub></a><br /><a href="https://github.com/productboardlabs/stylelint-pb/commits?author=jukben" title="Code">💻</a></td><td align="center"><a href="https://github.com/tomdohnal"><img src="https://avatars2.githubusercontent.com/u/22922179?v=4" width="100px;" alt="Tom Dohnal"/><br /><sub><b>Tom Dohnal</b></sub></a><br /><a href="https://github.com/productboardlabs/stylelint-pb/commits?author=tomdohnal" title="Code">💻</a></td><td align="center"><a href="https://github.com/kepi74"><img src="https://avatars3.githubusercontent.com/u/1327380?v=4" width="100px;" alt="Pavel Kepka"/><br /><sub><b>Pavel Kepka</b></sub></a><br /><a href="https://github.com/productboardlabs/stylelint-pb/commits?author=kepi74" title="Code">💻</a></td><td align="center"><a href="https://github.com/simon-hrabec"><img src="https://avatars3.githubusercontent.com/u/8255346?v=4" width="100px;" alt="simon-hrabec"/><br /><sub><b>simon-hrabec</b></sub></a><br /><a href="https://github.com/productboardlabs/stylelint-pb/commits?author=simon-hrabec" title="Code">💻</a></td><td align="center"><a href="https://kmaps.co/author/eukarpov/"><img src="https://avatars3.githubusercontent.com/u/1791423?v=4" width="100px;" alt="Evgeny Karpov"/><br /><sub><b>Evgeny Karpov</b></sub></a><br /><a href="https://github.com/productboardlabs/stylelint-pb/commits?author=eukarpov" title="Code">💻</a></td></tr></table>

<!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!