stylelint-stylistic / stylelint-config

The stylistic shareable config for Stylelint

Home Page:https://www.npmjs.com/package/@stylistic/stylelint-config

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Stylelint Stylistic Config

License: MIT Changelog NPM version Test Status

The stylistic shareable config for Stylelint.

Use it to return to your config the 63 stylistic rules removed in stylelint-config-standard 30.0.0, and the one removed in stylelint-config-recommended 10.0.1.

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

Installation and usage

Add @stylistic/stylelint-config and stylelint itself to your project:

npm add -D @stylistic/stylelint-config stylelint

Set your .stylelintrc.json to:

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

If you use stylelint-config-recommended, stylelint-config-standard, or some other config for syntax linting, then list the config names in an array (order matters):

{
	"extends": [
		"stylelint-config-standard",
		"@stylistic/stylelint-config"
	]
}

Rule overrides

If the value of a rule does not suit you, specify that rule in the "rules" section with the value you want:

{
	"extends": "@stylistic/stylelint-config",
	"rules": {
		"@stylistic/indentation": "tab"
	}
}

You can turn off rules by setting its value to null. For example:

{
	"extends": "@stylistic/stylelint-config",
	"rules": {
		"@stylistic/max-line-length": null
	}
}

In addition, the config is based on the @stylistic/stylelint-plugin, which has all 76 stylistic rules removed in Stylelint 16.0.0. You can use all these rules, not just the 65 configured in the config. For example:

{
	"extends": "@stylistic/stylelint-config",
	"rules": {
		"@stylistic/at-rule-name-newline-after": "always-multi-line"
	}
}

Please refer to Stylelint docs for detailed info on using this linter.

Need more?

ESLint deprecates stylistic rules, too. But you can continue to use them thanks to ESLint Stylistic.

About

The stylistic shareable config for Stylelint

https://www.npmjs.com/package/@stylistic/stylelint-config

License:MIT License


Languages

Language:JavaScript 100.0%