Prepare 23.0.0 #198
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
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 |
|---|---|---|
|
|
@@ -2,43 +2,45 @@ | |
|
|
||
| [](https://www.npmjs.org/package/stylelint-config-standard) [](https://github.com/stylelint/stylelint-config-standard/actions) | ||
|
|
||
| > The standard shareable config for Stylelint. | ||
| Extends [`stylelint-config-recommended`](https://github.com/stylelint/stylelint-config-recommended). | ||
|
|
||
| Turns on additional rules to enforce common conventions found in the specifications and in a handful of CSS styleguides, including: [The Idiomatic CSS Principles](https://github.com/necolas/idiomatic-css), | ||
| [Google's CSS Style Guide](https://google.github.io/styleguide/htmlcssguide.html#CSS_Formatting_Rules), [Airbnb's Styleguide](https://github.com/airbnb/css#css), and [@mdo's Code Guide](https://codeguide.co/#css). | ||
|
|
||
| It favours flexibility over strictness for things like multi-line lists and single-line rulesets. | ||
|
|
||
| To see the rules that this config uses, please read the [config itself](./index.js). | ||
|
|
||
| ## Example | ||
|
|
||
| <!-- prettier-ignore --> | ||
| ```css | ||
| @import url("x.css"); | ||
| @import url("y.css"); | ||
|
|
||
| /** | ||
| * Multi-line comment | ||
| */ | ||
|
|
||
| :root { | ||
| --brand-red: hsl(5deg 10% 40%); | ||
|
There was a problem hiding this comment. We can add an example of modern custom properties. |
||
| } | ||
|
|
||
| .selector-1, | ||
| .selector-2, | ||
| .selector-3[type="text"] { | ||
| background: linear-gradient(#fff, rgb(0 0 0 / 80%)); | ||
| box-sizing: border-box; | ||
| display: block; | ||
| color: var(--brand-red); | ||
| } | ||
|
|
||
| .selector-a, | ||
| .selector-b:not(:first-child) { | ||
| padding: 10px !important; | ||
| top: calc(100% - 2rem); | ||
|
Comment on lines
-41
to
+43
There was a problem hiding this comment. We can remove this odd nested |
||
| } | ||
|
|
||
| .selector-x { width: 10%; } | ||
|
|
@@ -47,7 +49,7 @@ To see the rules that this config uses, please read the [config itself](./index. | |
|
|
||
| /* Single-line comment */ | ||
|
|
||
| @media (width >= 60em) { | ||
| .selector { | ||
| /* Flush to parent comment */ | ||
| transform: translate(1, 1) scale(3); | ||
|
|
@@ -56,8 +58,8 @@ To see the rules that this config uses, please read the [config itself](./index. | |
|
|
||
| @media (orientation: portrait), projection and (color) { | ||
| .selector-i + .selector-ii { | ||
| background: hsl(20deg 25% 33%); | ||
|
Comment on lines
-59
to
+61
There was a problem hiding this comment. We can remove this old Incidentally, the upcoming relative color syntax looks great! |
||
| font-family: Helvetica, "Arial Black", sans-serif; | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -66,12 +68,13 @@ To see the rules that this config uses, please read the [config itself](./index. | |
| screen and (min-resolution: 192dpi), | ||
| screen and (min-resolution: 2dppx) { | ||
| .selector { | ||
| animation: 3s none fade-in; | ||
| background-image: | ||
| repeating-linear-gradient( | ||
| -45deg, | ||
| transparent, | ||
| #fff 25px, | ||
| rgb(255 255 255 / 100%) 50px | ||
| ); | ||
| margin: 10px; | ||
| margin-bottom: 5px; | ||
|
|
@@ -84,10 +87,15 @@ To see the rules that this config uses, please read the [config itself](./index. | |
|
|
||
| /* Flush nested single line comment */ | ||
| .selector::after { | ||
| content: "→"; | ||
| background-image: url("x.svg"); | ||
| } | ||
| } | ||
|
|
||
| @keyframes fade-in { | ||
| from { opacity: 0%; } | ||
| to { opacity: 100%; } | ||
| } | ||
| ``` | ||
|
|
||
| _Note: the config is tested against this example, as such the example contains plenty of CSS syntax, formatting and features._ | ||
|
|
@@ -100,35 +108,46 @@ npm install stylelint-config-standard --save-dev | |
|
|
||
| ## Usage | ||
|
|
||
|
There was a problem hiding this comment. We can take out this legacy guidance. |
||
| Set your stylelint config to: | ||
|
|
||
| ```json | ||
| { | ||
| "extends": "stylelint-config-standard" | ||
| } | ||
| ``` | ||
|
|
||
| ### Extending the config | ||
|
|
||
| Add a `"rules"` key to your config, then add your overrides and additions there. | ||
|
|
||
| You can turn off rules by setting its value to `null`. For example: | ||
|
|
||
| ```json | ||
| { | ||
| "extends": "stylelint-config-standard", | ||
| "rules": { | ||
| "selector-class-pattern": null | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| Or lower the severity of a rule to a warning using the `severity` secondary option. For example: | ||
|
|
||
| ```json | ||
| { | ||
| "extends": "stylelint-config-standard", | ||
| "rules": { | ||
| "property-no-vendor-prefix": [ | ||
| true, | ||
| { | ||
| "severity": "warning" | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| A more complete example, to change the `at-rule-no-unknown` rule to use its `ignoreAtRules` option, change the `indentation` to tabs, turn off the `number-leading-zero` rule, set the severity of the `number-max-precision` rule to `warning`, and add the `unit-allowed-list` rule: | ||
|
|
||
| ```json | ||
| { | ||
|
|
@@ -137,11 +156,17 @@ For example, to change the `at-rule-no-unknown` rule to use its `ignoreAtRules` | |
| "at-rule-no-unknown": [ | ||
| true, | ||
| { | ||
| "ignoreAtRules": ["--my-at-rule"] | ||
| } | ||
| ], | ||
| "indentation": "tab", | ||
| "number-leading-zero": null, | ||
| "number-max-precision": [ | ||
| 4, | ||
| { | ||
| "severity": "warning" | ||
| } | ||
| ], | ||
| "unit-allowed-list": ["em", "rem", "s"] | ||
| } | ||
| } | ||
|
|
@@ -151,24 +176,22 @@ For example, to change the `at-rule-no-unknown` rule to use its `ignoreAtRules` | |
|
|
||
| `stylelint-config-standard` is a great foundation for your own config. You can extend it to create a tailored and much stricter config: | ||
|
|
||
| - Manage specificity using: | ||
| - [`max-nesting-depth`](https://github.com/stylelint/stylelint/blob/master/lib/rules/max-nesting-depth/README.md) | ||
| - [`selector-max-attribute`](https://github.com/stylelint/stylelint/blob/master/lib/rules/selector-max-attribute/README.md) | ||
| - [`selector-max-class`](https://github.com/stylelint/stylelint/blob/master/lib/rules/selector-max-class/README.md) | ||
| - [`selector-max-combinators`](https://github.com/stylelint/stylelint/blob/master/lib/rules/selector-max-combinators/README.md) | ||
| - [`selector-max-compound-selectors`](https://github.com/stylelint/stylelint/blob/master/lib/rules/selector-max-compound-selectors/README.md) | ||
| - [`selector-max-id`](https://github.com/stylelint/stylelint/blob/master/lib/rules/selector-max-id/README.md) | ||
| - [`selector-max-pseudo-class`](https://github.com/stylelint/stylelint/blob/master/lib/rules/selector-max-pseudo-class/README.md) | ||
| - [`selector-max-specificity`](https://github.com/stylelint/stylelint/blob/master/lib/rules/selector-max-specificity/README.md) | ||
| - [`selector-max-type`](https://github.com/stylelint/stylelint/blob/master/lib/rules/selector-max-type/README.md) | ||
| - [`selector-max-universal`](https://github.com/stylelint/stylelint/blob/master/lib/rules/selector-max-universal/README.md) | ||
| - [`selector-no-qualifying-type`](https://github.com/stylelint/stylelint/blob/master/lib/rules/selector-no-qualifying-type/README.md) | ||
| - Specify acceptable selector types, units, properties, functions and words in comments using: | ||
| - [`at-rule-disallowed-list`](https://github.com/stylelint/stylelint/blob/master/lib/rules/at-rule-disallowed-list/README.md) | ||
| - [`at-rule-allowed-list`](https://github.com/stylelint/stylelint/blob/master/lib/rules/at-rule-allowed-list/README.md) | ||
| - [`at-rule-property-required-list`](https://github.com/stylelint/stylelint/blob/master/lib/rules/at-rule-property-required-list/README.md) | ||
| - [`color-named`](https://github.com/stylelint/stylelint/blob/master/lib/rules/color-named/README.md) | ||
| - [`color-no-hex`](https://github.com/stylelint/stylelint/blob/master/lib/rules/color-no-hex/README.md) | ||
| - [`comment-word-disallowed-list`](https://github.com/stylelint/stylelint/blob/master/lib/rules/comment-word-disallowed-list/README.md) | ||
|
|
@@ -189,55 +212,18 @@ For example, to change the `at-rule-no-unknown` rule to use its `ignoreAtRules` | |
| - [`selector-attribute-operator-allowed-list`](https://github.com/stylelint/stylelint/blob/master/lib/rules/selector-attribute-operator-allowed-list/README.md) | ||
| - [`selector-combinator-disallowed-list`](https://github.com/stylelint/stylelint/blob/master/lib/rules/selector-combinator-disallowed-list/README.md) | ||
| - [`selector-combinator-allowed-list`](https://github.com/stylelint/stylelint/blob/master/lib/rules/selector-combinator-allowed-list/README.md) | ||
| - [`selector-pseudo-class-disallowed-list`](https://github.com/stylelint/stylelint/blob/master/lib/rules/selector-pseudo-class-disallowed-list/README.md) | ||
| - [`selector-pseudo-class-allowed-list`](https://github.com/stylelint/stylelint/blob/master/lib/rules/selector-pseudo-class-allowed-list/README.md) | ||
| - [`selector-pseudo-element-disallowed-list`](https://github.com/stylelint/stylelint/blob/master/lib/rules/selector-pseudo-element-disallowed-list/README.md) | ||
| - [`selector-pseudo-element-allowed-list`](https://github.com/stylelint/stylelint/blob/master/lib/rules/selector-pseudo-element-allowed-list/README.md) | ||
| - [`unit-disallowed-list`](https://github.com/stylelint/stylelint/blob/master/lib/rules/unit-disallowed-list/README.md) | ||
| - [`unit-allowed-list`](https://github.com/stylelint/stylelint/blob/master/lib/rules/unit-allowed-list/README.md) | ||
| - Specify acceptable patterns using: | ||
| - [`selector-nested-pattern`](https://github.com/stylelint/stylelint/blob/master/lib/rules/selector-nested-pattern/README.md) | ||
| - Specify a notation for font weights using: | ||
| - [`font-weight-notation`](https://github.com/stylelint/stylelint/blob/master/lib/rules/font-weight-notation/README.md) | ||
| - Specify what types of URLs are allowed using: | ||
| - [`function-url-no-scheme-relative`](https://github.com/stylelint/stylelint/blob/master/lib/rules/function-url-no-scheme-relative/README.md) | ||
|
There was a problem hiding this comment. We can take this section out as we'll be encouraging users to adopt appropriate shared-configs for their language of choice. |
||
|
|
||
| ## [Changelog](CHANGELOG.md) | ||
|
|
||
|
|
||
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
File renamed without changes.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We can take this second line out as we encourage users (lower down the README) to extend the config with more rules that limit language features, e.g.
unit-allowed-list. These are some of the most useful, unique and powerful rules in stylelint. We should encourage users to investigate them. They tend to be specific to teams and projects, so we can't add them to this config.