@scultura/stylelint-config/README.md

Default stylelint config used by Scultura.

# scultura-stylelint-config

[![npm version](https://img.shields.io/npm/v/@scultura/stylelint-config)](https://www.npmjs.com/package/@scultura/stylelint-config)
[![dependencies](https://img.shields.io/david/dmartinjs/scultura-stylelint-config)](package.json)
[![license](https://img.shields.io/github/license/dmartinjs/scultura-stylelint-config)](LICENSE)

> Stylelint configuration used by Scultura CSS framework.

## What is Stylelint

[Stylelint](https://stylelint.io/) is a mighty, modern linter that helps you avoid errors and enforce conventions in your styles.

## Installation

```bash
npm install @scultura/stylelint-config --save-dev
```

## Usage

```json
{
  "extends": "@scultura/stylelint-config/css"
}
```

Your can override or add your own rules in your [Stylelint configuration file](https://stylelint.io/user-guide/configuration).

```json
{
  "extends": "@scultura/stylelint-config/css",
  "rules": {
    // your own rules here
  }
}
```

## Rules

We extend rules from [`stylelint-config-standard`](https://github.com/stylelint/stylelint-config-standard).

That means all rules for **Possible errors** are activated and enforce a minimal set of **stylistic conventions** seen within a handful of CSS styleguides.

For our own's rules, we include:
* banning vendor prefix (Added at compile time by [`Autoprefixer`](https://github.com/postcss/autoprefixer))
* limitation for selector number to keep performance and reusability
* banning `!important` property
* all letters in lowercase
* numeric value for font weight

Your can see all our rules [here](css/index.js).

And read about all [Stylelint rules](https://stylelint.io/user-guide/rules).

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details