docs(eslint-plugin): missing info how to use sections, cjson -> jsonc (typescript-eslint#2578)

radarsu · web-flow · commit 16ffa47f2eb7 · 2020-09-27T16:04:04.000-07:00
diff --git a/packages/eslint-plugin/docs/rules/consistent-type-definitions.md b/packages/eslint-plugin/docs/rules/consistent-type-definitions.md
@@ -25,10 +25,10 @@ This rule accepts one string option:
 
 For example:
 
-```CJSON
+```jsonc
 {
-    // Use type for object definitions
-    "@typescript-eslint/consistent-type-definitions": ["error", "type"]
+  // Use type for object definitions
+  "@typescript-eslint/consistent-type-definitions": ["error", "type"]
 }
 ```
 
diff --git a/packages/eslint-plugin/docs/rules/dot-notation.md b/packages/eslint-plugin/docs/rules/dot-notation.md
@@ -7,7 +7,7 @@ It adds support for optionally ignoring computed `private` member access.
 
 ## How to use
 
-```cjson
+```jsonc
 {
   // note you must disable the base rule as it can report incorrect errors
   "dot-notation": "off",
diff --git a/packages/eslint-plugin/docs/rules/init-declarations.md b/packages/eslint-plugin/docs/rules/init-declarations.md
@@ -7,7 +7,7 @@ It adds support for TypeScript's `declare` variables.
 
 ## How to use
 
-```cjson
+```jsonc
 {
   // note you must disable the base rule as it can report incorrect errors
   "init-declarations": "off",
diff --git a/packages/eslint-plugin/docs/rules/keyword-spacing.md b/packages/eslint-plugin/docs/rules/keyword-spacing.md
@@ -7,7 +7,7 @@ This version adds support for generic type parameters on function calls.
 
 ## How to use
 
-```cjson
+```jsonc
 {
   // note you must disable the base rule as it can report incorrect errors
   "keyword-spacing": "off",
diff --git a/packages/eslint-plugin/docs/rules/lines-between-class-members.md b/packages/eslint-plugin/docs/rules/lines-between-class-members.md
@@ -11,7 +11,7 @@ See the [ESLint documentation](https://eslint.org/docs/rules/lines-between-class
 
 ## Rule Changes
 
-```cjson
+```jsonc
 {
   // note you must disable the base rule as it can report incorrect errors
   "lines-between-class-members": "off",
diff --git a/packages/eslint-plugin/docs/rules/no-empty-function.md b/packages/eslint-plugin/docs/rules/no-empty-function.md
@@ -75,4 +75,16 @@ class Foo {
 }
 ```
 
+## How to use
+
+```jsonc
+{
+  // note you must disable the base rule as it can report incorrect errors
+  "no-empty-function": "off",
+  "@typescript-eslint/no-empty-function": ["error"]
+}
+```
+
+---
+
 <sup>Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/no-empty-function.md)</sup>
diff --git a/packages/eslint-plugin/docs/rules/no-implied-eval.md b/packages/eslint-plugin/docs/rules/no-implied-eval.md
@@ -88,6 +88,16 @@ class Foo {
 setTimeout(Foo.fn, 100);
 ```
 
+## How to use
+
+```jsonc
+{
+  // note you must disable the base rule as it can report incorrect errors
+  "no-implied-eval": "off",
+  "@typescript-eslint/no-implied-eval": ["error"]
+}
+```
+
 ## When Not To Use It
 
 If you want to allow `new Function()` or `setTimeout()`, `setInterval()`, `setImmediate()` and `execScript()` with string arguments, then you can safely disable this rule.
diff --git a/packages/eslint-plugin/docs/rules/no-invalid-this.md b/packages/eslint-plugin/docs/rules/no-invalid-this.md
@@ -7,7 +7,7 @@ It adds support for TypeScript's `this` parameters.
 
 ## How to use
 
-```cjson
+```jsonc
 {
   // note you must disable the base rule as it can report incorrect errors
   "no-invalid-this": "off",
diff --git a/packages/eslint-plugin/docs/rules/no-loop-func.md b/packages/eslint-plugin/docs/rules/no-loop-func.md
@@ -7,7 +7,7 @@ It adds support for TypeScript types.
 
 ## How to use
 
-```cjson
+```jsonc
 {
   // note you must disable the base rule as it can report incorrect errors
   "no-loop-func": "off",
diff --git a/packages/eslint-plugin/docs/rules/no-throw-literal.md b/packages/eslint-plugin/docs/rules/no-throw-literal.md
@@ -79,6 +79,16 @@ class CustomError extends Error {
 throw new CustomError();
 ```
 
+## How to use
+
+```jsonc
+{
+  // note you must disable the base rule as it can report incorrect errors
+  "no-throw-literal": "off",
+  "@typescript-eslint/no-throw-literal": ["error"]
+}
+```
+
 ---
 
 <sup>Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/no-throw-literal.md)</sup>
diff --git a/packages/eslint-plugin/src/configs/README.md b/packages/eslint-plugin/src/configs/README.md
@@ -8,7 +8,7 @@ The `eslint-recommended` ruleset is meant to be used after extending `eslint:rec
 
 This config is automatically included if you use either the `recommended` or `recommended-requiring-type-checking` configs.
 
-```cjson
+```jsonc
 {
   "extends": [
     "eslint:recommended",
@@ -40,7 +40,7 @@ We will not add new rules to the `recommended` set unless we release a major pac
 
 If you disagree with a rule (or it disagrees with your codebase), consider using your local config to change the rule config so it works for your project.
 
-```cjson
+```jsonc
 {
   "extends": ["plugin:@typescript-eslint/recommended"],
   "rules": {

Original file line number	Diff line number	Diff line change
`@@ -25,10 +25,10 @@ This rule accepts one string option:`
`25`	`25`
`26`	`26`	`For example:`
`27`	`27`
`28`		-```CJSON
	`28`	+```jsonc
`29`	`29`	`{`
`30`		`- // Use type for object definitions`
`31`		`- "@typescript-eslint/consistent-type-definitions": ["error", "type"]`
	`30`	`+ // Use type for object definitions`
	`31`	`+ "@typescript-eslint/consistent-type-definitions": ["error", "type"]`
`32`	`32`	`}`
`33`	`33`	```
`34`	`34`
Original file line number	Diff line number	Diff line change
@@ -7,7 +7,7 @@ It adds support for optionally ignoring computed `private` member access.
`7`	`7`
`8`	`8`	`## How to use`
`9`	`9`
`10`		-```cjson
	`10`	+```jsonc
`11`	`11`	`{`
`12`	`12`	`// note you must disable the base rule as it can report incorrect errors`
`13`	`13`	`"dot-notation": "off",`
Original file line number	Diff line number	Diff line change
@@ -7,7 +7,7 @@ It adds support for TypeScript's `declare` variables.
`7`	`7`
`8`	`8`	`## How to use`
`9`	`9`
`10`		-```cjson
	`10`	+```jsonc
`11`	`11`	`{`
`12`	`12`	`// note you must disable the base rule as it can report incorrect errors`
`13`	`13`	`"init-declarations": "off",`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ This version adds support for generic type parameters on function calls.`
`7`	`7`
`8`	`8`	`## How to use`
`9`	`9`
`10`		-```cjson
	`10`	+```jsonc
`11`	`11`	`{`
`12`	`12`	`// note you must disable the base rule as it can report incorrect errors`
`13`	`13`	`"keyword-spacing": "off",`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ See the [ESLint documentation](https://eslint.org/docs/rules/lines-between-class`
`11`	`11`
`12`	`12`	`## Rule Changes`
`13`	`13`
`14`		-```cjson
	`14`	+```jsonc
`15`	`15`	`{`
`16`	`16`	`// note you must disable the base rule as it can report incorrect errors`
`17`	`17`	`"lines-between-class-members": "off",`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ It adds support for TypeScript types.`
`7`	`7`
`8`	`8`	`## How to use`
`9`	`9`
`10`		-```cjson
	`10`	+```jsonc
`11`	`11`	`{`
`12`	`12`	`// note you must disable the base rule as it can report incorrect errors`
`13`	`13`	`"no-loop-func": "off",`
Original file line number	Diff line number	Diff line change
@@ -8,7 +8,7 @@ The `eslint-recommended` ruleset is meant to be used after extending `eslint:rec
`8`	`8`
`9`	`9`	This config is automatically included if you use either the `recommended` or `recommended-requiring-type-checking` configs.
`10`	`10`
`11`		-```cjson
	`11`	+```jsonc
`12`	`12`	`{`
`13`	`13`	`"extends": [`
`14`	`14`	`"eslint:recommended",`
@@ -40,7 +40,7 @@ We will not add new rules to the `recommended` set unless we release a major pac
`40`	`40`
`41`	`41`	`If you disagree with a rule (or it disagrees with your codebase), consider using your local config to change the rule config so it works for your project.`
`42`	`42`
`43`		-```cjson
	`43`	+```jsonc
`44`	`44`	`{`
`45`	`45`	`"extends": ["plugin:@typescript-eslint/recommended"],`
`46`	`46`	`"rules": {`