docs: remove /* eslint-env */ comments from rule examples (#18249)

* docs: remove `/* eslint-env */` comments from rule examples * also disallow empty eslint-env comments Co-authored-by: Francesco Trotta <github@fasttime.org> * add test case --------- Co-authored-by: Francesco Trotta <github@fasttime.org>
eslint · Apr 2, 2024 · 651ec91 · 651ec91
1 parent 950c4f1
commit 651ec91
Show file tree

Hide file tree

Showing 76 changed files with 49 additions and 405 deletions.
diff --git a/docs/src/rules/array-bracket-spacing.md b/docs/src/rules/array-bracket-spacing.md
@@ -13,8 +13,6 @@ A number of style guides require or disallow spaces between array brackets and o
 applies to both array literals and destructuring assignments (ECMAScript 6).
 
 ```js
-/*eslint-env es6*/
-
 var arr = [ 'foo', 'bar' ];
 var [ x, y ] = z;
 
@@ -58,7 +56,6 @@ Examples of **incorrect** code for this rule with the default `"never"` option:
 
 ```js
 /*eslint array-bracket-spacing: ["error", "never"]*/
-/*eslint-env es6*/
 
 var arr = [ 'foo', 'bar' ];
 var arr = ['foo', 'bar' ];
@@ -81,7 +78,6 @@ Examples of **correct** code for this rule with the default `"never"` option:
 
 ```js
 /*eslint array-bracket-spacing: ["error", "never"]*/
-/*eslint-env es6*/
 
 var arr = [];
 var arr = ['foo', 'bar', 'baz'];
@@ -114,7 +110,6 @@ Examples of **incorrect** code for this rule with the `"always"` option:
 
 ```js
 /*eslint array-bracket-spacing: ["error", "always"]*/
-/*eslint-env es6*/
 
 var arr = ['foo', 'bar'];
 var arr = ['foo', 'bar' ];
@@ -140,7 +135,6 @@ Examples of **correct** code for this rule with the `"always"` option:
 
 ```js
 /*eslint array-bracket-spacing: ["error", "always"]*/
-/*eslint-env es6*/
 
 var arr = [];
 var arr = [ 'foo', 'bar', 'baz' ];

diff --git a/docs/src/rules/arrow-body-style.md b/docs/src/rules/arrow-body-style.md
@@ -31,7 +31,6 @@ Examples of **incorrect** code for this rule with the `"always"` option:
 
 ```js
 /*eslint arrow-body-style: ["error", "always"]*/
-/*eslint-env es6*/
 
 let foo = () => 0;
 ```
@@ -44,7 +43,6 @@ Examples of **correct** code for this rule with the `"always"` option:
 
 ```js
 /*eslint arrow-body-style: ["error", "always"]*/
-/*eslint-env es6*/
 
 let foo = () => {
     return 0;
@@ -65,7 +63,6 @@ Examples of **incorrect** code for this rule with the default `"as-needed"` opti
 
 ```js
 /*eslint arrow-body-style: ["error", "as-needed"]*/
-/*eslint-env es6*/
 
 let foo = () => {
     return 0;
@@ -88,7 +85,6 @@ Examples of **correct** code for this rule with the default `"as-needed"` option
 
 ```js
 /*eslint arrow-body-style: ["error", "as-needed"]*/
-/*eslint-env es6*/
 
 let foo1 = () => 0;
 let foo2 = (retv, name) => {
@@ -122,7 +118,7 @@ Examples of **incorrect** code for this rule with the `{ "requireReturnForObject
 
 ```js
 /*eslint arrow-body-style: ["error", "as-needed", { "requireReturnForObjectLiteral": true }]*/
-/*eslint-env es6*/
+
 let foo = () => ({});
 let bar = () => ({ bar: 0 });
 ```
@@ -135,7 +131,6 @@ Examples of **correct** code for this rule with the `{ "requireReturnForObjectLi
 
 ```js
 /*eslint arrow-body-style: ["error", "as-needed", { "requireReturnForObjectLiteral": true }]*/
-/*eslint-env es6*/
 
 let foo = () => {};
 let bar = () => { return { bar: 0 }; };
@@ -151,7 +146,6 @@ Examples of **incorrect** code for this rule with the `"never"` option:
 
 ```js
 /*eslint arrow-body-style: ["error", "never"]*/
-/*eslint-env es6*/
 
 let foo = () => {
     return 0;
@@ -170,7 +164,6 @@ Examples of **correct** code for this rule with the `"never"` option:
 
 ```js
 /*eslint arrow-body-style: ["error", "never"]*/
-/*eslint-env es6*/
 
 let foo = () => 0;
 let bar = () => ({ foo: 0 });

diff --git a/docs/src/rules/arrow-parens.md b/docs/src/rules/arrow-parens.md
@@ -15,8 +15,6 @@ be wrapped in parentheses. This rule enforces the consistent use of parentheses
 This rule enforces parentheses around arrow function parameters regardless of arity. For example:
 
 ```js
-/*eslint-env es6*/
-
 // Bad
 a => {}
 
@@ -28,8 +26,6 @@ Following this style will help you find arrow functions (`=>`) which may be mist
 when a comparison such as `>=` was the intent.
 
 ```js
-/*eslint-env es6*/
-
 // Bad
 if (a => 2) {
 }
@@ -42,8 +38,6 @@ if (a >= 2) {
 The rule can also be configured to discourage the use of parens when they are not required:
 
 ```js
-/*eslint-env es6*/
-
 // Bad
 (a) => {}
 
@@ -72,7 +66,6 @@ Examples of **incorrect** code for this rule with the default `"always"` option:
 
 ```js
 /*eslint arrow-parens: ["error", "always"]*/
-/*eslint-env es6*/
 
 a => {};
 a => a;
@@ -90,7 +83,6 @@ Examples of **correct** code for this rule with the default `"always"` option:
 
 ```js
 /*eslint arrow-parens: ["error", "always"]*/
-/*eslint-env es6*/
 
 () => {};
 (a) => {};
@@ -107,8 +99,6 @@ a.then((foo) => { if (true) {} });
 One of the benefits of this option is that it prevents the incorrect use of arrow functions in conditionals:
 
 ```js
-/*eslint-env es6*/
-
 var a = 1;
 var b = 2;
 // ...
@@ -125,8 +115,6 @@ The contents of the `if` statement is an arrow function, not a comparison.
 If the arrow function is intentional, it should be wrapped in parens to remove ambiguity.
 
 ```js
-/*eslint-env es6*/
-
 var a = 1;
 var b = 0;
 // ...
@@ -141,8 +129,6 @@ if ((a) => b) {
 The following is another example of this behavior:
 
 ```js
-/*eslint-env es6*/
-
 var a = 1, b = 2, c = 3, d = 4;
 var f = a => b ? c: d;
 // f = ?
@@ -153,8 +139,6 @@ var f = a => b ? c: d;
 This should be rewritten like so:
 
 ```js
-/*eslint-env es6*/
-
 var a = 1, b = 2, c = 3, d = 4;
 var f = (a) => b ? c: d;
 ```
@@ -167,7 +151,6 @@ Examples of **incorrect** code for this rule with the `"as-needed"` option:
 
 ```js
 /*eslint arrow-parens: ["error", "as-needed"]*/
-/*eslint-env es6*/
 
 (a) => {};
 (a) => a;
@@ -188,7 +171,6 @@ Examples of **correct** code for this rule with the `"as-needed"` option:
 
 ```js
 /*eslint arrow-parens: ["error", "as-needed"]*/
-/*eslint-env es6*/
 
 () => {};
 a => {};
@@ -215,7 +197,6 @@ Examples of **incorrect** code for the `{ "requireForBlockBody": true }` option:
 
 ```js
 /*eslint arrow-parens: [2, "as-needed", { "requireForBlockBody": true }]*/
-/*eslint-env es6*/
 
 (a) => a;
 a => {};
@@ -235,7 +216,6 @@ Examples of **correct** code for the `{ "requireForBlockBody": true }` option:
 
 ```js
 /*eslint arrow-parens: [2, "as-needed", { "requireForBlockBody": true }]*/
-/*eslint-env es6*/
 
 (a) => {};
 (a) => {'\n'};

diff --git a/docs/src/rules/arrow-spacing.md b/docs/src/rules/arrow-spacing.md
@@ -8,8 +8,6 @@ This rule was **deprecated** in ESLint v8.53.0. Please use the [corresponding ru
 This rule normalize style of spacing before/after an arrow function's arrow(`=>`).
 
 ```js
-/*eslint-env es6*/
-
 // { "before": true, "after": true }
 (a) => {}
 
@@ -31,7 +29,6 @@ Examples of **incorrect** code for this rule with the default `{ "before": true,
 
 ```js
 /*eslint arrow-spacing: "error"*/
-/*eslint-env es6*/
 
 ()=> {};
 () =>{};
@@ -51,7 +48,6 @@ Examples of **correct** code for this rule with the default `{ "before": true, "
 
 ```js
 /*eslint arrow-spacing: "error"*/
-/*eslint-env es6*/
 
 () => {};
 (a) => {};
@@ -67,7 +63,6 @@ Examples of **incorrect** code for this rule with the `{ "before": false, "after
 
 ```js
 /*eslint arrow-spacing: ["error", { "before": false, "after": false }]*/
-/*eslint-env es6*/
 
 () =>{};
 (a) => {};
@@ -82,7 +77,6 @@ Examples of **correct** code for this rule with the `{ "before": false, "after":
 
 ```js
 /*eslint arrow-spacing: ["error", { "before": false, "after": false }]*/
-/*eslint-env es6*/
 
 ()=>{};
 (a)=>{};
@@ -97,7 +91,6 @@ Examples of **incorrect** code for this rule with the `{ "before": false, "after
 
 ```js
 /*eslint arrow-spacing: ["error", { "before": false, "after": true }]*/
-/*eslint-env es6*/
 
 () =>{};
 (a) => {};
@@ -112,7 +105,6 @@ Examples of **correct** code for this rule with the `{ "before": false, "after":
 
 ```js
 /*eslint arrow-spacing: ["error", { "before": false, "after": true }]*/
-/*eslint-env es6*/
 
 ()=> {};
 (a)=> {};

diff --git a/docs/src/rules/capitalized-comments.md b/docs/src/rules/capitalized-comments.md
@@ -42,7 +42,6 @@ Examples of **correct** code for this rule:
 // 丈 Non-Latin character at beginning of comment
 
 /* eslint semi:off */
-/* eslint-env node */
 /* eslint-disable */
 /* eslint-enable */
 /* istanbul ignore next */
@@ -118,7 +117,6 @@ Examples of **correct** code for this rule:
 // 丈 Non-Latin character at beginning of comment
 
 /* eslint semi:off */
-/* eslint-env node */
 /* eslint-disable */
 /* eslint-enable */
 /* istanbul ignore next */

diff --git a/docs/src/rules/class-methods-use-this.md b/docs/src/rules/class-methods-use-this.md
@@ -62,7 +62,6 @@ Examples of **incorrect** code for this rule:
 
 ```js
 /*eslint class-methods-use-this: "error"*/
-/*eslint-env es6*/
 
 class A {
     foo() {
@@ -79,7 +78,7 @@ Examples of **correct** code for this rule:
 
 ```js
 /*eslint class-methods-use-this: "error"*/
-/*eslint-env es6*/
+
 class A {
     foo() {
         this.bar = "Hello World"; // OK, this is used

diff --git a/docs/src/rules/computed-property-spacing.md b/docs/src/rules/computed-property-spacing.md
@@ -13,8 +13,6 @@ While formatting preferences are very personal, a number of style guides require
 or disallow spaces between computed properties in the following situations:
 
 ```js
-/*eslint-env es6*/
-
 var obj = { prop: "value" };
 var a = "prop";
 var x = obj[a]; // computed property in object member expression
@@ -57,7 +55,6 @@ Examples of **incorrect** code for this rule with the default `"never"` option:
 
 ```js
 /*eslint computed-property-spacing: ["error", "never"]*/
-/*eslint-env es6*/
 
 obj[foo ]
 obj[ 'foo']
@@ -76,7 +73,6 @@ Examples of **correct** code for this rule with the default `"never"` option:
 
 ```js
 /*eslint computed-property-spacing: ["error", "never"]*/
-/*eslint-env es6*/
 
 obj[foo]
 obj['foo']
@@ -97,7 +93,6 @@ Examples of **incorrect** code for this rule with the `"always"` option:
 
 ```js
 /*eslint computed-property-spacing: ["error", "always"]*/
-/*eslint-env es6*/
 
 obj[foo]
 var x = {[b]: a}
@@ -117,7 +112,6 @@ Examples of **correct** code for this rule with the `"always"` option:
 
 ```js
 /*eslint computed-property-spacing: ["error", "always"]*/
-/*eslint-env es6*/
 
 obj[ foo ]
 obj[ 'foo' ]
@@ -139,7 +133,6 @@ Examples of **incorrect** code for this rule with `"never"` and `{ "enforceForCl
 
 ```js
 /*eslint computed-property-spacing: ["error", "never", { "enforceForClassMembers": true }]*/
-/*eslint-env es6*/
 
 class Foo {
   [a ]() {}
@@ -163,7 +156,6 @@ Examples of **correct** code for this rule with `"never"` and `{ "enforceForClas
 
 ```js
 /*eslint computed-property-spacing: ["error", "never", { "enforceForClassMembers": true }]*/
-/*eslint-env es6*/
 
 class Foo {
   [a]() {}
@@ -187,7 +179,6 @@ Examples of **correct** code for this rule with `"never"` and `{ "enforceForClas
 
 ```js
 /*eslint computed-property-spacing: ["error", "never", { "enforceForClassMembers": false }]*/
-/*eslint-env es6*/
 
 class Foo {
   [a ]() {}

diff --git a/docs/src/rules/constructor-super.md b/docs/src/rules/constructor-super.md
@@ -30,7 +30,6 @@ Examples of **incorrect** code for this rule:
 
 ```js
 /*eslint constructor-super: "error"*/
-/*eslint-env es6*/
 
 class A extends B {
     constructor() { }  // Would throw a ReferenceError.
@@ -56,7 +55,6 @@ Examples of **correct** code for this rule:
 
 ```js
 /*eslint constructor-super: "error"*/
-/*eslint-env es6*/
 
 class A {
     constructor() { }

diff --git a/docs/src/rules/func-name-matching.md b/docs/src/rules/func-name-matching.md
@@ -100,7 +100,6 @@ module['exports'] = function foo(name) {};
 
 ```js
 /*eslint func-name-matching: ["error", "never"] */
-/*eslint-env es6*/
 
 var foo = function bar() {};
 var foo = function() {};