README
stylelint-selector-bem-pattern
A stylelint plugin that incorporates postcss-bem-linter.
To learn more about postcss-bem-linter, please read that module's documentation.
Installation
npm install stylelint-selector-bem-pattern
Be warned: v0.2.0+ is only compatible with stylelint v3+. For earlier version of stylelint, use earlier versions of this.
Usage
Add it to your stylelint config plugins
array, then add "plugin/selector-bem-pattern"
to your rules,
specifying your postcss-bem-linter settings as the primary option.
Even though postcss-bem-linter has the default setting of { preset: 'suit' }
, this plugin has
no default setting: if you want to use the SUIT preset, you must pass { preset: 'suit' }
,
and the rule will not work if you do not pass a primary option object.
Like so:
// .stylelintrc
{
"plugins": [
"stylelint-selector-bem-pattern"
],
"rules": {
// ...
"plugin/selector-bem-pattern": {
"componentName": "[A-Z]+",
"componentSelectors": {
"initial": "^\\.{componentName}(?:-[a-z]+)?