@kununu/stylelint-config/README.md

kununu's stylelint config

# @kununu/stylelint-config

> kununu style linter configuration

These configurations are for [stylelint](https://stylelint.io/) linter.

## 📦 Installation

Add @kununu/stylelint-config npm package as a dev dependency to your project:

```console
npm install @kununu/stylelint-config --save-dev
```

## 💻 Usage

Create a `.stylelintrc` file with the following configuration:

```yaml
{
  "extends": "@kununu/stylelint-config"
}
```

See [docs](https://stylelint.io/user-guide/configuration) to find more detailed information on stylelint configuration and usage.

And add

 ```console

"lint": "stylelint '**/*.scss'",
```

to your npm file.

## ⚡️ Editor Plugins

At kununu, [@kununu/stylelint-config](https://www.npmjs.com/package/@kununu/stylelint-config) linter runs on every commit, but finding a lint error after push can be frustrating and a waste time. In order to avoid it, editor plugins are available to warn you and validate your code.

There's what we use and recommend:

### Atom

- [linter-stylelint](https://atom.io/packages/linter-stylelint)

### Visual Code Studio

- [stylelint](https://marketplace.visualstudio.com/items?itemName=hex-ci.stylelint-plus)