Add lang to code blocks in Markdown (#5299)

* Add lang to code blocks in Markdown This change aims to make documents more readable and avoid syntax errors by adding a language specifier to code blocks in Markdown. To perform this task efficiently, I use two remark plugins: - [remark-lint-code-block-syntax](https://github.com/ybiquitous/remark-lint-code-block-syntax) - [remark-lint-fenced-code-flag](https://github.com/remarkjs/remark-lint/tree/main/packages/remark-lint-fenced-code-flag) ```diff --- a/package.json +++ b/package.json @@ -66,7 +66,9 @@ }, "remarkConfig": { "plugins": [ - "@stylelint/remark-preset" + "@stylelint/remark-preset", + "remark-lint-code-block-syntax", + "remark-lint-fenced-code-flag" ] }, "jest": { @@ -189,6 +191,8 @@ "postcss-import": "^12.0.1", "prettier": "^2.2.1", "remark-cli": "^9.0.0", + "remark-lint-code-block-syntax": "^0.2.1", + "remark-lint-fenced-code-flag": "^2.0.1", "typescript": "^4.2.4" }, "engines": { ``` Note: I do not recommend the addition of the plugins because they produce false positives. * Remove deprecated files * Remove deprecated files again
stylelint · May 14, 2021 · 887f03e · 887f03e
1 parent e4b6141
commit 887f03e
Show file tree

Hide file tree

Showing 66 changed files with 94 additions and 92 deletions.
diff --git a/lib/rules/alpha-value-notation/README.md b/lib/rules/alpha-value-notation/README.md
@@ -81,7 +81,7 @@ For example with `"percentage"`.
 
 Given:
 
-```
+```json
 ["opacity"]
 ```
 

diff --git a/lib/rules/at-rule-allowed-list/README.md b/lib/rules/at-rule-allowed-list/README.md
@@ -15,7 +15,7 @@ Specify a list of allowed at-rules.
 
 Given:
 
-```
+```json
 ["extend", "keyframes"]
 ```
 

diff --git a/lib/rules/at-rule-disallowed-list/README.md b/lib/rules/at-rule-disallowed-list/README.md
@@ -15,7 +15,7 @@ Specify a list of disallowed at-rules.
 
 Given:
 
-```
+```json
 ["extend", "keyframes"]
 ```
 

diff --git a/lib/rules/at-rule-empty-line-before/README.md b/lib/rules/at-rule-empty-line-before/README.md
@@ -408,7 +408,7 @@ For example, with `"always"`.
 
 Given:
 
-```
+```json
 ["import"]
 ```
 

diff --git a/lib/rules/at-rule-no-unknown/README.md b/lib/rules/at-rule-no-unknown/README.md
@@ -52,7 +52,7 @@ The following patterns are _not_ considered violations:
 
 Given:
 
-```
+```json
 ["/^my-/", "custom"]
 ```
 

diff --git a/lib/rules/at-rule-property-required-list/README.md b/lib/rules/at-rule-property-required-list/README.md
@@ -15,7 +15,7 @@ Specify a list of required properties for an at-rule.
 
 Given:
 
-```
+```json
 {
   "font-face": ["font-display", "font-family", "font-style"]
 }

diff --git a/lib/rules/block-closing-brace-newline-after/README.md b/lib/rules/block-closing-brace-newline-after/README.md
@@ -173,7 +173,7 @@ For example, with `"always"` or `"always-multi-line"`.
 
 Given:
 
-```
+```json
 ["if", "else"]
 ```
 

diff --git a/lib/rules/block-opening-brace-space-before/README.md b/lib/rules/block-opening-brace-space-before/README.md
@@ -179,7 +179,7 @@ color: pink;}
 
 Given:
 
-```
+```json
 ["/fo/"]
 ```
 
@@ -200,7 +200,7 @@ The following patterns are _not_ considered violations:
 
 Given:
 
-```
+```json
 [":root"]
 ```
 

diff --git a/lib/rules/color-named/README.md b/lib/rules/color-named/README.md
@@ -148,7 +148,7 @@ For example with `"never"`.
 
 Given:
 
-```
+```json
 ["/^my-/", "composes"]
 ```
 

diff --git a/lib/rules/comment-empty-line-before/README.md b/lib/rules/comment-empty-line-before/README.md
@@ -172,8 +172,8 @@ Ignore comments matching the given regular expressions or strings.
 
 For example, with `"always"` and given:
 
-```
-[/^ignore/, "string-ignore"]
+```json
+["/^ignore/", "string-ignore"]
 ```
 
 The following comments are _not_ considered violations:

diff --git a/lib/rules/comment-pattern/README.md b/lib/rules/comment-pattern/README.md
@@ -17,7 +17,7 @@ A string will be translated into a RegExp like so `new RegExp(yourString)` —
 
 Given the string:
 
-```
+```json
 "foo .+"
 ```
 

diff --git a/lib/rules/comment-word-disallowed-list/README.md b/lib/rules/comment-word-disallowed-list/README.md
@@ -19,7 +19,7 @@ If a string is surrounded with `"/"` (e.g. `"/^TODO:/"`), it is interpreted as a
 
 Given:
 
-```
+```json
 ["/^TODO:/", "badword"]
 ```
 

diff --git a/lib/rules/custom-media-pattern/README.md b/lib/rules/custom-media-pattern/README.md
@@ -17,7 +17,7 @@ A string will be translated into a RegExp like so `new RegExp(yourString)` —
 
 Given the string:
 
-```
+```json
 "foo-.+"
 ```
 

diff --git a/lib/rules/custom-property-pattern/README.md b/lib/rules/custom-property-pattern/README.md
@@ -17,7 +17,7 @@ A string will be translated into a RegExp like so `new RegExp(yourString)` —
 
 Given the string:
 
-```
+```json
 "foo-.+"
 ```
 

diff --git a/lib/rules/declaration-block-no-duplicate-properties/README.md b/lib/rules/declaration-block-no-duplicate-properties/README.md
@@ -114,7 +114,7 @@ Ignore duplicates of specific properties.
 
 Given:
 
-```
+```json
 ["color", "/background-/"]
 ```
 

diff --git a/lib/rules/declaration-block-no-redundant-longhand-properties/README.md b/lib/rules/declaration-block-no-redundant-longhand-properties/README.md
@@ -151,7 +151,7 @@ a {
 
 Given:
 
-```
+```json
 ["padding", "/border/"]
 ```
 

diff --git a/lib/rules/declaration-property-unit-allowed-list/README.md b/lib/rules/declaration-property-unit-allowed-list/README.md
@@ -17,7 +17,7 @@ If a property name is surrounded with `"/"` (e.g. `"/^animation/"`), it is inter
 
 Given:
 
-```
+```json
 {
   "font-size": ["em", "px"],
   "/^animation/": ["s"],
@@ -92,14 +92,16 @@ Ignore units that are inside a function.
 
 For example, given:
 
-```
-{
-  "/^border/": ["px"],
-  "/^background/": ["%"],
-},
-{
-  "ignore": ["inside-function"],
-},
+```json
+[
+  {
+    "/^border/": ["px"],
+    "/^background/": ["%"]
+  },
+  {
+    "ignore": ["inside-function"]
+  }
+]
 ```
 
 The following patterns are _not_ considered violations:

diff --git a/lib/rules/declaration-property-unit-disallowed-list/README.md b/lib/rules/declaration-property-unit-disallowed-list/README.md
@@ -17,7 +17,7 @@ If a property name is surrounded with `"/"` (e.g. `"/^animation/"`), it is inter
 
 Given:
 
-```
+```json
 {
   "font-size": ["em", "px"],
   "/^animation/": ["s"]

diff --git a/lib/rules/declaration-property-value-allowed-list/README.md b/lib/rules/declaration-property-value-allowed-list/README.md
@@ -23,7 +23,7 @@ Be careful with regex matching not to accidentally consider quoted string values
 
 Given:
 
-```
+```json
 {
   "transform": ["/scale/"],
   "whitespace": ["nowrap"],

diff --git a/lib/rules/declaration-property-value-disallowed-list/README.md b/lib/rules/declaration-property-value-disallowed-list/README.md
@@ -21,7 +21,7 @@ Be careful with regex matching not to accidentally consider quoted string values
 
 Given:
 
-```
+```json
 {
   "transform": ["/scale3d/", "/rotate3d/", "/translate3d/"],
   "position": ["fixed"],

diff --git a/lib/rules/font-family-no-duplicate-names/README.md b/lib/rules/font-family-no-duplicate-names/README.md
@@ -59,7 +59,7 @@ a { font: normal 14px/32px -apple-system, BlinkMacSystemFont, sans-serif; }
 
 Given:
 
-```
+```json
 ["/^My Font /", "monospace"]
 ```
 

diff --git a/lib/rules/font-family-no-missing-generic-family-keyword/README.md b/lib/rules/font-family-no-missing-generic-family-keyword/README.md
@@ -70,7 +70,7 @@ a { font-family: Helvetica, var(--font-family-common); }
 
 Given:
 
-```
+```json
 ["custom-font"]
 ```
 

diff --git a/lib/rules/function-allowed-list/README.md b/lib/rules/function-allowed-list/README.md
@@ -17,7 +17,7 @@ If a string is surrounded with `"/"` (e.g. `"/^rgb/"`), it is interpreted as a r
 
 Given:
 
-```
+```json
 ["scale", "rgba", "linear-gradient"]
 ```
 

diff --git a/lib/rules/function-disallowed-list/README.md b/lib/rules/function-disallowed-list/README.md
@@ -17,7 +17,7 @@ If a string is surrounded with `"/"` (e.g. `"/^rgb/"`), it is interpreted as a r
 
 Given:
 
-```
+```json
 ["scale", "rgba", "linear-gradient"]
 ```
 

diff --git a/lib/rules/function-name-case/README.md b/lib/rules/function-name-case/README.md
@@ -123,7 +123,7 @@ For example, with `"lower"`.
 
 Given:
 
-```
+```json
 ["some-function", "/^get.*$/"]
 ```
 

diff --git a/lib/rules/function-url-scheme-allowed-list/README.md b/lib/rules/function-url-scheme-allowed-list/README.md
@@ -22,7 +22,7 @@ This rule ignores:
 
 Given:
 
-```
+```json
 ["data", "/^http/"]
 ```
 

diff --git a/lib/rules/function-url-scheme-disallowed-list/README.md b/lib/rules/function-url-scheme-disallowed-list/README.md
@@ -22,7 +22,7 @@ This rule ignores:
 
 Given:
 
-```
+```json
 ["ftp", "/^http/"]
 ```
 

diff --git a/lib/rules/keyframes-name-pattern/README.md b/lib/rules/keyframes-name-pattern/README.md
@@ -17,7 +17,7 @@ A string will be translated into a RegExp like so `new RegExp(yourString)` —
 
 Given the string:
 
-```
+```json
 "foo-.+"
 ```
 

diff --git a/lib/rules/max-line-length/README.md b/lib/rules/max-line-length/README.md
@@ -126,7 +126,7 @@ Ignore any line that matches the given regex pattern, regardless of whether it i
 
 Given:
 
-```
+```json
 "/^@import\\s+/"
 ```
 

diff --git a/lib/rules/max-nesting-depth/README.md b/lib/rules/max-nesting-depth/README.md
@@ -284,7 +284,7 @@ Ignore the specified at-rules.
 
 For example, with `1` and given:
 
-```
+```json
 ["/^my-/", "media"]
 ```
 

diff --git a/lib/rules/media-feature-name-allowed-list/README.md b/lib/rules/media-feature-name-allowed-list/README.md
@@ -15,7 +15,7 @@ Specify a list of allowed media feature names.
 
 Given:
 
-```
+```json
 ["max-width", "/^my-/"]
 ```
 

diff --git a/lib/rules/media-feature-name-disallowed-list/README.md b/lib/rules/media-feature-name-disallowed-list/README.md
@@ -15,7 +15,7 @@ Specify a list of disallowed media feature names.
 
 Given:
 
-```
+```json
 ["max-width", "/^my-/"]
 ```
 

diff --git a/lib/rules/media-feature-name-no-unknown/README.md b/lib/rules/media-feature-name-no-unknown/README.md
@@ -67,7 +67,7 @@ The following patterns are _not_ considered violations:
 
 Given:
 
-```
+```json
 ["/^my-/", "custom"]
 ```
 

diff --git a/lib/rules/media-feature-name-value-allowed-list/README.md b/lib/rules/media-feature-name-value-allowed-list/README.md
@@ -27,7 +27,7 @@ as a regular expression. For example, `/width$/` will match `max-width` and
 
 Given:
 
-```
+```json
 {
   "min-width": ["768px", "1024px"],
   "/resolution/": ["/dpcm$/"]

diff --git a/lib/rules/number-max-precision/README.md b/lib/rules/number-max-precision/README.md
@@ -54,7 +54,7 @@ For example, with `2`.
 
 Given:
 
-```
+```json
 ["/^my-/", "%"]
 ```
 

diff --git a/lib/rules/property-allowed-list/README.md b/lib/rules/property-allowed-list/README.md
@@ -19,7 +19,7 @@ If a string is surrounded with `"/"` (e.g. `"/^background/"`), it is interpreted
 
 Given:
 
-```
+```json
 ["display", "animation", "/^background/"]
 ```
 

diff --git a/lib/rules/property-disallowed-list/README.md b/lib/rules/property-disallowed-list/README.md
@@ -17,7 +17,7 @@ If a string is surrounded with `"/"` (e.g. `"/^background/"`), it is interpreted
 
 Given:
 
-```
+```json
 ["text-rendering", "animation", "/^background/"]
 ```
 

diff --git a/lib/rules/property-no-unknown/README.md b/lib/rules/property-no-unknown/README.md
@@ -81,7 +81,7 @@ a {
 
 Given:
 
-```
+```json
 ["/^my-/", "custom"]
 ```
 
@@ -114,7 +114,7 @@ Skips checking properties of the given selectors against this rule.
 
 Given:
 
-```
+```json
 [":root"]
 ```
 
@@ -133,7 +133,7 @@ Ignores properties nested within specified at-rules.
 
 Given:
 
-```
+```json
 ["supports"]
 ```