From b5e9c618eb9c787592695bec2275fef788f07c39 Mon Sep 17 00:00:00 2001 From: Nikita Almanov <131481562+nikkeyl@users.noreply.github.com> Date: Tue, 20 Feb 2024 08:33:24 +0300 Subject: [PATCH] docs: rewrite text --- CONTRIBUTING.md | 6 +- README.md | 146 +++++++++++++++++++++++++++--------------------- 2 files changed, 86 insertions(+), 66 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b928886..f5b184e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -138,12 +138,12 @@ Once it's filed: - A team member will try to reproduce the **Issue** with your provided steps. If there are no reproduction steps or no obvious way to reproduce - the **Issue**, the team will ask you for those steps and mark the **Issue* - as **`needs-repro`**. Bugs with the **`needs-repro`** tag will not be + the **Issue**, the team will ask you for those steps and mark the **Issue** + as `needs-repro`. Bugs with the `needs-repro` tag will not be addressed until they are reproduced. - If the team is able to reproduce the **Issue**, it will be marked - **`needs-fix`**, as well as possibly other tags (such as **`critical`**), + `needs-fix`, as well as possibly other tags (such as `critical`), and the **Issue** will be left to be [**implemented by someone**](#your-first-code-contribution). diff --git a/README.md b/README.md index eb01c28..a29eaf7 100644 --- a/README.md +++ b/README.md @@ -34,46 +34,46 @@ ### Extends -- Extends the [**`stylelint-config-standard-scss`** shared config](https://github.com/stylelint-scss/stylelint-config-standard-scss) +- Extends the [`stylelint-config-standard-scss` shared config](https://github.com/stylelint-scss/stylelint-config-standard-scss) and configures it's rules for **SCSS**. ### Plugins -- [**`stylelint-declaration-block-no-ignored-properties`**](https://github.com/kristerkari/stylelint-declaration-block-no-ignored-properties) +- [`stylelint-declaration-block-no-ignored-properties`](https://github.com/kristerkari/stylelint-declaration-block-no-ignored-properties) disallow property values that are ignored due to another property value in the same rule. - > Use **`.browserslistrc`**. + > Use `.browserslistrc`. -- [**`stylelint-gamut`**](https://github.com/fpetrakov/stylelint-gamut) +- [`stylelint-gamut`](https://github.com/fpetrakov/stylelint-gamut) throw warning if color goes out of **sRGB** - color space and is not wrapped in **`@media (color-gamut: p3) {}`** - or **`@media (color-gamut: rec2020) {}`** + color space and is not wrapped in `@media (color-gamut: p3) {}` + or `@media (color-gamut: rec2020) {}` -- [**`stylelint-group-selectors`**](https://github.com/ssivanatarajan/stylelint-group-selectors) +- [`stylelint-group-selectors`](https://github.com/ssivanatarajan/stylelint-group-selectors) identify the selectors, which can be grouped, as they have same set of properties and values. -- [**`stylelint-high-performance-animation`**](https://github.com/kristerkari/stylelint-high-performance-animation) +- [`stylelint-high-performance-animation`](https://github.com/kristerkari/stylelint-high-performance-animation) enhances your animations. -- [**`stylelint-no-unsupported-browser-features`**](https://github.com/ismay/stylelint-no-unsupported-browser-features) +- [`stylelint-no-unsupported-browser-features`](https://github.com/ismay/stylelint-no-unsupported-browser-features) disallow features that aren't supported by your target browser audience. -- [**`stylelint-order`**](https://github.com/hudochenkov/stylelint-order) +- [`stylelint-order`](https://github.com/hudochenkov/stylelint-order) sorts **over 400 properties** for enhanced clarity and maintainability. > Properties are grouped into logical groups and separated by a space. -- [**`stylelint-plugin-defensive-css`**](https://github.com/yuschick/stylelint-plugin-defensive-css) +- [`stylelint-plugin-defensive-css`](https://github.com/yuschick/stylelint-plugin-defensive-css) for enforcing defensive **CSS** best practices. -- [**`stylelint-plugin-logical-css`**](https://github.com/yuschick/stylelint-plugin-logical-css) +- [`stylelint-plugin-logical-css`](https://github.com/yuschick/stylelint-plugin-logical-css) replace properties with logical alternatives. -- [**`stylelint-prettier`**](https://github.com/prettier/stylelint-prettier) +- [`stylelint-prettier`](https://github.com/prettier/stylelint-prettier) runs **Prettier** as a **Stylelint** rule and reports - differences as individual Stylelint issues. + differences as individual **Stylelint** issues. ## Installation @@ -122,151 +122,171 @@ This is a list of the lints turned on in this configuration, and what they do. #### At-rule -- [**`at-rule-disallowed-list`**](https://stylelint.io/user-guide/rules/at-rule-disallowed-list): +- [`at-rule-disallowed-list`](https://stylelint.io/user-guide/rules/at-rule-disallowed-list): List of disallowed at-rules. - - Disallow the use of **`@debug`**. + - Disallow the use of `@debug`. #### Case -- [**`value-keyword-case`**](https://stylelint.io/user-guide/rules/value-keyword-case): +- [`value-keyword-case`](https://stylelint.io/user-guide/rules/value-keyword-case): Lowercase for keywords values. - Ignore `**text-rendering**`. + Ignore `text-rendering`. #### Color -- [**`color-named`**](https://stylelint.io/user-guide/rules/color-named): +- [`color-named`](https://stylelint.io/user-guide/rules/color-named): Colors must never be named. #### Declaration -- [**`declaration-no-important`**](https://stylelint.io/user-guide/rules/declaration-no-important): - Disallow **`!important`** within declarations. +- [`declaration-no-important`](https://stylelint.io/user-guide/rules/declaration-no-important): + Disallow `!important` within declarations. #### Descending -- [**`no-descending-specificity`**](https://stylelint.io/user-guide/rules/no-descending-specificity): +- [`no-descending-specificity`](https://stylelint.io/user-guide/rules/no-descending-specificity): Rule disabled. #### Empty Lines -- [**`declaration-empty-line-before`**](https://stylelint.io/user-guide/rules/declaration-empty-line-before): - The rule is disabled for **`stylelint-order`** to work correctly. +- [`declaration-empty-line-before`](https://stylelint.io/user-guide/rules/declaration-empty-line-before): + The rule is disabled for `stylelint-order` to work correctly. #### Function -- [**`function-url-no-scheme-relative`**](https://stylelint.io/user-guide/rules/function-url-no-scheme-relative): +- [`function-url-no-scheme-relative`](https://stylelint.io/user-guide/rules/function-url-no-scheme-relative): Disallow scheme-relative **URLs**. #### Max & Min -- [**`max-nesting-depth`**](https://stylelint.io/user-guide/rules/max-nesting-depth): +- [`max-nesting-depth`](https://stylelint.io/user-guide/rules/max-nesting-depth): Limit the allowed nesting depth to `3`. - Ignore: **`'blockless-at-rules'`**. + Ignore: `'blockless-at-rules'`. -- [**`selector-max-combinators`**](https://stylelint.io/user-guide/rules/selector-max-combinators): +- [`selector-max-combinators`](https://stylelint.io/user-guide/rules/selector-max-combinators): Limit the allowed combinators to `4`. -- [**`selector-max-compound-selectors`**](https://stylelint.io/user-guide/rules/selector-max-compound-selectors): +- [`selector-max-compound-selectors`](https://stylelint.io/user-guide/rules/selector-max-compound-selectors): Limit the allowed compound selectors to `3`. -- [**`selector-max-universal`**](https://stylelint.io/user-guide/rules/selector-max-universal): +- [`selector-max-universal`](https://stylelint.io/user-guide/rules/selector-max-universal): Limit the allowed universal selector to `1`. #### Notation -- [**`font-weight-notation`**](https://stylelint.io/user-guide/rules/font-weight-notation): +- [`font-weight-notation`](https://stylelint.io/user-guide/rules/font-weight-notation): Numeric notation for font weights. -- [**`keyframe-selector-notation`**](https://stylelint.io/user-guide/rules/keyframe-selector-notation): +- [`keyframe-selector-notation`](https://stylelint.io/user-guide/rules/keyframe-selector-notation): Percentage notation for keyframe selectors. #### Pattern -- [**`selector-class-pattern`**](https://stylelint.io/user-guide/rules/selector-class-pattern): +- [`selector-class-pattern`](https://stylelint.io/user-guide/rules/selector-class-pattern): **BEM** naming convention likely enforced, encouraging modularity, maintainability, and clarity in class naming. #### Selector -- [**`selector-no-qualifying-type`**](https://stylelint.io/user-guide/rules/selector-no-qualifying-type): +- [`selector-no-qualifying-type`](https://stylelint.io/user-guide/rules/selector-no-qualifying-type): Disallow qualifying a selector by type. #### Unknown -- [**`media-feature-name-value-no-unknown`**](https://stylelint.io/user-guide/rules/media-feature-name-value-no-unknown): +- [`media-feature-name-value-no-unknown`](https://stylelint.io/user-guide/rules/media-feature-name-value-no-unknown): Disallow unknown values for media features. -- [**`no-unknown-animations`**](https://stylelint.io/user-guide/rules/no-unknown-animations): +- [`no-unknown-animations`](https://stylelint.io/user-guide/rules/no-unknown-animations): Disallow unknown animations. ### SCSS #### At-rule -- [**`scss/at-function-named-arguments`**](https://github.com/stylelint-scss/stylelint-scss/tree/master/src/rules/at-function-named-arguments): +- [`scss/at-each-key-value-single-line`](https://github.com/stylelint-scss/stylelint-scss/tree/master/src/rules/at-each-key-value-single-line): + Each key value in the `@each` rule must be on a separate line. + +- [`scss/at-function-named-arguments`](https://github.com/stylelint-scss/stylelint-scss/tree/master/src/rules/at-function-named-arguments): Require named parameters in **SCSS** function call rule. - Ignore **`single-argument`**. + Ignore `single-argument`. -- [**`scss/at-mixin-named-arguments`**](https://github.com/stylelint-scss/stylelint-scss/tree/master/src/rules/at-mixin-named-arguments): +- [`scss/at-mixin-named-arguments`](https://github.com/stylelint-scss/stylelint-scss/tree/master/src/rules/at-mixin-named-arguments): Require named parameters in **at-mixin** call rule. - Ignore **`single-argument`**. + Ignore `single-argument`. -- [**`scss/at-root-no-redundant`**](https://github.com/stylelint-scss/stylelint-scss/tree/master/src/rules/at-root-no-redundant): - Disallow redundant **`@at-root`** rule. +- [`scss/at-root-no-redundant`](https://github.com/stylelint-scss/stylelint-scss/tree/master/src/rules/at-root-no-redundant): + Disallow redundant `@at-root` rule. -- [**`scss/at-use-no-redundant-alias`**](https://github.com/stylelint-scss/stylelint-scss/tree/master/src/rules/at-use-no-redundant-alias): - Disallow redundant **`@at-root`** rule. +- [`scss/at-use-no-redundant-alias`](https://github.com/stylelint-scss/stylelint-scss/tree/master/src/rules/at-use-no-redundant-alias): + Disallow redundant `@at-root` rule. #### Comment -- [**`scss/comment-no-loud`**](https://github.com/stylelint-scss/stylelint-scss/tree/master/src/rules/comment-no-loud): - Disallow **`/*`**-comments. +- [`scss/comment-no-loud`](https://github.com/stylelint-scss/stylelint-scss/tree/master/src/rules/comment-no-loud): + Disallow `/*`-comments. -- [**`scss/double-slash-comment-inline`**](https://github.com/stylelint-scss/stylelint-scss/tree/master/src/rules/double-slash-comment-inline): - Disallow **`//`**-comments to be inline comments. +- [`scss/double-slash-comment-inline`](https://github.com/stylelint-scss/stylelint-scss/tree/master/src/rules/double-slash-comment-inline): + Disallow `//`-comments to be inline comments. #### Declaration -- [**`scss/declaration-nested-properties`**](https://github.com/stylelint-scss/stylelint-scss/tree/master/src/rules/declaration-nested-properties): - Disallow properties with **`-`** in their names to be in a form +- [`scss/declaration-nested-properties`](https://github.com/stylelint-scss/stylelint-scss/tree/master/src/rules/declaration-nested-properties): + Disallow properties with `-` in their names to be in a form of a nested group. +- [`scss/dimension-no-non-numeric-values`](https://github.com/stylelint-scss/stylelint-scss/tree/master/src/rules/dimension-no-non-numeric-values): + Prevents the use of non-numeric values in dimensions. + #### Dollar Variable -- [**`scss/dollar-variable-colon-newline-after`**](https://github.com/stylelint-scss/stylelint-scss/tree/master/src/rules/dollar-variable-colon-newline-after): - Require a newline after the colon in **`$`**-variable declarations. +- [`scss/dollar-variable-colon-newline-after`](https://github.com/stylelint-scss/stylelint-scss/tree/master/src/rules/dollar-variable-colon-newline-after): + Require a newline after the colon in `$`-variable declarations. -- [**`scss/dollar-variable-no-namespaced-assignment`**](https://github.com/stylelint-scss/stylelint-scss/tree/master/src/rules/dollar-variable-no-namespaced-assignment): +- [`scss/dollar-variable-no-namespaced-assignment`](https://github.com/stylelint-scss/stylelint-scss/tree/master/src/rules/dollar-variable-no-namespaced-assignment): Disallow assignment to namespaced variables. -- [**`scss/no-duplicate-dollar-variables`**](https://github.com/stylelint-scss/stylelint-scss/tree/master/src/rules/no-duplicate-dollar-variables): +- [`scss/no-duplicate-dollar-variables`](https://github.com/stylelint-scss/stylelint-scss/tree/master/src/rules/no-duplicate-dollar-variables): Disallow duplicate dollar variables within a stylesheet. +#### Function + +- [`scss/function-color-relative`](https://github.com/stylelint-scss/stylelint-scss/tree/master/src/rules/function-color-relative): + Encourages the use of the `scale-color()` feature instead + of deprecated features: + - `darken()` + - `desaturate()` + - `fade-in()` + - `fade-out()` + - `lighten()` + - `opacify()` + - `saturate()` + - `transparentize()` + #### Import -- [**`scss/partial-no-import`**](https://github.com/stylelint-scss/stylelint-scss/tree/master/src/rules/partial-no-import): - Disallow non-CSS **`@imports`** in partial files. +- [`scss/partial-no-import`](https://github.com/stylelint-scss/stylelint-scss/tree/master/src/rules/partial-no-import): + Disallow non-CSS `@imports` in partial files. #### Maps -- [**`scss/map-keys-quotes`**](https://github.com/stylelint-scss/stylelint-scss/tree/master/src/rules/map-keys-quotes): +- [`scss/map-keys-quotes`](https://github.com/stylelint-scss/stylelint-scss/tree/master/src/rules/map-keys-quotes): Require quoted keys in **SASS** maps. #### Media -- [**`scss/media-feature-value-dollar-variable`**](https://github.com/stylelint-scss/stylelint-scss/tree/master/src/rules/media-feature-value-dollar-variable): - Require a media feature value be a **`$`**-variable. +- [`scss/media-feature-value-dollar-variable`](https://github.com/stylelint-scss/stylelint-scss/tree/master/src/rules/media-feature-value-dollar-variable): + Require a media feature value be a `$`-variable. #### Selector -- [**`scss/selector-no-redundant-nesting-selector`**](https://github.com/stylelint-scss/stylelint-scss/tree/master/src/rules/selector-no-redundant-nesting-selector): - Disallow redundant nesting selectors (**`&`**). +- [`scss/selector-no-redundant-nesting-selector`](https://github.com/stylelint-scss/stylelint-scss/tree/master/src/rules/selector-no-redundant-nesting-selector): + Disallow redundant nesting selectors (`&`). #### Unknown -- [**`scss/property-no-unknown`**](https://github.com/stylelint-scss/stylelint-scss/tree/master/src/rules/property-no-unknown): +- [`scss/property-no-unknown`](https://github.com/stylelint-scss/stylelint-scss/tree/master/src/rules/property-no-unknown): Disallow unknown properties. - Should be used instead of **Stylelint**'s **`property-no-unknown`**. + Should be used instead of **Stylelint**'s `property-no-unknown`. ## License