|
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355 |
- # max-nesting-depth
-
- Limit the depth of nesting.
-
- <!-- prettier-ignore -->
- ```css
- a { & > b { top: 0; } }
- /** ↑
- * This nesting */
- ```
-
- This rule works by checking rules' and at-rules' actual "nesting depth" against your specified max. Here's how nesting depths works:
-
- <!-- prettier-ignore -->
- ```css
- a {
- & b { /* nesting depth 1 */
- & .foo { /* nesting depth 2 */
- @media print { /* nesting depth 3 */
- & .baz { /* nesting depth 4 */
- color: pink;
- }
- }
- }
- }
- }
- ```
-
- Note that **root-level at-rules will _not_ be included in the nesting depth calculation**, because most users would take for granted that root-level at-rules are "free" (because necessary). So both of the following `.foo` rules have a nesting depth of 2, and will therefore pass if your `max` is less than or equal to 2:
-
- <!-- prettier-ignore -->
- ```css
- a {
- b { /* 1 */
- .foo {} /* 2 */
- }
- }
-
- @media print { /* ignored */
- a {
- b { /* 1 */
- .foo {} /* 2 */
- }
- }
- }
- ```
-
- This rule integrates into stylelint's core the functionality of the (now deprecated) plugin [`stylelint-statement-max-nesting-depth`](https://github.com/davidtheclark/stylelint-statement-max-nesting-depth).
-
- ## Options
-
- `int`: Maximum nesting depth allowed.
-
- For example, with `2`:
-
- The following patterns are considered violations:
-
- <!-- prettier-ignore -->
- ```css
- a {
- & .foo { /* 1 */
- &__foo { /* 2 */
- & > .bar {} /* 3 */
- }
- }
- }
- ```
-
- <!-- prettier-ignore -->
- ```css
- a {
- @media print { /* 1 */
- & .foo { /* 2 */
- & .bar {} /* 3 */
- }
- }
- }
- ```
-
- The following patterns are _not_ considered violations:
-
- <!-- prettier-ignore -->
- ```css
- a {
- & .foo { /* 1 */
- &__foo {} /* 2 */
- }
- }
-
- a .foo__foo .bar .baz {}
- ```
-
- <!-- prettier-ignore -->
- ```css
- @media print {
- a {
- & .foo { /* 1 */
- &__foo {} /* 2 */
- }
- }
- }
- ```
-
- ## Optional secondary options
-
- ### `ignore: ["blockless-at-rules"]`
-
- Ignore at-rules that only wrap other rules, and do not themselves have declaration blocks.
-
- For example, with `1`:
-
- The following patterns are considered violations:
-
- As the at-rules have a declarations blocks.
-
- <!-- prettier-ignore -->
- ```css
- a {
- &:hover { /* 1 */
- @media (min-width: 500px) { color: pink; } /* 2 */
- }
- }
- ```
-
- <!-- prettier-ignore -->
- ```css
- a {
- @nest > b { /* 1 */
- .foo { color: pink; } /* 2 */
- }
- }
- ```
-
- The following patterns are _not_ considered violations:
-
- As all of the following `.foo` rules would have a nesting depth of just 1.
-
- <!-- prettier-ignore -->
- ```css
- a {
- .foo { color: pink; } /* 1 */
- }
- ```
-
- <!-- prettier-ignore -->
- ```css
- @media print { /* ignored regardless of options */
- a {
- .foo { color: pink; } /* 1 */
- }
- }
- ```
-
- <!-- prettier-ignore -->
- ```css
- a {
- @media print { /* ignored because it's an at-rule without a declaration block of its own */
- .foo { color: pink; } /* 1 */
- }
- }
- ```
-
- ### `ignore: ["pseudo-classes"]`
-
- Ignore rules where the first selector in each selector list item is a pseudo-class
-
- For example, with `1`:
-
- The following patterns are considered violations:
-
- <!-- prettier-ignore -->
- ```css
- .a {
- .b { /* 1 */
- .c { /* 2 */
- top: 0;
- }
- }
- }
- ```
-
- <!-- prettier-ignore -->
- ```css
- .a {
- &:hover { /* ignored */
- .b { /* 1 */
- .c { /* 2 */
- top: 0;
- }
- }
- }
- }
- ```
-
- <!-- prettier-ignore -->
- ```css
- .a {
- .b { /* 1 */
- &::selection { /* 2 */
- color: #64FFDA;
- }
- }
- }
- ```
-
- <!-- prettier-ignore -->
- ```css
- .a {
- .b { /* 1 */
- &:hover, .c { /* 2 */
- top: 0;
- }
- }
- }
- ```
-
- The following patterns are _not_ considered violations:
-
- As all of the following pseudoclasses rules would have a nesting depth of just 1.
-
- <!-- prettier-ignore -->
- ```css
- .a {
- .b { /* 1 */
- &:hover { /* ignored */
- top: 0;
- }
- }
- }
- ```
-
- <!-- prettier-ignore -->
- ```css
- .a {
- .b { /* 1 */
- &:nest {
- &:nest-lvl2 { /* ignored */
- top: 0;
- }
- }
- }
- }
- ```
-
- <!-- prettier-ignore -->
- ```css
- .a {
- &:hover { /* ignored */
- .b { /* 1 */
- top: 0;
- }
- }
- }
- ```
-
- <!-- prettier-ignore -->
- ```css
- .a {
- &:nest { /* ignored */
- &:nest-lvl2 { /* ignored */
- top: 0;
- .b { /* 1 */
- bottom: 0;
- }
- }
- }
- }
- ```
-
- <!-- prettier-ignore -->
- ```css
- .a {
- .b { /* 1 */
- &:hover, &:focus { /* ignored */
- top: 0;
- }
- }
- }
- ```
-
- ### `ignoreAtRules: ["/regex/", /regex/, "string"]`
-
- Ignore the specified at-rules.
-
- For example, with `1` and given:
-
- ```
- ["/^my-/", "media"]
- ```
-
- The following patterns are _not_ considered violations:
-
- <!-- prettier-ignore -->
- ```css
- a {
- @media print { /* 1 */
- b { /* 2 */
- c { top: 0; } /* 3 */
- }
- }
- }
- ```
-
- <!-- prettier-ignore -->
- ```css
- a {
- b { /* 1 */
- @media print { /* 2 */
- c { top: 0; } /* 3 */
- }
- }
- }
- ```
-
- <!-- prettier-ignore -->
- ```css
- a {
- @my-at-rule print { /* 1 */
- b { /* 2 */
- c { top: 0; } /* 3 */
- }
- }
- }
- ```
-
- <!-- prettier-ignore -->
- ```css
- a {
- @my-other-at-rule print { /* 1 */
- b { /* 2 */
- c { top: 0; } /* 3 */
- }
- }
- }
- ```
-
- The following patterns are considered violations:
-
- <!-- prettier-ignore -->
- ```css
- a {
- @import print { /* 1 */
- b { top: 0; } /* 2 */
- }
- }
- ```
-
- <!-- prettier-ignore -->
- ```css
- a {
- @not-my-at-rule print { /* 1 */
- b { top: 0; } /* 2 */
- }
- }
- ```
|