Rocketmakers stylelint config

Package to return stylelint config based on a set of internally defined standards. Full Documentation

Installation

Run the following to install the package as a dev dependency:

npm i --save-dev @rocketmakers/stylelint-config

Once you have installed @rocketmakers/stylelint-config you do not need to install any other formatting package, such as stylelint, as these will be installed as transitive dependencies and you will still be able to run npx stylelint ... successfully.

Config setup

This package has a dependency on stylelint, as a result you do not need to install it directly.

Create a stylelint.config.js file in the directory you intend to run stylelint from, with the following contents:

// stylelint.config.js
module.exports = require('@rocketmakers/stylelint-config');

This will initialise stylelint with the Rocketmakers agreed formatting rules. Although there are other methods of consuming a shared stylelint configuration, the inclusion of a stylelint.config.js works best when integrating with @rocketmakers/eslint to produce formatting warnings/errors in linting output. The above method also respects any ignore patterns you include within a .stylelintignore file and is respected by VScode stylelint plugins. The configuration itself will automatically ignore any stylesheets found in node_modules.

Formatting

Run the following scripts to format your code (adjust for type of stylesheet being used):

# return errors
npx stylelint "**/*.scss"

# fix linting errors
npx stylelint "**/*.scss" --fix

Ignore files

.stylelintignore files are respected when using the above setup.