Skip to content

Commit 8b87e00

Browse files
Tanujkanti4441Tanujkanti4441
authored
docs: replace var with const and let in rules (#19389)
* docs: replace var with const and let * update variable name in prefer destructuring * replace more vars with const
1 parent 31a9fd0 commit 8b87e00

File tree

5 files changed

+100
-100
lines changed

5 files changed

+100
-100
lines changed

‎docs/src/rules/prefer-destructuring.md

+15-15
Original file line numberDiff line numberDiff line change
@@ -47,12 +47,12 @@ Examples of **incorrect** code for this rule:
4747
/* eslint prefer-destructuring: "error" */
4848

4949
// With `array` enabled
50-
var foo = array[0];
50+
const foo = array[0];
5151
bar.baz = array[0];
5252

5353
// With `object` enabled
54-
var foo = object.foo;
55-
var foo = object['foo'];
54+
const qux = object.qux;
55+
const quux = object['quux'];
5656
```
5757

5858
:::
@@ -65,15 +65,15 @@ Examples of **correct** code for this rule:
6565
/* eslint prefer-destructuring: "error" */
6666

6767
// With `array` enabled
68-
var [ foo ] = array;
69-
var foo = array[someIndex];
68+
const [ foo ] = array;
69+
const arr = array[someIndex];
7070
[bar.baz] = array;
7171

7272

7373
// With `object` enabled
74-
var { foo } = object;
74+
const { baz } = object;
7575

76-
var foo = object.bar;
76+
const obj = object.bar;
7777

7878
let bar;
7979
({ bar } = object);
@@ -108,7 +108,7 @@ Examples of **correct** code when object destructuring in `VariableDeclarator` i
108108

109109
```javascript
110110
/* eslint prefer-destructuring: ["error", {VariableDeclarator: {object: true}}] */
111-
var {bar: foo} = object;
111+
const {bar: foo} = object;
112112
```
113113

114114
:::
@@ -148,7 +148,7 @@ Examples of **incorrect** code when `enforceForRenamedProperties` is enabled:
148148

149149
```javascript
150150
/* eslint "prefer-destructuring": ["error", { "object": true }, { "enforceForRenamedProperties": true }] */
151-
var foo = object.bar;
151+
const foo = object.bar;
152152
```
153153

154154
:::
@@ -159,7 +159,7 @@ Examples of **correct** code when `enforceForRenamedProperties` is enabled:
159159

160160
```javascript
161161
/* eslint "prefer-destructuring": ["error", { "object": true }, { "enforceForRenamedProperties": true }] */
162-
var { bar: foo } = object;
162+
const { bar: foo } = object;
163163
```
164164

165165
:::
@@ -185,7 +185,7 @@ class C {
185185
* Accessing an object property whose key is an integer will fall under the category `array` destructuring.
186186
* Accessing an array element through a computed index will fall under the category `object` destructuring.
187187

188-
The `--fix` option on the command line fixes only problems reported in variable declarations, and among them only those that fall under the category `object` destructuring. Furthermore, the name of the declared variable has to be the same as the name used for non-computed member access in the initializer. For example, `var foo = object.foo` can be automatically fixed by this rule. Problems that involve computed member access (e.g., `var foo = object[foo]`) or renamed properties (e.g., `var foo = object.bar`) are not automatically fixed.
188+
The `--fix` option on the command line fixes only problems reported in variable declarations, and among them only those that fall under the category `object` destructuring. Furthermore, the name of the declared variable has to be the same as the name used for non-computed member access in the initializer. For example, `const foo = object.foo` can be automatically fixed by this rule. Problems that involve computed member access (e.g., `const foo = object[foo]`) or renamed properties (e.g., `const foo = object.bar`) are not automatically fixed.
189189

190190
## When Not To Use It
191191

@@ -194,15 +194,15 @@ If you want to be able to access array indices or object properties directly, yo
194194
Additionally, if you intend to access large array indices directly, like:
195195

196196
```javascript
197-
var foo = array[100];
197+
const foo = array[100];
198198
```
199199

200200
Then the `array` part of this rule is not recommended, as destructuring does not match this use case very well.
201201

202202
Or for non-iterable 'array-like' objects:
203203

204204
```javascript
205-
var $ = require('jquery');
206-
var foo = $('body')[0];
207-
var [bar] = $('body'); // fails with a TypeError
205+
const $ = require('jquery');
206+
const foo = $('body')[0];
207+
const [bar] = $('body'); // fails with a TypeError
208208
```

‎docs/src/rules/radix.md

+16-16
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@ When using the `parseInt()` function it is common to omit the second argument, t
1212
This confusion led to the suggestion that you always use the radix parameter to `parseInt()` to eliminate unintended consequences. So instead of doing this:
1313

1414
```js
15-
var num = parseInt("071"); // 57
15+
const num = parseInt("071"); // 57
1616
```
1717

1818
Do this:
1919

2020
```js
21-
var num = parseInt("071", 10); // 71
21+
const num = parseInt("071", 10); // 71
2222
```
2323

2424
ECMAScript 5 changed the behavior of `parseInt()` so that it no longer autodetects octal literals and instead treats them as decimal literals. However, the differences between hexadecimal and decimal interpretation of the first parameter causes many developers to continue using the radix parameter to ensure the string is interpreted in the intended way.
@@ -45,15 +45,15 @@ Examples of **incorrect** code for the default `"always"` option:
4545
```js
4646
/*eslint radix: "error"*/
4747

48-
var num = parseInt("071");
48+
const num = parseInt("071");
4949

50-
var num = parseInt(someValue);
50+
const num1 = parseInt(someValue);
5151

52-
var num = parseInt("071", "abc");
52+
const num2 = parseInt("071", "abc");
5353

54-
var num = parseInt("071", 37);
54+
const num3 = parseInt("071", 37);
5555

56-
var num = parseInt();
56+
const num4 = parseInt();
5757
```
5858

5959
:::
@@ -65,11 +65,11 @@ Examples of **correct** code for the default `"always"` option:
6565
```js
6666
/*eslint radix: "error"*/
6767

68-
var num = parseInt("071", 10);
68+
const num = parseInt("071", 10);
6969

70-
var num = parseInt("071", 8);
70+
const num1 = parseInt("071", 8);
7171

72-
var num = parseFloat(someValue);
72+
const num2 = parseFloat(someValue);
7373
```
7474

7575
:::
@@ -83,11 +83,11 @@ Examples of **incorrect** code for the `"as-needed"` option:
8383
```js
8484
/*eslint radix: ["error", "as-needed"]*/
8585

86-
var num = parseInt("071", 10);
86+
const num = parseInt("071", 10);
8787

88-
var num = parseInt("071", "abc");
88+
const num1 = parseInt("071", "abc");
8989

90-
var num = parseInt();
90+
const num2 = parseInt();
9191
```
9292

9393
:::
@@ -99,11 +99,11 @@ Examples of **correct** code for the `"as-needed"` option:
9999
```js
100100
/*eslint radix: ["error", "as-needed"]*/
101101

102-
var num = parseInt("071");
102+
const num = parseInt("071");
103103

104-
var num = parseInt("071", 8);
104+
const num1 = parseInt("071", 8);
105105

106-
var num = parseFloat(someValue);
106+
const num2 = parseFloat(someValue);
107107
```
108108

109109
:::

0 commit comments

Comments
 (0)