stylelint-config-epiloque
v1.0.1
Published
shareable config for stylelint
Downloads
1
Maintainers
Readme
stylelint-config-standard
The standard shareable config for stylelint.
Use it as is or as a foundation for your own config.
It is derived from the common rules found within a handful of CSS styleguides, including: The Idiomatic CSS Principles, Github's PrimerCSS Guidelines, Google's CSS Style Guide, Airbnb's Styleguide, and @mdo's Code Guide.
It favours flexibility over strictness for things like multi-line lists and single-line rulesets, and tries to avoid potentially divisive rules.
Example
/**
* Multi-line comment
*/
.selector-1,
.selector-2,
.selector-3[type="text"] {
background: linear-gradient(#fff, rgba(0, 0, 0, 0.8));
box-sizing: border-box;
display: block;
color: #333;
}
.selector-a,
.selector-b {
padding: 10px !important;
top: calc(calc(1em * 2) / 3);
}
.selector-x { width: 10%; }
.selector-y { width: 20%; }
.selector-z { width: 30%; }
/* Single-line comment */
@media (min-width >= 60em) {
.selector {
/* Flush to parent comment */
transform: translate(1, 1) scale(3);
}
}
@media (min-orientation: portrait), projection and (color) {
.selector-i + .selector-ii {
background: color(rgb(0, 0, 0) lightness(50%));
font-family: helvetica, arial, sans-serif;
}
}
/* Flush single line comment */
@media screen and (min-device-pixel-ratio: 2),
screen and (min-resolution: 192dpi),
screen and (min-resolution: 2dppx) {
.selector {
background-image:
repeating-linear-gradient(
-45deg,
transparent,
#fff 25px,
rgba(255, 255, 255, 1) 50px
);
margin: 10px;
margin-bottom: 5px;
box-shadow:
0 1px 1px #000,
0 1px 0 #fff,
2px 2px 1px 1px #ccc inset;
height: 10rem;
}
/* Flush nested single line comment */
.selector::after {
content: "→";
background-image: url("x.svg");
}
}
Note: the config is tested against this example, as such the example contains plenty of CSS syntax, formatting and features.
Installation
$ npm install stylelint-config-standard
Usage
If you've installed stylelint-config-standard
locally within your project, just set your stylelint
config to:
{
"extends": "stylelint-config-standard"
}
If you've globally installed stylelint-config-standard
using the -g
flag, then you'll need to use the absolute path to stylelint-config-standard
in your config e.g.
{
"extends": "/absolute/path/to/stylelint-config-standard"
}
Extending the config
Simply add a "rules"
key to your config and add your overrides there.
For example, to change the indentation
to tabs and turn off the number-leading-zero
rule:
{
"extends": "stylelint-config-standard",
"rules": {
"indentation": "tab",
"number-leading-zero": null
}
}