npm package: @geniemouse/stylelint-config
Description: Shared stylelint configuration settings
Author: Lucy Barker
Latest version: 1.0.3

# `@geniemouse/stylelint-config`

Keep project CSS formatting consistent and free of obvious errors across projects with [stylelint] and this base configuration.

This configuration is strict.

<!-- MarkdownTOC levels="2,3,4" -->

1. [Installation](#installation)
1. [Configuration](#configuration)
    1. [`package.json`](#packagejson)
    1. [`.stylelintrc`](#stylelintrc)
    1. [Adding new/overriding rules](#adding-newoverriding-rules)
    1. [Using alongside Prettier](#using-alongside-prettier)

<!-- /MarkdownTOC -->

## Installation

1. [Install] _stylelint_ locally:

```shell
# Using npm:
npm install stylelint --save-dev

# Using yarn:
yarn add stylelint --dev
```

2. Install the _GenieMouse stylelint_ configuration package locally:

```shell
# Using npm:
npm install @geniemouse/stylelint-config --save-dev

# Using yarn:
yarn add @geniemouse/stylelint-config --dev
```

## Configuration

Add the _stylelint_ set-up instructions to either the `package.json` or a `.stylelintrc` file in your project's root directory.

### `package.json`

```jsonc
"stylelint": {
    "extends": ["@geniemouse/stylelint-config"]
    "rules": {
        // Add new/overriding rules, as necessary
    }
}
```

### `.stylelintrc`

```jsonc
{
    "extends": ["@geniemouse/stylelint-config"],
    "rules": {
        // Add new/overriding rules, as necessary
    }
}
```

### Adding new/overriding rules

Additional _stylelint_ rules/overrides should be written to the `rules` property.

More information about _stylelint's_ settings can be found on their site:

-   [configuration]
-   [rules]

### Using alongside Prettier

If [Prettier] is being used in your project or editor, some additional `node` packages will be required to have the two configurations running well together.

```shell
# Using npm:
npm install stylelint-prettier stylelint-config-prettier --save-dev

# Using yarn:
yarn add stylelint-prettier stylelint-config-prettier --dev
```

Add the `stylelint-prettier/recommended` configuration to the plugins `extends` array.

E.g. For a `.stylelintrc` file, it looks like this:

```jsonc
{
    "extends": [
        "@geniemouse/stylelint-config",
        "stylelint-prettier/recommended" // Ensure that stylelint-prettier is called last
    ],
    "rules": {
        // Add new/overriding rules, as necessary
    }
}
```

**Additional project script command**

With the installation of `stylelint-config-prettier`, a new command can be added to the `scripts` section of your `package.json` file:

```jsonc
"scripts": {
    // ...
    "stylelint-check": "stylelint-config-prettier-check",
    // ...
}
```

Running this command will report any conflicting _Prettier/stylelint_ rules.

-   `npm run stylelint-check`
-   `yarn stylelint-check`

<!-- LINK REFERENCES -->

[prettier]: https://prettier.io/
[stylelint]: https://stylelint.io/
[configuration]: https://stylelint.io/user-guide/configuration/
[rules]: https://stylelint.io/user-guide/rules/
[install]: https://stylelint.io/#getting-started
[stylelint-prettier]: https://www.npmjs.com/package/stylelint-prettier
[stylelint-config-prettier]: https://www.npmjs.com/package/stylelint-config-prettier

<!-- end: LINK REFERENCES -->