@gechiui/stylelint-config

stylelint config

stylelint configuration rules to ensure your CSS is compliant with the GeChiUI CSS Coding Standards.

Installation

$ npm install @gechiui/stylelint-config --save-dev

Note: This package requires Node.js 12.0.0 or later. It is not compatible with older versions.

Usage

If you've installed @gechiui/stylelint-config locally within your project, just set your stylelint config to:

{
	"extends": "@gechiui/stylelint-config"
}

If you've globally installed @gechiui/stylelint-config using the -g flag, then you'll need to use the absolute path to @gechiui/stylelint-config in your config:

{
	"extends": "/absolute/path/to/@gechiui/stylelint-config"
}

Presets

In addition to the default preset, there is also a SCSS preset. This preset extends both @gechiui/stylelint-config and stylelint-config-recommended-scss.

SCSS

{
	"extends": [ "@gechiui/stylelint-config/scss" ]
}

Extending the config

Simply add a "rules" key to your config and add your overrides there.

For example, to change the indentation to four spaces and turn off the number-leading-zero rule:

{
	"extends": "@gechiui/stylelint-config",
	"rules": {
		"indentation": 4,
		"number-leading-zero": null
	}
}