Skip to content

Commit 5a9716f

Browse files
committed
Update README.md: some options
always-semicolon.js block-indent.js colon-space.js
1 parent bb14699 commit 5a9716f

File tree

1 file changed

+49
-1
lines changed

1 file changed

+49
-1
lines changed

README.md

Lines changed: 49 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,6 @@ To run `csscomb`, you can use the following command from the project root:
3131
`csscomb` is configured using `.csscomb.json` file, located in the project root.
3232
3333
Example configuration:
34-
3534
```json
3635
{
3736
"exclude": ["node_modules/**"],
@@ -44,6 +43,55 @@ Example configuration:
4443
}
4544
```
4645
46+
## Options
47+
48+
### always-semicolon
49+
50+
Available value: `{Boolean}` true
51+
52+
Example: `{ "always-semicolon": true }`
53+
```css
54+
/* before */
55+
a { color: red }
56+
57+
/* after */
58+
a { color: red; }
59+
```
60+
61+
### block-indent
62+
63+
Available values:
64+
* `{Boolean}` true
65+
* `{Number}` of spaces
66+
* `{String}` of space characters (`/[ \t]*`)
67+
68+
Example: `{ "block-indent": 2 }`
69+
```css
70+
/* before */
71+
a { color: red }
72+
@media all { a { color: green } }
73+
74+
/* after */
75+
a { color: red }
76+
@media all {
77+
a { color: green }
78+
}
79+
```
80+
81+
### colon-space
82+
Available values:
83+
* `{Boolean}` true (means `after`)
84+
* `{String}`: `before`, `after` or `both`
85+
86+
Example: `{ "colon-space": true }`
87+
```css
88+
/* before */
89+
a { color:red }
90+
91+
/* after */
92+
a { color: red }
93+
```
94+
4795
## Tests
4896
4997
Run `npm test` for tests.

0 commit comments

Comments
 (0)