| Left: | ||
| Right: |
| OLD | NEW |
|---|---|
| (Empty) | |
| 1 # stylelint-config-eyeo | |
| 2 | |
| 3 A [Stylelint](https://stylelint.io) configuration that checks for compliance | |
| 4 with the [Adblock Plus coding style guide](https://adblockplus.org/coding-style# html-css) | |
| 5 which is used for all eyeo projects. | |
| 6 | |
| 7 ## Installation | |
| 8 | |
| 9 npm install -g stylelint | |
| 10 | |
| 11 This command requires administrator privileges so you might need to use `sudo`. | |
| 12 | |
| 13 Next, either install stylelint-config-eyeo within your project. For example: | |
| 14 | |
| 15 npm install --save-dev stylelint-config-eyeo | |
|
Thomas Greiner
2017/09/15 16:58:29
Is this worth mentioning? Considering that there a
ire
2017/09/18 07:36:20
I was trying to follow the style that was used in
Thomas Greiner
2017/11/14 13:18:31
Sounds reasonable.
| |
| 16 | |
| 17 Or, install stylelint-config-eyeo globally. For example: | |
| 18 | |
| 19 npm install --g stylelint-config-eyeo | |
|
Thomas Greiner
2017/09/15 16:58:29
Detail: This should be either `-g` or `--global`.
ire
2017/09/18 07:36:20
Good catch, I meant `-g`. Done.
| |
| 20 | |
| 21 ## Usage | |
| 22 | |
| 23 To lint a CSS (or CSS-like, e.g. SCSS, SugarCSS, Less) file using Stylelint | |
| 24 you run the `stylelint` command with the file as an argument. For example: | |
| 25 | |
| 26 stylelint example.css | |
| 27 | |
| 28 For advanced usage see `stylelint --help`. | |
| 29 | |
| 30 In order to use stylelint-config-eyeo, your project's Stylelint configuration | |
| 31 should extend from it. A minimal example looks like this: | |
| 32 | |
| 33 { | |
| 34 "extends": "stylelint-config-eyeo" | |
| 35 } | |
| 36 | |
| 37 If you've globally installed stylelint-config-eyeo using the `-g` flag, then | |
| 38 you'll need to use the absolute path to stylelint-config-eyeo in your config. | |
| 39 | |
| 40 { | |
| 41 "extends": "/absolute/path/to/stylelint-config-eyeo" | |
| 42 } | |
| 43 | |
| 44 For projects without a Stylelint configuration you can create your own | |
| 45 personal configuration in `~/.stylelintrc.json`. | |
| OLD | NEW |