docs: replace var with let and const in rule examples (#19365)

* docs: replace var in no-useless-backreference * docs: replace var with let and const
eslint · Jan 23, 2025 · 093fb3d · 093fb3d
1 parent 417de32
commit 093fb3d
Show file tree

Hide file tree

Showing 5 changed files with 56 additions and 45 deletions.
diff --git a/docs/src/rules/arrow-body-style.md b/docs/src/rules/arrow-body-style.md
@@ -32,7 +32,7 @@ Examples of **incorrect** code for this rule with the `"always"` option:
 ```js
 /*eslint arrow-body-style: ["error", "always"]*/
 
-let foo = () => 0;
+const foo = () => 0;
 ```
 
 :::
@@ -44,10 +44,11 @@ Examples of **correct** code for this rule with the `"always"` option:
 ```js
 /*eslint arrow-body-style: ["error", "always"]*/
 
-let foo = () => {
+const foo = () => {
     return 0;
 };
-let bar = (retv, name) => {
+
+const bar = (retv, name) => {
     retv[name] = true;
     return retv;
 };
@@ -64,10 +65,11 @@ Examples of **incorrect** code for this rule with the default `"as-needed"` opti
 ```js
 /*eslint arrow-body-style: ["error", "as-needed"]*/
 
-let foo = () => {
+const foo = () => {
     return 0;
 };
-let bar = () => {
+
+const bar = () => {
     return {
        bar: {
             foo: 1,
@@ -86,24 +88,29 @@ Examples of **correct** code for this rule with the default `"as-needed"` option
 ```js
 /*eslint arrow-body-style: ["error", "as-needed"]*/
 
-let foo1 = () => 0;
-let foo2 = (retv, name) => {
+const foo1 = () => 0;
+
+const foo2 = (retv, name) => {
     retv[name] = true;
     return retv;
 };
-let foo3 = () => ({
+
+const foo3 = () => ({
     bar: {
         foo: 1,
         bar: 2,
     }
 });
-let foo4 = () => { bar(); };
-let foo5 = () => {};
-let foo6 = () => { /* do nothing */ };
-let foo7 = () => {
+
+const foo4 = () => { bar(); };
+const foo5 = () => {};
+const foo6 = () => { /* do nothing */ };
+
+const foo7 = () => {
     // do nothing.
 };
-let foo8 = () => ({ bar: 0 });
+
+const foo8 = () => ({ bar: 0 });
 ```
 
 :::
@@ -119,8 +126,9 @@ Examples of **incorrect** code for this rule with the `{ "requireReturnForObject
 ```js
 /*eslint arrow-body-style: ["error", "as-needed", { "requireReturnForObjectLiteral": true }]*/
 
-let foo = () => ({});
-let bar = () => ({ bar: 0 });
+const foo = () => ({});
+
+const bar = () => ({ bar: 0 });
 ```
 
 :::
@@ -132,8 +140,9 @@ Examples of **correct** code for this rule with the `{ "requireReturnForObjectLi
 ```js
 /*eslint arrow-body-style: ["error", "as-needed", { "requireReturnForObjectLiteral": true }]*/
 
-let foo = () => {};
-let bar = () => { return { bar: 0 }; };
+const foo = () => {};
+
+const bar = () => { return { bar: 0 }; };
 ```
 
 :::
@@ -147,10 +156,11 @@ Examples of **incorrect** code for this rule with the `"never"` option:
 ```js
 /*eslint arrow-body-style: ["error", "never"]*/
 
-let foo = () => {
+const foo = () => {
     return 0;
 };
-let bar = (retv, name) => {
+
+const bar = (retv, name) => {
     retv[name] = true;
     return retv;
 };
@@ -165,8 +175,9 @@ Examples of **correct** code for this rule with the `"never"` option:
 ```js
 /*eslint arrow-body-style: ["error", "never"]*/
 
-let foo = () => 0;
-let bar = () => ({ foo: 0 });
+const foo = () => 0;
+
+const bar = () => ({ foo: 0 });
 ```
 
 :::
diff --git a/docs/src/rules/no-unmodified-loop-condition.md b/docs/src/rules/no-unmodified-loop-condition.md
@@ -37,14 +37,14 @@ Examples of **incorrect** code for this rule:
 ```js
 /*eslint no-unmodified-loop-condition: "error"*/
 
-var node = something;
+let node = something;
 
 while (node) {
     doSomething(node);
 }
 node = other;
 
-for (var j = 0; j < 5;) {
+for (let j = 0; j < 5;) {
     doSomething(j);
 }
 
@@ -67,7 +67,7 @@ while (node) {
     node = node.parent;
 }
 
-for (var j = 0; j < items.length; ++j) {
+for (let j = 0; j < items.length; ++j) {
     doSomething(items[j]);
 }
 

diff --git a/docs/src/rules/no-unsafe-optional-chaining.md b/docs/src/rules/no-unsafe-optional-chaining.md
@@ -8,7 +8,7 @@ rule_type: problem
 The optional chaining (`?.`) expression can short-circuit with a return value of `undefined`. Therefore, treating an evaluated optional chaining expression as a function, object, number, etc., can cause TypeError or unexpected results. For example:
 
 ```js
-var obj = undefined;
+const obj = undefined;
 
 1 in obj?.foo;  // TypeError
 with (obj?.foo);  // TypeError
@@ -20,7 +20,7 @@ const { bar } = obj?.foo;  // TypeError
 Also, parentheses limit the scope of short-circuiting in chains. For example:
 
 ```js
-var obj = undefined;
+const obj = undefined;
 
 (obj?.foo)(); // TypeError
 (obj?.foo).bar; // TypeError
@@ -77,7 +77,7 @@ with (obj?.foo);
 
 class A extends obj?.foo {}
 
-var a = class A extends obj?.foo {};
+const a = class A extends obj?.foo {};
 
 async function foo () {
     const { bar } = await obj?.foo;
@@ -111,7 +111,7 @@ foo?.()?.bar;
 
 new (obj?.foo ?? bar)();
 
-var baz = {...obj?.foo};
+const baz = {...obj?.foo};
 
 const { bar } = obj?.foo || baz;
 

diff --git a/docs/src/rules/no-useless-backreference.md b/docs/src/rules/no-useless-backreference.md
@@ -16,13 +16,13 @@ In JavaScript regular expressions, it's syntactically valid to define a backrefe
 Backreferences that always successfully match zero-length and cannot match anything else are useless. They are basically ignored and can be removed without changing the behavior of the regular expression.
 
 ```js
-var regex = /^(?:(a)|\1b)$/;
+const regex = /^(?:(a)|\1b)$/;
 
 regex.test("a"); // true
 regex.test("b"); // true!
 regex.test("ab"); // false
 
-var equivalentRegex = /^(?:(a)|b)$/;
+const equivalentRegex = /^(?:(a)|b)$/;
 
 equivalentRegex.test("a"); // true
 equivalentRegex.test("b"); // true

diff --git a/docs/src/rules/use-isnan.md b/docs/src/rules/use-isnan.md
@@ -219,17 +219,17 @@ Examples of **incorrect** code for this rule with `"enforceForIndexOf"` option s
 ```js
 /*eslint use-isnan: ["error", {"enforceForIndexOf": true}]*/
 
-var hasNaN = myArray.indexOf(NaN) >= 0;
+const hasNaN = myArray.indexOf(NaN) >= 0;
 
-var firstIndex = myArray.indexOf(NaN);
+const firstIndex = myArray.indexOf(NaN);
 
-var lastIndex = myArray.lastIndexOf(NaN);
+const lastIndex = myArray.lastIndexOf(NaN);
 
-var indexWithSequenceExpression = myArray.indexOf((doStuff(), NaN));
+const indexWithSequenceExpression = myArray.indexOf((doStuff(), NaN));
 
-var firstIndexFromSecondElement = myArray.indexOf(NaN, 1);
+const firstIndexFromSecondElement = myArray.indexOf(NaN, 1);
 
-var lastIndexFromSecondElement = myArray.lastIndexOf(NaN, 1);
+const lastIndexFromSecondElement = myArray.lastIndexOf(NaN, 1);
 ```
 
 :::
@@ -246,7 +246,7 @@ function myIsNaN(val) {
 }
 
 function indexOfNaN(arr) {
-    for (var i = 0; i < arr.length; i++) {
+    for (let i = 0; i < arr.length; i++) {
         if (myIsNaN(arr[i])) {
             return i;
         }
@@ -255,30 +255,30 @@ function indexOfNaN(arr) {
 }
 
 function lastIndexOfNaN(arr) {
-    for (var i = arr.length - 1; i >= 0; i--) {
+    for (let i = arr.length - 1; i >= 0; i--) {
         if (myIsNaN(arr[i])) {
             return i;
         }
     }
     return -1;
 }
 
-var hasNaN = myArray.some(myIsNaN);
+const hasNaN = myArray.some(myIsNaN);
 
-var hasNaN = indexOfNaN(myArray) >= 0;
+const hasNaN1 = indexOfNaN(myArray) >= 0;
 
-var firstIndex = indexOfNaN(myArray);
+const firstIndex = indexOfNaN(myArray);
 
-var lastIndex = lastIndexOfNaN(myArray);
+const lastIndex = lastIndexOfNaN(myArray);
 
 // ES2015
-var hasNaN = myArray.some(Number.isNaN);
+const hasNaN2 = myArray.some(Number.isNaN);
 
 // ES2015
-var firstIndex = myArray.findIndex(Number.isNaN);
+const firstIndex1 = myArray.findIndex(Number.isNaN);
 
 // ES2016
-var hasNaN = myArray.includes(NaN);
+const hasNaN3 = myArray.includes(NaN);
 ```
 
 :::