Skip to content

Commit 03f2f44

Browse files
ThiagoG8ThiagoG8
authored
docs: rewrite var with const in rules examples (#19317)
* docs: rewrite var with const in rules examples * docs: max-statements error fixed * replace let to const
1 parent 26c3003 commit 03f2f44

File tree

3 files changed

+83
-83
lines changed

3 files changed

+83
-83
lines changed

‎docs/src/rules/max-statements.md

+62-62
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ The `max-statements` rule allows you to specify the maximum number of statements
1616

1717
```js
1818
function foo() {
19-
var bar = 1; // one statement
20-
var baz = 2; // two statements
21-
var qux = 3; // three statements
19+
const bar = 1; // one statement
20+
const baz = 2; // two statements
21+
const qux = 3; // three statements
2222
}
2323
```
2424

@@ -48,33 +48,33 @@ Examples of **incorrect** code for this rule with the default `{ "max": 10 }` op
4848
/*eslint max-statements: ["error", 10]*/
4949

5050
function foo() {
51-
var foo1 = 1;
52-
var foo2 = 2;
53-
var foo3 = 3;
54-
var foo4 = 4;
55-
var foo5 = 5;
56-
var foo6 = 6;
57-
var foo7 = 7;
58-
var foo8 = 8;
59-
var foo9 = 9;
60-
var foo10 = 10;
61-
62-
var foo11 = 11; // Too many.
51+
const foo1 = 1;
52+
const foo2 = 2;
53+
const foo3 = 3;
54+
const foo4 = 4;
55+
const foo5 = 5;
56+
const foo6 = 6;
57+
const foo7 = 7;
58+
const foo8 = 8;
59+
const foo9 = 9;
60+
const foo10 = 10;
61+
62+
const foo11 = 11; // Too many.
6363
}
6464

65-
let bar = () => {
66-
var foo1 = 1;
67-
var foo2 = 2;
68-
var foo3 = 3;
69-
var foo4 = 4;
70-
var foo5 = 5;
71-
var foo6 = 6;
72-
var foo7 = 7;
73-
var foo8 = 8;
74-
var foo9 = 9;
75-
var foo10 = 10;
76-
77-
var foo11 = 11; // Too many.
65+
const bar = () => {
66+
const foo1 = 1;
67+
const foo2 = 2;
68+
const foo3 = 3;
69+
const foo4 = 4;
70+
const foo5 = 5;
71+
const foo6 = 6;
72+
const foo7 = 7;
73+
const foo8 = 8;
74+
const foo9 = 9;
75+
const foo10 = 10;
76+
77+
const foo11 = 11; // Too many.
7878
};
7979
```
8080

@@ -88,43 +88,43 @@ Examples of **correct** code for this rule with the default `{ "max": 10 }` opti
8888
/*eslint max-statements: ["error", 10]*/
8989

9090
function foo() {
91-
var foo1 = 1;
92-
var foo2 = 2;
93-
var foo3 = 3;
94-
var foo4 = 4;
95-
var foo5 = 5;
96-
var foo6 = 6;
97-
var foo7 = 7;
98-
var foo8 = 8;
99-
var foo9 = 9;
91+
const foo1 = 1;
92+
const foo2 = 2;
93+
const foo3 = 3;
94+
const foo4 = 4;
95+
const foo5 = 5;
96+
const foo6 = 6;
97+
const foo7 = 7;
98+
const foo8 = 8;
99+
const foo9 = 9;
100100
return function () { // 10
101101

102102
// The number of statements in the inner function does not count toward the
103103
// statement maximum.
104104

105-
var bar;
106-
var baz;
105+
let bar;
106+
let baz;
107107
return 42;
108108
};
109109
}
110110

111-
let bar = () => {
112-
var foo1 = 1;
113-
var foo2 = 2;
114-
var foo3 = 3;
115-
var foo4 = 4;
116-
var foo5 = 5;
117-
var foo6 = 6;
118-
var foo7 = 7;
119-
var foo8 = 8;
120-
var foo9 = 9;
111+
const bar = () => {
112+
const foo1 = 1;
113+
const foo2 = 2;
114+
const foo3 = 3;
115+
const foo4 = 4;
116+
const foo5 = 5;
117+
const foo6 = 6;
118+
const foo7 = 7;
119+
const foo8 = 8;
120+
const foo9 = 9;
121121
return function () { // 10
122122

123123
// The number of statements in the inner function does not count toward the
124124
// statement maximum.
125125

126-
var bar;
127-
var baz;
126+
let bar;
127+
let baz;
128128
return 42;
129129
};
130130
}
@@ -170,17 +170,17 @@ Examples of additional **correct** code for this rule with the `{ "max": 10 }, {
170170
/*eslint max-statements: ["error", 10, { "ignoreTopLevelFunctions": true }]*/
171171

172172
function foo() {
173-
var foo1 = 1;
174-
var foo2 = 2;
175-
var foo3 = 3;
176-
var foo4 = 4;
177-
var foo5 = 5;
178-
var foo6 = 6;
179-
var foo7 = 7;
180-
var foo8 = 8;
181-
var foo9 = 9;
182-
var foo10 = 10;
183-
var foo11 = 11;
173+
const foo1 = 1;
174+
const foo2 = 2;
175+
const foo3 = 3;
176+
const foo4 = 4;
177+
const foo5 = 5;
178+
const foo6 = 6;
179+
const foo7 = 7;
180+
const foo8 = 8;
181+
const foo9 = 9;
182+
const foo10 = 10;
183+
const foo11 = 11;
184184
}
185185
```
186186

‎docs/src/rules/new-cap.md

+20-20
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ rule_type: suggestion
77
The `new` operator in JavaScript creates a new instance of a particular type of object. That type of object is represented by a constructor function. Since constructor functions are just regular functions, the only defining characteristic is that `new` is being used as part of the call. Native JavaScript functions begin with an uppercase letter to distinguish those functions that are to be used as constructors from functions that are not. Many style guides recommend following this pattern to more easily determine which functions are to be used as constructors.
88

99
```js
10-
var friend = new Person();
10+
const friend = new Person();
1111
```
1212

1313
## Rule Details
@@ -64,7 +64,7 @@ Examples of **incorrect** code for this rule with the default `{ "newIsCap": tru
6464
```js
6565
/*eslint new-cap: ["error", { "newIsCap": true }]*/
6666

67-
var friend = new person();
67+
const friend = new person();
6868
```
6969

7070
:::
@@ -76,7 +76,7 @@ Examples of **correct** code for this rule with the default `{ "newIsCap": true
7676
```js
7777
/*eslint new-cap: ["error", { "newIsCap": true }]*/
7878

79-
var friend = new Person();
79+
const friend = new Person();
8080
```
8181

8282
:::
@@ -88,7 +88,7 @@ Examples of **correct** code for this rule with the `{ "newIsCap": false }` opti
8888
```js
8989
/*eslint new-cap: ["error", { "newIsCap": false }]*/
9090

91-
var friend = new person();
91+
const friend = new person();
9292
```
9393

9494
:::
@@ -102,7 +102,7 @@ Examples of **incorrect** code for this rule with the default `{ "capIsNew": tru
102102
```js
103103
/*eslint new-cap: ["error", { "capIsNew": true }]*/
104104

105-
var colleague = Person();
105+
const colleague = Person();
106106
```
107107

108108
:::
@@ -114,7 +114,7 @@ Examples of **correct** code for this rule with the default `{ "capIsNew": true
114114
```js
115115
/*eslint new-cap: ["error", { "capIsNew": true }]*/
116116

117-
var colleague = new Person();
117+
const colleague = new Person();
118118
```
119119

120120
:::
@@ -126,7 +126,7 @@ Examples of **correct** code for this rule with the `{ "capIsNew": false }` opti
126126
```js
127127
/*eslint new-cap: ["error", { "capIsNew": false }]*/
128128

129-
var colleague = Person();
129+
const colleague = Person();
130130
```
131131

132132
:::
@@ -140,9 +140,9 @@ Examples of additional **correct** code for this rule with the `{ "newIsCapExcep
140140
```js
141141
/*eslint new-cap: ["error", { "newIsCapExceptions": ["events"] }]*/
142142

143-
var events = require('events');
143+
const events = require('events');
144144

145-
var emitter = new events();
145+
const emitter = new events();
146146
```
147147

148148
:::
@@ -156,9 +156,9 @@ Examples of additional **correct** code for this rule with the `{ "newIsCapExcep
156156
```js
157157
/*eslint new-cap: ["error", { "newIsCapExceptionPattern": "^person\\.." }]*/
158158

159-
var friend = new person.acquaintance();
159+
const friend = new person.acquaintance();
160160

161-
var bestFriend = new person.friend();
161+
const bestFriend = new person.friend();
162162
```
163163

164164
:::
@@ -170,7 +170,7 @@ Examples of additional **correct** code for this rule with the `{ "newIsCapExcep
170170
```js
171171
/*eslint new-cap: ["error", { "newIsCapExceptionPattern": "\\.bar$" }]*/
172172

173-
var friend = new person.bar();
173+
const friend = new person.bar();
174174
```
175175

176176
:::
@@ -200,8 +200,8 @@ Examples of additional **correct** code for this rule with the `{ "capIsNewExcep
200200
```js
201201
/*eslint new-cap: ["error", { "capIsNewExceptionPattern": "^person\\.." }]*/
202202

203-
var friend = person.Acquaintance();
204-
var bestFriend = person.Friend();
203+
const friend = person.Acquaintance();
204+
const bestFriend = person.Friend();
205205
```
206206

207207
:::
@@ -225,11 +225,11 @@ Examples of additional **correct** code for this rule with the `{ "capIsNewExcep
225225
```js
226226
/*eslint new-cap: ["error", { "capIsNewExceptionPattern": "^Foo" }]*/
227227

228-
var x = Foo(42);
228+
const x = Foo(42);
229229

230-
var y = Foobar(42);
230+
const y = Foobar(42);
231231

232-
var z = Foo.Bar(42);
232+
const z = Foo.Bar(42);
233233
```
234234

235235
:::
@@ -243,7 +243,7 @@ Examples of **incorrect** code for this rule with the default `{ "properties": t
243243
```js
244244
/*eslint new-cap: ["error", { "properties": true }]*/
245245

246-
var friend = new person.acquaintance();
246+
const friend = new person.acquaintance();
247247
```
248248

249249
:::
@@ -255,7 +255,7 @@ Examples of **correct** code for this rule with the default `{ "properties": tru
255255
```js
256256
/*eslint new-cap: ["error", { "properties": true }]*/
257257

258-
var friend = new person.Acquaintance();
258+
const friend = new person.Acquaintance();
259259
```
260260

261261
:::
@@ -267,7 +267,7 @@ Examples of **correct** code for this rule with the `{ "properties": false }` op
267267
```js
268268
/*eslint new-cap: ["error", { "properties": false }]*/
269269

270-
var friend = new person.acquaintance();
270+
const friend = new person.acquaintance();
271271
```
272272

273273
:::

‎docs/src/rules/no-alert.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ customConfirm("Are you sure?");
4747
customPrompt("Who are you?");
4848

4949
function foo() {
50-
var alert = myCustomLib.customAlert;
50+
const alert = myCustomLib.customAlert;
5151
alert();
5252
}
5353
```

0 commit comments

Comments
 (0)