Nucleum stylelint Config

A sharable stylelint configuration for Nucleum.

Extends: stylelint-config-recommended, stylelint-config-property-sort-order-smacss and stylelint-scss.

Turns on additional rules to enforce common stylistic conventions found within the ITCSS architectural pattern:

To see the rules that this config uses, please read the config itself.

Installation

If using npm, run:

npm install stylelint-config-nucleum --save-dev

If using Yarn, run:

yarn add stylelint-config-nucleum --dev

Usage

Set your stylelint configuration to:

{
  "extends": "stylelint-config-nucleum"
}

You can override rules from the shared configuration, by setting your own values within the rules property:

{
  "extends": "stylelint-config-nucleum",
  "rules": {
    "string-quotes": "single"
  }
}

You can also turn a rule off, by setting the value of the rule to null:

{
  "extends": "stylelint-config-nucleum",
  "rules": {
    "string-quotes": null
  }
}

Atom integration

stylelint can be integrated into Atom so that you will be alerted of any warnings and errors inline, while you work.

Install the linter and linter-stylelint packages using Atom’s package manager or enter this into your terminal:

apm install linter linter-stylelint

License

Nucleum stylelint Config is copyright (c) 2020 Cos Anca. It is free software, and may be redistributed under the terms specified in the LICENSE file.

About

Nucleum stylelint Config is maintained by Cos Anca.

I love open source software! See my other projects.