stylelint-codeguide

stylelint-codeguide

---

[!WARNING]
⚠️ This package has been deprecated in favor of @stylistic/stylelint-plugin.

---

An updatable collection of stylistic rules for Stylelint (in plugin form).

About and purpose

Stylelint has removed 76 rules that enforce stylistic conventions.

stylelint-codeguide returns these rules to keep styles consistent with your codeguide. In addition, new rules may be added in the future.

The plugin follows Stylelint's guidelines.

Installation and usage

Add stylelint-codeguide and stylelint itself to your project:

npm install --save-dev stylelint stylelint-codeguide

Create the .stylelintrc config file (or open the existing one), add stylelint-codeguide to the plugins array and the rules you need to the rules list. All rules from stylelint-codeguide need to be namespaced with codeguide/:

{
	"plugins": [
		"stylelint-codeguide"
	],
	"rules": {
		// syntax rules from stylelint:
		"color-function-notation": "modern",
		"selector-max-compound-selectors": 2,
		// ...
		// stylistic rules from stylelint-codeguide:
		"codeguide/color-hex-case": "lower",
		"codeguide/number-leading-zero": "always",
		"codeguide/unit-case": "lower"
	}
}

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

Important documents

• Changelog
• Contributing
• License

Changelog

[2.0.0] — 2023–12–20

Changed

• The repository renamed to stylelint-stylistic and moved to the organization of the same name.
• The plugin is published in npm under the new name @stylistic/stylelint-plugin. Therefore, you should:
  • change the former plugin name stylelint-codeguide to the new one in the config,
  • remove the old stylelint-codeguide package from dependencies
  • install the new @stylistic/stylelint-plugin package.
• The namespace of plugin rules has been renamed. Therefore, you should change the rules prefix from codeguide/ to @stylistic/ in the config.