stylelint-config-wordpress

stylelint-config-wordpress

WordPress shareable config for stylelint.

Configuration rules to ensure your CSS is compliant with the WordPress CSS Coding Standards.

Table of Contents

• Installation
• Usage
• Presets
• Extending the config
• Changelog
• License

Installation

$ npm install stylelint-config-wordpress --save-dev

Usage

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

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

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

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

Presets

In addition to the default preset, there are also specific presets. All presets extend the default one.

SCSS

{
  "extends": [
    "stylelint-config-wordpress/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": "stylelint-config-wordpress",
  "rules": {
    "indentation": 4,
    "number-leading-zero": null
  }
}

Changelog

License

Changelog

12.0.0

• Changed: stylelint-config-wordpress now extends stylelint-config-recommended, which turns on the at-rule-no-unknown, block-no-empty, comment-no-empty, declaration-block-no-ignored-properties, declaration-block-no-redundant-longhand-properties, font-family-no-duplicate-names, media-feature-name-no-unknown, no-empty-source rule. These rules are part of stylelint's possible errors rules.
• Removed: stylelint-scss < 1.5.1 compatibility.
• Removed: Removed style guide docs.
• Removed: at-rule-no-unknown custom ignoreAtRules options in stylelint-config-wordpress/scss shared config.
• Added: scss/at-rule-no-unknown rule in stylelint-config-wordpress/scss shared config.
• Added: NodeJS 8.x.x support.
• Added: npm 5.x.x support.
• Added: Jest snapshots to help detect and prevent regressions.