rithmXO / stylelint-config

An opinionated collection of stylelint configs to be used across Strut and Rithm projects

Stylelint Rules

Description

This package contains a standard set of stylelint configs to be used across Strut Software Solutions projects and Rithm Software projects. This is to ensure each project has the same set of rules to keep projects consistent.

Configs

Config files exist for the following use cases and are summarized below.

• scss - Recommended rules for projects using SCSS.

Installation

From the root folder of your project, install the package with the following command:

npm i @strut-software/stylelint-config --save-dev

Usage

Once the package is installed, add the desired configs to the "extends" section of the .stylelintrc.json in the root of your project:

{
    ...
            "extends": [
                "@strut-software/stylelint-config/scss"
            ],
            ...
        }
        ...
    ]
}

Afterwards, you will be able to run your desired lint command to use the newly-imported lint rules.

NOTE: Keeping this package up to date is highly recommended. Be sure that the version number in your package.json contains a ^ before the version number to update to the newest minor version when using npm update.

Example:

"devDependencies": {
    ...
    "@strut-software/stylelint-config": "^1.1.0",
    ...
}