diff options
Diffstat (limited to 'assets/node_modules/stylelint/lib/rules/selector-class-pattern/README.md')
-rw-r--r-- | assets/node_modules/stylelint/lib/rules/selector-class-pattern/README.md | 99 |
1 files changed, 99 insertions, 0 deletions
diff --git a/assets/node_modules/stylelint/lib/rules/selector-class-pattern/README.md b/assets/node_modules/stylelint/lib/rules/selector-class-pattern/README.md new file mode 100644 index 0000000..68997fe --- /dev/null +++ b/assets/node_modules/stylelint/lib/rules/selector-class-pattern/README.md @@ -0,0 +1,99 @@ +# selector-class-pattern + +Specify a pattern for class selectors. + +```css + .foo, #bar.baz span, #hoo[disabled] { color: pink; } +/** ↑ ↑ + * These class selectors */ +``` + +This rule ignores non-outputting Less mixin definitions and called Less mixins. + +Escaped selectors (e.g. `.u-size-11\/12\@sm`) are parsed as escaped twice (e.g. `.u-size-11\\/12\\@sm`). Your RegExp should account for that. + +## Options + +`regex|string` + +A string will be translated into a RegExp like so `new RegExp(yourString)` — so be sure to escape properly. + +The selector value *after `.`* will be checked. No need to include `.` in your pattern. + +Given the string: + +```js +"foo-[a-z]+" +``` + +The following patterns are considered violations: + +```css +.foop {} +``` + +```css +.foo-BAR {} +``` + +```css +div > #zing + .foo-BAR {} +``` + +The following patterns are *not* considered violations: + +```css +.foo-bar {} +``` + +```css +div > #zing + .foo-bar {} +``` + +```css +#foop {} +``` + +```css +[foo='bar'] {} +``` + +```less +.foop() {} +``` + +```less +.foo-bar { + .foop; +} +``` + +## Optional secondary options + +### `resolveNestedSelectors: true | false` (default: `false`) + +This option will resolve nested selectors with `&` interpolation. + +For example, with `true`. + +Given the string: + +```js +"^[A-Z]+$" +``` + +The following patterns are considered violations: + +```css +.A { + &__B {} /* resolved to ".A__B" */ +} +``` + +The following patterns are *not* considered violations: + +```css +.A { + &B {} /* resolved to ".AB" */ +} +``` |