-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit f19e960
Showing
6 changed files
with
497 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# editorconfig.org | ||
root = true | ||
|
||
[*] | ||
indent_style = space | ||
indent_size = 2 | ||
end_of_line = lf | ||
charset = utf-8 | ||
trim_trailing_whitespace = true | ||
insert_final_newline = false | ||
|
||
[*.md] | ||
trim_trailing_whitespace = false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
node_modules | ||
package-lock.json |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2020, Aymeric Assier and Julien Martins Da Costa. | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,77 @@ | ||
# Stylelint config | ||
|
||
> The recommended stylelint config for scss files. | ||
It turns on all the [_possible errors_](https://stylelint.io/user-guide/rules#possible-errors) rules within stylelint. | ||
|
||
- **SCSS Property**: Use `stylelint-scss` plugin. Explore this project on [Github](https://github.com/kristerkari/stylelint-scss). | ||
|
||
- **Property Ordering**: Extends `stylelint-config-property-sort-order-smacss`. Refer to [here](https://github.com/cahamilton/css-property-sort-order-smacss/blob/master/index.js) for the comprehensive list of property orders. | ||
|
||
## Installation | ||
|
||
```bash | ||
npm install stylelint stylelint-scss stylelint-config-property-sort-order-smacss stylelint-order @wide/stylelint-config --save-dev | ||
``` | ||
|
||
## Usage | ||
|
||
If you've installed `@wide/stylelint-config` locally within your project, just set your `stylelint` config to: | ||
|
||
```json | ||
{ | ||
"extends": "@wide/stylelint-config" | ||
} | ||
``` | ||
|
||
### Extending the config | ||
|
||
Simply add a `"rules"` key to your config, then add your overrides and additions there. | ||
|
||
For example, to change the `at-rule-no-unknown` rule to use its `ignoreAtRules` option, turn off the `block-no-empty` rule, and add the `unit-whitelist` rule: | ||
|
||
```json | ||
{ | ||
"extends": "@wide/stylelint-config", | ||
"rules": { | ||
"at-rule-no-unknown": [ | ||
true, | ||
{ | ||
"ignoreAtRules": ["extends"] | ||
} | ||
], | ||
"block-no-empty": null, | ||
"unit-whitelist": ["em", "rem", "s"] | ||
} | ||
} | ||
``` | ||
|
||
### Stylelint CLI | ||
Use Stylelint CLI to check the supported files. Drop this line into your package.json and customize it as your needs: | ||
|
||
```json | ||
{ | ||
"scripts": { | ||
"lint:scss": "stylelint src/**/*.scss --formatter verbose" | ||
} | ||
} | ||
``` | ||
|
||
## Thanks | ||
- [stylelint](https://github.com/stylelint/stylelint) | ||
- [stylelint-config-property-sort-order-smacss](https://github.com/cahamilton/stylelint-config-property-sort-order-smacss) | ||
- [stylelint-order](https://github.com/hudochenkov/stylelint-order) | ||
- [stylelint-scss](https://github.com/kristerkari/stylelint-scss) | ||
|
||
## Authors | ||
|
||
- **Aymeric Assier** - [github.com/myeti](https://github.com/myeti) | ||
- **Julien Martins Da Costa** - [github.com/jdacosta](https://github.com/jdacosta) | ||
|
||
### Contributors | ||
|
||
- **Sébastien Robillard** - [github.com/robiseb](https://github.com/robiseb) | ||
|
||
## License | ||
|
||
This project is licensed under the MIT License - see the [licence](licence) file for details |
Oops, something went wrong.