YOO Stylelint Configuration for Sass Projects

Contains the settings and rules used for Sass/SCSS projects within YOO. It is publicly available via the npm registry.

❗ Should be used in combination with our Prettier config.

Purpose

The exported index.js file contains all the Stylelint rules for Sass that are compatible with our coding guidelines. See the guidelines for more information.

Usage

Be aware: The stylelint package is listed as a peer dependency. The versions might collide in your project. Always try to use the latest versions of stylelint in your project. Please check the changelog to see which stylelint version this package is compatible with.

After installing the packages, you can create a .stylelintrc.js file in the root of your project and add the following lines:

module.exports = {
  extends: '@yoo-digital/stylelint-config-sass',
};

You can apply your own set of rules on top of that, but do not turn off any of the rules, except it is an obstacle and making your life harder. Check the chapter below, for a complete set of rules that can be applied.

Development

Before creating a pull request or publishing changes, make sure you tested your changes.

This project is a monorepo and uses lerna. See Lerna's official website for more info.