Update rule docs to add since version (#59)

ota-meshi · Feb 26, 2021 · e779da2 · e779da2
1 parent cf8f575
commit e779da2
Show file tree

Hide file tree

Showing 34 changed files with 234 additions and 38 deletions.
diff --git a/.env-cmdrc b/.env-cmdrc
@@ -0,0 +1,5 @@
+{
+  "version": {
+    "IN_VERSION_SCRIPT": "true"
+  }
+}
diff --git a/docs/rules/array-bracket-newline.md b/docs/rules/array-bracket-newline.md
@@ -3,6 +3,7 @@ pageClass: "rule-details"
 sidebarDepth: 0
 title: "jsonc/array-bracket-newline"
 description: "enforce line breaks after opening and before closing array brackets"
+since: "v0.1.0"
 ---
 # jsonc/array-bracket-newline
 
@@ -61,7 +62,11 @@ Same as [array-bracket-newline] rule option. See [here](https://eslint.org/docs/
 
 [array-bracket-newline]: https://eslint.org/docs/rules/array-bracket-newline
 
-## Implementation
+## :rocket: Version
+
+This rule was introduced in eslint-plugin-jsonc v0.1.0
+
+## :mag: Implementation
 
 - [Rule source](https://github.com/ota-meshi/eslint-plugin-jsonc/blob/master/lib/rules/array-bracket-newline.ts)
 - [Test source](https://github.com/ota-meshi/eslint-plugin-jsonc/blob/master/tests/lib/rules/array-bracket-newline.js)

diff --git a/docs/rules/array-bracket-spacing.md b/docs/rules/array-bracket-spacing.md
@@ -3,6 +3,7 @@ pageClass: "rule-details"
 sidebarDepth: 0
 title: "jsonc/array-bracket-spacing"
 description: "disallow or enforce spaces inside of brackets"
+since: "v0.1.0"
 ---
 # jsonc/array-bracket-spacing
 
@@ -49,7 +50,11 @@ Same as [array-bracket-spacing] rule option. See [here](https://eslint.org/docs/
 
 [array-bracket-spacing]: https://eslint.org/docs/rules/array-bracket-spacing
 
-## Implementation
+## :rocket: Version
+
+This rule was introduced in eslint-plugin-jsonc v0.1.0
+
+## :mag: Implementation
 
 - [Rule source](https://github.com/ota-meshi/eslint-plugin-jsonc/blob/master/lib/rules/array-bracket-spacing.ts)
 - [Test source](https://github.com/ota-meshi/eslint-plugin-jsonc/blob/master/tests/lib/rules/array-bracket-spacing.js)

diff --git a/docs/rules/array-element-newline.md b/docs/rules/array-element-newline.md
@@ -3,6 +3,7 @@ pageClass: "rule-details"
 sidebarDepth: 0
 title: "jsonc/array-element-newline"
 description: "enforce line breaks between array elements"
+since: "v0.1.0"
 ---
 # jsonc/array-element-newline
 
@@ -51,7 +52,11 @@ Same as [array-element-newline] rule option. See [here](https://eslint.org/docs/
 
 [array-element-newline]: https://eslint.org/docs/rules/array-element-newline
 
-## Implementation
+## :rocket: Version
+
+This rule was introduced in eslint-plugin-jsonc v0.1.0
+
+## :mag: Implementation
 
 - [Rule source](https://github.com/ota-meshi/eslint-plugin-jsonc/blob/master/lib/rules/array-element-newline.ts)
 - [Test source](https://github.com/ota-meshi/eslint-plugin-jsonc/blob/master/tests/lib/rules/array-element-newline.js)

diff --git a/docs/rules/auto.md b/docs/rules/auto.md
@@ -3,6 +3,7 @@ pageClass: "rule-details"
 sidebarDepth: 0
 title: "jsonc/auto"
 description: "apply jsonc rules similar to your configured ESLint core rules"
+since: "v0.8.0"
 ---
 # jsonc/auto
 
@@ -23,7 +24,11 @@ The rules contained in the sharable configuration work as well. If you use the `
 
 Nothing.
 
-## Implementation
+## :rocket: Version
+
+This rule was introduced in eslint-plugin-jsonc v0.8.0
+
+## :mag: Implementation
 
 - [Rule source](https://github.com/ota-meshi/eslint-plugin-jsonc/blob/master/lib/rules/auto.ts)
 - [Test source](https://github.com/ota-meshi/eslint-plugin-jsonc/blob/master/tests/lib/rules/auto.js)
diff --git a/docs/rules/comma-dangle.md b/docs/rules/comma-dangle.md
@@ -3,6 +3,7 @@ pageClass: "rule-details"
 sidebarDepth: 0
 title: "jsonc/comma-dangle"
 description: "require or disallow trailing commas"
+since: "v0.1.0"
 ---
 # jsonc/comma-dangle
 
@@ -70,7 +71,11 @@ You can also use an object option to configure this rule for each type of syntax
 
 [comma-dangle]: https://eslint.org/docs/rules/comma-dangle
 
-## Implementation
+## :rocket: Version
+
+This rule was introduced in eslint-plugin-jsonc v0.1.0
+
+## :mag: Implementation
 
 - [Rule source](https://github.com/ota-meshi/eslint-plugin-jsonc/blob/master/lib/rules/comma-dangle.ts)
 - [Test source](https://github.com/ota-meshi/eslint-plugin-jsonc/blob/master/tests/lib/rules/comma-dangle.js)

diff --git a/docs/rules/comma-style.md b/docs/rules/comma-style.md
@@ -3,6 +3,7 @@ pageClass: "rule-details"
 sidebarDepth: 0
 title: "jsonc/comma-style"
 description: "enforce consistent comma style"
+since: "v0.1.0"
 ---
 # jsonc/comma-style
 
@@ -59,7 +60,11 @@ Same as [comma-style] rule option. See [here](https://eslint.org/docs/rules/comm
 
 [comma-style]: https://eslint.org/docs/rules/comma-style
 
-## Implementation
+## :rocket: Version
+
+This rule was introduced in eslint-plugin-jsonc v0.1.0
+
+## :mag: Implementation
 
 - [Rule source](https://github.com/ota-meshi/eslint-plugin-jsonc/blob/master/lib/rules/comma-style.ts)
 - [Test source](https://github.com/ota-meshi/eslint-plugin-jsonc/blob/master/tests/lib/rules/comma-style.js)

diff --git a/docs/rules/indent.md b/docs/rules/indent.md
@@ -3,6 +3,7 @@ pageClass: "rule-details"
 sidebarDepth: 0
 title: "jsonc/indent"
 description: "enforce consistent indentation"
+since: "v0.1.0"
 ---
 # jsonc/indent
 
@@ -59,7 +60,11 @@ Same as [indent] rule option. See [here](https://eslint.org/docs/rules/indent#op
 
 [indent]: https://eslint.org/docs/rules/indent
 
-## Implementation
+## :rocket: Version
+
+This rule was introduced in eslint-plugin-jsonc v0.1.0
+
+## :mag: Implementation
 
 - [Rule source](https://github.com/ota-meshi/eslint-plugin-jsonc/blob/master/lib/rules/indent.ts)
 - [Test source](https://github.com/ota-meshi/eslint-plugin-jsonc/blob/master/tests/lib/rules/indent.js)

diff --git a/docs/rules/key-name-casing.md b/docs/rules/key-name-casing.md
@@ -3,6 +3,7 @@ pageClass: "rule-details"
 sidebarDepth: 0
 title: "jsonc/key-name-casing"
 description: "enforce naming convention to property key names"
+since: "v0.8.0"
 ---
 # jsonc/key-name-casing
 
@@ -58,7 +59,11 @@ Nothing.
 - `"snake_case"` ... if `true`, allows snake_case naming. default `false`
 - `"ignores"` ... you can specify the patterns to ignore in the array.
 
-## Implementation
+## :rocket: Version
+
+This rule was introduced in eslint-plugin-jsonc v0.8.0
+
+## :mag: Implementation
 
 - [Rule source](https://github.com/ota-meshi/eslint-plugin-jsonc/blob/master/lib/rules/key-name-casing.ts)
 - [Test source](https://github.com/ota-meshi/eslint-plugin-jsonc/blob/master/tests/lib/rules/key-name-casing.js)
diff --git a/docs/rules/key-spacing.md b/docs/rules/key-spacing.md
@@ -3,6 +3,7 @@ pageClass: "rule-details"
 sidebarDepth: 0
 title: "jsonc/key-spacing"
 description: "enforce consistent spacing between keys and values in object literal properties"
+since: "v0.1.0"
 ---
 # jsonc/key-spacing
 
@@ -53,7 +54,11 @@ Same as [key-spacing] rule option. See [here](https://eslint.org/docs/rules/key-
 
 [key-spacing]: https://eslint.org/docs/rules/key-spacing
 
-## Implementation
+## :rocket: Version
+
+This rule was introduced in eslint-plugin-jsonc v0.1.0
+
+## :mag: Implementation
 
 - [Rule source](https://github.com/ota-meshi/eslint-plugin-jsonc/blob/master/lib/rules/key-spacing.ts)
 - [Test source](https://github.com/ota-meshi/eslint-plugin-jsonc/blob/master/tests/lib/rules/key-spacing.js)

diff --git a/docs/rules/no-bigint-literals.md b/docs/rules/no-bigint-literals.md
@@ -3,6 +3,7 @@ pageClass: "rule-details"
 sidebarDepth: 0
 title: "jsonc/no-bigint-literals"
 description: "disallow BigInt literals"
+since: "v0.2.0"
 ---
 # jsonc/no-bigint-literals
 
@@ -37,7 +38,11 @@ JSON, JSONC and JSON5 do not allow BigInt literals.
 
 Nothing.
 
-## Implementation
+## :rocket: Version
+
+This rule was introduced in eslint-plugin-jsonc v0.2.0
+
+## :mag: Implementation
 
 - [Rule source](https://github.com/ota-meshi/eslint-plugin-jsonc/blob/master/lib/rules/no-bigint-literals.ts)
 - [Test source](https://github.com/ota-meshi/eslint-plugin-jsonc/blob/master/tests/lib/rules/no-bigint-literals.js)
diff --git a/docs/rules/no-comments.md b/docs/rules/no-comments.md
@@ -3,6 +3,7 @@ pageClass: "rule-details"
 sidebarDepth: 0
 title: "jsonc/no-comments"
 description: "disallow comments"
+since: "v0.1.0"
 ---
 # jsonc/no-comments
 
@@ -34,7 +35,11 @@ Cannot use comments when in JSON.
 
 Nothing.
 
-## Implementation
+## :rocket: Version
+
+This rule was introduced in eslint-plugin-jsonc v0.1.0
+
+## :mag: Implementation
 
 - [Rule source](https://github.com/ota-meshi/eslint-plugin-jsonc/blob/master/lib/rules/no-comments.ts)
 - [Test source](https://github.com/ota-meshi/eslint-plugin-jsonc/blob/master/tests/lib/rules/no-comments.js)
diff --git a/docs/rules/no-dupe-keys.md b/docs/rules/no-dupe-keys.md
@@ -3,6 +3,7 @@ pageClass: "rule-details"
 sidebarDepth: 0
 title: "jsonc/no-dupe-keys"
 description: "disallow duplicate keys in object literals"
+since: "v0.1.0"
 ---
 # jsonc/no-dupe-keys
 
@@ -47,7 +48,11 @@ Nothing.
 
 [no-dupe-keys]: https://eslint.org/docs/rules/no-dupe-keys
 
-## Implementation
+## :rocket: Version
+
+This rule was introduced in eslint-plugin-jsonc v0.1.0
+
+## :mag: Implementation
 
 - [Rule source](https://github.com/ota-meshi/eslint-plugin-jsonc/blob/master/lib/rules/no-dupe-keys.ts)
 - [Test source](https://github.com/ota-meshi/eslint-plugin-jsonc/blob/master/tests/lib/rules/no-dupe-keys.js)

diff --git a/docs/rules/no-floating-decimal.md b/docs/rules/no-floating-decimal.md
@@ -3,6 +3,7 @@ pageClass: "rule-details"
 sidebarDepth: 0
 title: "jsonc/no-floating-decimal"
 description: "disallow leading or trailing decimal points in numeric literals"
+since: "v0.9.0"
 ---
 # jsonc/no-floating-decimal
 
@@ -42,7 +43,11 @@ Nothing.
 
 [no-floating-decimal]: https://eslint.org/docs/rules/no-floating-decimal
 
-## Implementation
+## :rocket: Version
+
+This rule was introduced in eslint-plugin-jsonc v0.9.0
+
+## :mag: Implementation
 
 - [Rule source](https://github.com/ota-meshi/eslint-plugin-jsonc/blob/master/lib/rules/no-floating-decimal.ts)
 - [Test source](https://github.com/ota-meshi/eslint-plugin-jsonc/blob/master/tests/lib/rules/no-floating-decimal.js)

diff --git a/docs/rules/no-multi-str.md b/docs/rules/no-multi-str.md
@@ -3,6 +3,7 @@ pageClass: "rule-details"
 sidebarDepth: 0
 title: "jsonc/no-multi-str"
 description: "disallow multiline strings"
+since: "v0.1.0"
 ---
 # jsonc/no-multi-str
 
@@ -42,7 +43,11 @@ Nothing.
 
 [no-multi-str]: https://eslint.org/docs/rules/no-multi-str
 
-## Implementation
+## :rocket: Version
+
+This rule was introduced in eslint-plugin-jsonc v0.1.0
+
+## :mag: Implementation
 
 - [Rule source](https://github.com/ota-meshi/eslint-plugin-jsonc/blob/master/lib/rules/no-multi-str.ts)
 - [Test source](https://github.com/ota-meshi/eslint-plugin-jsonc/blob/master/tests/lib/rules/no-multi-str.js)

diff --git a/docs/rules/no-number-props.md b/docs/rules/no-number-props.md
@@ -3,6 +3,7 @@ pageClass: "rule-details"
 sidebarDepth: 0
 title: "jsonc/no-number-props"
 description: "disallow number property keys"
+since: "v0.2.0"
 ---
 # jsonc/no-number-props
 
@@ -42,7 +43,11 @@ JSON, JSONC and JSON5 do not allow number property keys.
 
 Nothing.
 
-## Implementation
+## :rocket: Version
+
+This rule was introduced in eslint-plugin-jsonc v0.2.0
+
+## :mag: Implementation
 
 - [Rule source](https://github.com/ota-meshi/eslint-plugin-jsonc/blob/master/lib/rules/no-number-props.ts)
 - [Test source](https://github.com/ota-meshi/eslint-plugin-jsonc/blob/master/tests/lib/rules/no-number-props.js)
diff --git a/docs/rules/no-numeric-separators.md b/docs/rules/no-numeric-separators.md
@@ -3,6 +3,7 @@ pageClass: "rule-details"
 sidebarDepth: 0
 title: "jsonc/no-numeric-separators"
 description: "disallow numeric separators"
+since: "v0.6.0"
 ---
 # jsonc/no-numeric-separators
 
@@ -36,7 +37,11 @@ This rule reports the use of numeric separators.
 
 Nothing.
 
-## Implementation
+## :rocket: Version
+
+This rule was introduced in eslint-plugin-jsonc v0.6.0
+
+## :mag: Implementation
 
 - [Rule source](https://github.com/ota-meshi/eslint-plugin-jsonc/blob/master/lib/rules/no-numeric-separators.ts)
 - [Test source](https://github.com/ota-meshi/eslint-plugin-jsonc/blob/master/tests/lib/rules/no-numeric-separators.js)
diff --git a/docs/rules/no-octal-escape.md b/docs/rules/no-octal-escape.md
@@ -3,6 +3,7 @@ pageClass: "rule-details"
 sidebarDepth: 0
 title: "jsonc/no-octal-escape"
 description: "disallow octal escape sequences in string literals"
+since: "v0.1.0"
 ---
 # jsonc/no-octal-escape
 
@@ -39,7 +40,11 @@ Nothing.
 
 [no-octal-escape]: https://eslint.org/docs/rules/no-octal-escape
 
-## Implementation
+## :rocket: Version
+
+This rule was introduced in eslint-plugin-jsonc v0.1.0
+
+## :mag: Implementation
 
 - [Rule source](https://github.com/ota-meshi/eslint-plugin-jsonc/blob/master/lib/rules/no-octal-escape.ts)
 - [Test source](https://github.com/ota-meshi/eslint-plugin-jsonc/blob/master/tests/lib/rules/no-octal-escape.js)

diff --git a/docs/rules/no-regexp-literals.md b/docs/rules/no-regexp-literals.md
@@ -3,6 +3,7 @@ pageClass: "rule-details"
 sidebarDepth: 0
 title: "jsonc/no-regexp-literals"
 description: "disallow RegExp literals"
+since: "v0.2.0"
 ---
 # jsonc/no-regexp-literals
 
@@ -34,7 +35,11 @@ JSON, JSONC and JSON5 do not allow RegExp literals.
 
 Nothing.
 
-## Implementation
+## :rocket: Version
+
+This rule was introduced in eslint-plugin-jsonc v0.2.0
+
+## :mag: Implementation
 
 - [Rule source](https://github.com/ota-meshi/eslint-plugin-jsonc/blob/master/lib/rules/no-regexp-literals.ts)
 - [Test source](https://github.com/ota-meshi/eslint-plugin-jsonc/blob/master/tests/lib/rules/no-regexp-literals.js)