.gitignore added
[dotfiles/.git] / .config / coc / extensions / node_modules / coc-prettier / node_modules / stylelint / lib / rules / max-empty-lines / README.md
1 # max-empty-lines
2
3 Limit the number of adjacent empty lines.
4
5 ```css
6 a {}
7      /* ← */
8      /* ← */
9 a {} /* ↑ */
10 /**     ↑
11  * These lines */
12 ```
13
14 ## Options
15
16 `int`: Maximum number of characters allowed.
17
18 For example, with `2`:
19
20 The following patterns are considered violations:
21
22 ```css
23 a {}
24
25
26
27 b {}
28 ```
29
30 Comment strings are also checked -- so the following is a violation:
31
32 ```css
33 /**
34  * Call me Ishmael.
35  *
36  *
37  *
38  * Some years ago -- never mind how log precisely -- ...
39  */
40 ```
41
42 The following patterns are *not* considered violations:
43
44 ```css
45 a {}
46 b {}
47 ```
48
49 ```css
50 a {}
51
52 b {}
53 ```
54
55 ```css
56 a {}
57
58
59 b {}
60 ```
61
62 ## Optional secondary options
63
64 ### `ignore: ["comments"]`
65
66 Only enforce the adjacent empty lines limit for lines that are not comments.
67
68 For example, with `2` adjacent empty lines:
69
70 The following patterns are considered violations:
71
72 ```css
73 /* horse */
74 a {}
75
76
77
78 b {}
79 ```
80
81 The following patterns are *not* considered violations:
82
83 ```css
84 /**
85  * Call me Ishmael.
86  *
87  *
88  *
89  * Some years ago -- never mind how log precisely -- ...
90  */
91 ```
92
93 ```css
94 a { 
95     /**
96     * Comment 
97     *
98     *
99     *
100     * inside the declaration with a lot of empty lines...
101     */
102      color: pink; 
103 }
104 ```