Skip to content

Commit 89c8fc5

Browse files
amareshsmamareshsm
authored
docs: rewrite examples with var using let and const (#19315)
1 parent 495aa49 commit 89c8fc5

7 files changed

+52
-52
lines changed

‎docs/src/rules/array-callback-return.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ If we forget to write `return` statement in a callback of those, it's probably a
99

1010
```js
1111
// example: convert ['a', 'b', 'c'] --> {a: 0, b: 1, c: 2}
12-
var indexMap = myArray.reduce(function(memo, item, index) {
12+
const indexMap = myArray.reduce(function(memo, item, index) {
1313
memo[item] = index;
1414
}, {}); // Error: cannot set property 'b' of undefined
1515
```
@@ -45,17 +45,17 @@ Examples of **incorrect** code for this rule:
4545
```js
4646
/*eslint array-callback-return: "error"*/
4747

48-
var indexMap = myArray.reduce(function(memo, item, index) {
48+
const indexMap = myArray.reduce(function(memo, item, index) {
4949
memo[item] = index;
5050
}, {});
5151

52-
var foo = Array.from(nodes, function(node) {
52+
const foo = Array.from(nodes, function(node) {
5353
if (node.tagName === "DIV") {
5454
return true;
5555
}
5656
});
5757

58-
var bar = foo.filter(function(x) {
58+
const bar = foo.filter(function(x) {
5959
if (x) {
6060
return true;
6161
} else {
@@ -73,19 +73,19 @@ Examples of **correct** code for this rule:
7373
```js
7474
/*eslint array-callback-return: "error"*/
7575

76-
var indexMap = myArray.reduce(function(memo, item, index) {
76+
const indexMap = myArray.reduce(function(memo, item, index) {
7777
memo[item] = index;
7878
return memo;
7979
}, {});
8080

81-
var foo = Array.from(nodes, function(node) {
81+
const foo = Array.from(nodes, function(node) {
8282
if (node.tagName === "DIV") {
8383
return true;
8484
}
8585
return false;
8686
});
8787

88-
var bar = foo.map(node => node.getAttribute("id"));
88+
const bar = foo.map(node => node.getAttribute("id"));
8989
```
9090

9191
:::
@@ -98,7 +98,7 @@ This rule accepts a configuration object with three options:
9898
* `"checkForEach": false` (default) When set to `true`, rule will also report `forEach` callbacks that return a value.
9999
* `"allowVoid": false` (default) When set to `true`, allows `void` in `forEach` callbacks, so rule will not report the return value with a `void` operator.
100100

101-
**Note:** `{ "allowVoid": true }` works only if `checkForEach` option is set to `true`.
101+
**Note:** `{ "allowVoid": true }` works only if `checkForEach` option is set to `true`.
102102

103103
### allowImplicit
104104

@@ -108,7 +108,7 @@ Examples of **correct** code for the `{ "allowImplicit": true }` option:
108108

109109
```js
110110
/*eslint array-callback-return: ["error", { allowImplicit: true }]*/
111-
var undefAllTheThings = myArray.map(function(item) {
111+
const undefAllTheThings = myArray.map(function(item) {
112112
return;
113113
});
114114
```

‎docs/src/rules/for-direction.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,16 @@ Examples of **incorrect** code for this rule:
1515

1616
```js
1717
/*eslint for-direction: "error"*/
18-
for (var i = 0; i < 10; i--) {
18+
for (let i = 0; i < 10; i--) {
1919
}
2020

21-
for (var i = 10; i >= 0; i++) {
21+
for (let i = 10; i >= 0; i++) {
2222
}
2323

24-
for (var i = 0; i > 10; i++) {
24+
for (let i = 0; i > 10; i++) {
2525
}
2626

27-
for (var i = 0; 10 > i; i--) {
27+
for (let i = 0; 10 > i; i--) {
2828
}
2929

3030
const n = -2;
@@ -40,10 +40,10 @@ Examples of **correct** code for this rule:
4040

4141
```js
4242
/*eslint for-direction: "error"*/
43-
for (var i = 0; i < 10; i++) {
43+
for (let i = 0; i < 10; i++) {
4444
}
4545

46-
for (var i = 0; 10 > i; i++) { // with counter "i" on the right
46+
for (let i = 0; 10 > i; i++) { // with counter "i" on the right
4747
}
4848

4949
for (let i = 10; i >= 0; i += this.step) { // direction unknown

‎docs/src/rules/getter-return.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ further_reading:
1212
The get syntax binds an object property to a function that will be called when that property is looked up. It was first introduced in ECMAScript 5:
1313

1414
```js
15-
var p = {
15+
const p = {
1616
get name(){
1717
return "nicholas";
1818
}
@@ -38,7 +38,7 @@ Examples of **incorrect** code for this rule:
3838
```js
3939
/*eslint getter-return: "error"*/
4040

41-
p = {
41+
const p = {
4242
get name(){
4343
// no returns.
4444
}
@@ -66,7 +66,7 @@ Examples of **correct** code for this rule:
6666
```js
6767
/*eslint getter-return: "error"*/
6868

69-
p = {
69+
const p = {
7070
get name(){
7171
return "nicholas";
7272
}
@@ -99,7 +99,7 @@ Examples of **correct** code for the `{ "allowImplicit": true }` option:
9999

100100
```js
101101
/*eslint getter-return: ["error", { allowImplicit: true }]*/
102-
p = {
102+
const p = {
103103
get name(){
104104
return; // return undefined implicitly.
105105
}

‎docs/src/rules/no-cond-assign.md

+14-14
Original file line numberDiff line numberDiff line change
@@ -39,13 +39,13 @@ Examples of **incorrect** code for this rule with the default `"except-parens"`
3939
/*eslint no-cond-assign: "error"*/
4040

4141
// Unintentional assignment
42-
var x;
42+
let x;
4343
if (x = 0) {
44-
var b = 1;
44+
const b = 1;
4545
}
4646

4747
// Practical example that is similar to an error
48-
var setHeight = function (someNode) {
48+
const setHeight = function (someNode) {
4949
do {
5050
someNode.height = "100px";
5151
} while (someNode = someNode.parentNode);
@@ -62,20 +62,20 @@ Examples of **correct** code for this rule with the default `"except-parens"` op
6262
/*eslint no-cond-assign: "error"*/
6363

6464
// Assignment replaced by comparison
65-
var x;
65+
let x;
6666
if (x === 0) {
67-
var b = 1;
67+
const b = 1;
6868
}
6969

7070
// Practical example that wraps the assignment in parentheses
71-
var setHeight = function (someNode) {
71+
const setHeight = function (someNode) {
7272
do {
7373
someNode.height = "100px";
7474
} while ((someNode = someNode.parentNode));
7575
}
7676

7777
// Practical example that wraps the assignment and tests for 'null'
78-
var setHeight = function (someNode) {
78+
const set_height = function (someNode) {
7979
do {
8080
someNode.height = "100px";
8181
} while ((someNode = someNode.parentNode) !== null);
@@ -94,27 +94,27 @@ Examples of **incorrect** code for this rule with the `"always"` option:
9494
/*eslint no-cond-assign: ["error", "always"]*/
9595

9696
// Unintentional assignment
97-
var x;
97+
let x;
9898
if (x = 0) {
99-
var b = 1;
99+
const b = 1;
100100
}
101101

102102
// Practical example that is similar to an error
103-
var setHeight = function (someNode) {
103+
const setHeight = function (someNode) {
104104
do {
105105
someNode.height = "100px";
106106
} while (someNode = someNode.parentNode);
107107
}
108108

109109
// Practical example that wraps the assignment in parentheses
110-
var setHeight = function (someNode) {
110+
const set_height = function (someNode) {
111111
do {
112112
someNode.height = "100px";
113113
} while ((someNode = someNode.parentNode));
114114
}
115115

116116
// Practical example that wraps the assignment and tests for 'null'
117-
var setHeight = function (someNode) {
117+
const heightSetter = function (someNode) {
118118
do {
119119
someNode.height = "100px";
120120
} while ((someNode = someNode.parentNode) !== null);
@@ -131,9 +131,9 @@ Examples of **correct** code for this rule with the `"always"` option:
131131
/*eslint no-cond-assign: ["error", "always"]*/
132132

133133
// Assignment replaced by comparison
134-
var x;
134+
let x;
135135
if (x === 0) {
136-
var b = 1;
136+
const b = 1;
137137
}
138138
```
139139

‎docs/src/rules/no-constant-condition.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ do {
7373
doSomethingForever();
7474
} while (x = -1);
7575

76-
var result = 0 ? a : b;
76+
const result = 0 ? a : b;
7777

7878
if(input === "hello" || "bye"){
7979
output(input);
@@ -105,7 +105,7 @@ do {
105105
doSomething();
106106
} while (x);
107107

108-
var result = x !== 0 ? a : b;
108+
const result = x !== 0 ? a : b;
109109

110110
if(input === "hello" || input === "bye"){
111111
output(input);

‎docs/src/rules/no-control-regex.md

+15-15
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,13 @@ Examples of **incorrect** code for this rule:
3030
```js
3131
/*eslint no-control-regex: "error"*/
3232

33-
var pattern1 = /\x00/;
34-
var pattern2 = /\x0C/;
35-
var pattern3 = /\x1F/;
36-
var pattern4 = /\u000C/;
37-
var pattern5 = /\u{C}/u;
38-
var pattern6 = new RegExp("\x0C"); // raw U+000C character in the pattern
39-
var pattern7 = new RegExp("\\x0C"); // \x0C pattern
33+
const pattern1 = /\x00/;
34+
const pattern2 = /\x0C/;
35+
const pattern3 = /\x1F/;
36+
const pattern4 = /\u000C/;
37+
const pattern5 = /\u{C}/u;
38+
const pattern6 = new RegExp("\x0C"); // raw U+000C character in the pattern
39+
const pattern7 = new RegExp("\\x0C"); // \x0C pattern
4040
```
4141

4242
:::
@@ -48,14 +48,14 @@ Examples of **correct** code for this rule:
4848
```js
4949
/*eslint no-control-regex: "error"*/
5050

51-
var pattern1 = /\x20/;
52-
var pattern2 = /\u0020/;
53-
var pattern3 = /\u{20}/u;
54-
var pattern4 = /\t/;
55-
var pattern5 = /\n/;
56-
var pattern6 = new RegExp("\x20");
57-
var pattern7 = new RegExp("\\t");
58-
var pattern8 = new RegExp("\\n");
51+
const pattern1 = /\x20/;
52+
const pattern2 = /\u0020/;
53+
const pattern3 = /\u{20}/u;
54+
const pattern4 = /\t/;
55+
const pattern5 = /\n/;
56+
const pattern6 = new RegExp("\x20");
57+
const pattern7 = new RegExp("\\t");
58+
const pattern8 = new RegExp("\\n");
5959
```
6060

6161
:::

‎docs/src/rules/no-dupe-args.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ function foo(a, b, a) {
2525
console.log("value of the second a:", a);
2626
}
2727

28-
var bar = function (a, b, a) {
28+
const bar = function (a, b, a) {
2929
console.log("value of the second a:", a);
3030
};
3131
```
@@ -43,7 +43,7 @@ function foo(a, b, c) {
4343
console.log(a, b, c);
4444
}
4545

46-
var bar = function (a, b, c) {
46+
const bar = function (a, b, c) {
4747
console.log(a, b, c);
4848
};
4949
```

0 commit comments

Comments
 (0)