docs: replace var with let or const in rule examples (#19331)

ravi-kolla · mdjermanovic · web-flow · commit f92a6803a10c · 2025-01-12T20:26:52.000+01:00
* fix(docs): replace var with let or const in rule examples

* docs: replace var with let or const in rule examples

* docs: replace var with let or const in rule examples

Co-authored-by: Milos Djermanovic &lt;milos.djermanovic@gmail.com&gt;

---------

Co-authored-by: Milos Djermanovic &lt;milos.djermanovic@gmail.com&gt;
diff --git a/docs/src/rules/camelcase.md b/docs/src/rules/camelcase.md
@@ -35,7 +35,7 @@ Examples of **incorrect** code for this rule with the default `{ "properties": "
 
 import { no_camelcased } from "external-module"
 
-var my_favorite_color = "#112C85";
+const my_favorite_color = "#112C85";
 
 function do_something() {
     // ...
@@ -57,15 +57,15 @@ function baz({ no_camelcased = 'default value' }) {
     // ...
 };
 
-var obj = {
+const obj = {
     my_pref: 1
 };
 
-var { category_id = 1 } = query;
+const { category_id = 1 } = query;
 
-var { foo: snake_cased } = bar;
+const { foo: snake_cased } = bar;
 
-var { foo: bar_baz = 1 } = quz;
+const { foo: bar_baz = 1 } = quz;
 ```
 
 :::
@@ -79,18 +79,18 @@ Examples of **correct** code for this rule with the default `{ "properties": "al
 
 import { no_camelcased as camelCased } from "external-module";
 
-var myFavoriteColor   = "#112C85";
-var _myFavoriteColor  = "#112C85";
-var myFavoriteColor_  = "#112C85";
-var MY_FAVORITE_COLOR = "#112C85";
-var foo1 = bar.baz_boom;
-var foo2 = { qux: bar.baz_boom };
+const myFavoriteColor   = "#112C85";
+const _myFavoriteColor  = "#112C85";
+const myFavoriteColor_  = "#112C85";
+const MY_FAVORITE_COLOR = "#112C85";
+const foo1 = bar.baz_boom;
+const foo2 = { qux: bar.baz_boom };
 
 obj.do_something();
 do_something();
 new do_something();
 
-var { category_id: category } = query;
+const { category_id: category } = query;
 
 function foo({ isCamelCased }) {
     // ...
@@ -104,11 +104,11 @@ function baz({ isCamelCased = 'default value' }) {
     // ...
 };
 
-var { categoryId = 1 } = query;
+const { categoryId = 1 } = query;
 
-var { foo: isCamelCased } = bar;
+const { foo: isCamelCased } = bar;
 
-var { foo: isCamelCased = 1 } = quz;
+const { foo: camelCasedName = 1 } = quz;
 
 ```
 
@@ -123,7 +123,7 @@ Examples of **correct** code for this rule with the `{ "properties": "never" }`
 ```js
 /*eslint camelcase: ["error", {properties: "never"}]*/
 
-var obj = {
+const obj = {
     my_pref: 1
 };
 
@@ -141,15 +141,15 @@ Examples of **incorrect** code for this rule with the default `{ "ignoreDestruct
 ```js
 /*eslint camelcase: "error"*/
 
-var { category_id } = query;
+const { category_id } = query;
 
-var { category_name = 1 } = query;
+const { category_name = 1 } = query;
 
-var { category_id: category_title } = query;
+const { category_id: category_title } = query;
 
-var { category_id: category_alias } = query;
+const { category_id: category_alias } = query;
 
-var { category_id: categoryId, ...other_props } = query;
+const { category_id: categoryId, ...other_props } = query;
 ```
 
 :::
@@ -163,9 +163,9 @@ Examples of **incorrect** code for this rule with the `{ "ignoreDestructuring":
 ```js
 /*eslint camelcase: ["error", {ignoreDestructuring: true}]*/
 
-var { category_id: category_alias } = query;
+const { category_id: category_alias } = query;
 
-var { category_id, ...other_props } = query;
+const { category_id, ...other_props } = query;
 ```
 
 :::
@@ -177,11 +177,11 @@ Examples of **correct** code for this rule with the `{ "ignoreDestructuring": tr
 ```js
 /*eslint camelcase: ["error", {ignoreDestructuring: true}]*/
 
-var { category_id } = query;
+const { category_id } = query;
 
-var { category_id = 1 } = query;
+const { category_name = 1 } = query;
 
-var { category_id: category_id } = query;
+const { category_id_name: category_id_name } = query;
 ```
 
 :::
@@ -195,8 +195,8 @@ Examples of additional **incorrect** code for this rule with the `{ "ignoreDestr
 ```js
 /*eslint camelcase: ["error", {ignoreDestructuring: true}]*/
 
-var { some_property } = obj; // allowed by {ignoreDestructuring: true}
-var foo = some_property + 1; // error, ignoreDestructuring does not apply to this statement
+const { some_property } = obj; // allowed by {ignoreDestructuring: true}
+const foo = some_property + 1; // error, ignoreDestructuring does not apply to this statement
 ```
 
 :::
@@ -210,7 +210,7 @@ Examples of additional **correct** code for this rule with the `{ "ignoreDestruc
 ```js
 /*eslint camelcase: ["error", {ignoreDestructuring: true}]*/
 
-var { some_property, ...rest } = obj;
+const { some_property, ...rest } = obj;
 // do something with 'rest', nothing with 'some_property'
 ```
 
@@ -225,7 +225,7 @@ Examples of additional **correct** code for this rule with the `{ "properties":
 ```js
 /*eslint camelcase: ["error", {"properties": "never", ignoreDestructuring: true}]*/
 
-var { some_property } = obj;
+const { some_property } = obj;
 doSomething({ some_property });
 ```
 
diff --git a/docs/src/rules/curly.md b/docs/src/rules/curly.md
@@ -96,7 +96,7 @@ while (true) {
     doSomething();
 }
 
-for (var i=0; i < items.length; i++) {
+for (let i=0; i < items.length; i++) {
     doSomething();
 }
 ```
@@ -209,7 +209,7 @@ while (true) {
     doSomething();
 }
 
-for (var i = 0; foo; i++) {
+for (let i = 0; foo; i++) {
     doSomething();
 }
 ```
@@ -243,7 +243,7 @@ if (foo)
 while (true)
     doSomething();
 
-for (var i = 0; foo; i++)
+for (let i = 0; foo; i++)
     doSomething();
 ```
 
diff --git a/docs/src/rules/dot-notation.md b/docs/src/rules/dot-notation.md
@@ -22,7 +22,7 @@ Examples of **incorrect** code for this rule:
 ```js
 /*eslint dot-notation: "error"*/
 
-var x = foo["bar"];
+const x = foo["bar"];
 ```
 
 :::
@@ -34,9 +34,9 @@ Examples of **correct** code for this rule:
 ```js
 /*eslint dot-notation: "error"*/
 
-var x = foo.bar;
+const x = foo.bar;
 
-var x = foo[bar];    // Property name is a variable, square-bracket notation required
+const y = foo[bar];    // Property name is a variable, square-bracket notation required
 ```
 
 :::
@@ -57,8 +57,8 @@ Examples of **correct** code for the `{ "allowKeywords": false }` option:
 ```js
 /*eslint dot-notation: ["error", { "allowKeywords": false }]*/
 
-var foo = { "class": "CS 101" }
-var x = foo["class"]; // Property name is a reserved word, square-bracket notation required
+const foo = { "class": "CS 101" }
+const x = foo["class"]; // Property name is a reserved word, square-bracket notation required
 ```
 
 :::
@@ -91,7 +91,7 @@ Examples of **incorrect** code for the sample `{ "allowPattern": "^[a-z]+(_[a-z]
 ```js
 /*eslint dot-notation: ["error", { "allowPattern": "^[a-z]+(_[a-z]+)+$" }]*/
 
-var data = {};
+const data = {};
 data["fooBar"] = 42;
 ```
 
@@ -103,7 +103,7 @@ Examples of **correct** code for the sample `{ "allowPattern": "^[a-z]+(_[a-z]+)
 ```js
 /*eslint dot-notation: ["error", { "allowPattern": "^[a-z]+(_[a-z]+)+$" }]*/
 
-var data = {};
+const data = {};
 data["foo_bar"] = 42;
 ```
 
diff --git a/docs/src/rules/id-denylist.md b/docs/src/rules/id-denylist.md
@@ -46,7 +46,7 @@ Examples of **incorrect** code for this rule with sample `"data", "callback"` re
 ```js
 /*eslint id-denylist: ["error", "data", "callback"] */
 
-var data = { ...values };
+const data = { ...values };
 
 function callback() {
     // ...
@@ -56,7 +56,7 @@ element.callback = function() {
     // ...
 };
 
-var itemSet = {
+const itemSet = {
     data: [...values]
 };
 
@@ -86,7 +86,7 @@ Examples of **correct** code for this rule with sample `"data", "callback"` rest
 ```js
 /*eslint id-denylist: ["error", "data", "callback"] */
 
-var encodingOptions = {...values};
+const encodingOptions = {...values};
 
 function processFileResult() {
     // ...
@@ -96,7 +96,7 @@ element.successHandler = function() {
     // ...
 };
 
-var itemSet = {
+const itemSet = {
     entities: [...values]
 };
 
diff --git a/docs/src/rules/max-lines.md b/docs/src/rules/max-lines.md
@@ -39,7 +39,7 @@ Examples of **incorrect** code for this rule with a max value of `3`:
 
 ```js
 /*eslint max-lines: ["error", 3]*/
-var a,
+let a,
     b,
     c;
 ```
@@ -51,7 +51,7 @@ var a,
 ```js
 /*eslint max-lines: ["error", 3]*/
 
-var a,
+let a,
     b,c;
 ```
 
@@ -62,7 +62,7 @@ var a,
 ```js
 /*eslint max-lines: ["error", 3]*/
 // a comment
-var a,
+let a,
     b,c;
 ```
 
@@ -74,7 +74,7 @@ Examples of **correct** code for this rule with a max value of `3`:
 
 ```js
 /*eslint max-lines: ["error", 3]*/
-var a,
+let a,
     b, c;
 ```
 
@@ -85,7 +85,7 @@ var a,
 ```js
 /*eslint max-lines: ["error", 3]*/
 
-var a, b, c;
+let a, b, c;
 ```
 
 :::
@@ -95,7 +95,7 @@ var a, b, c;
 ```js
 /*eslint max-lines: ["error", 3]*/
 // a comment
-var a, b, c;
+let a, b, c;
 ```
 
 :::
@@ -109,7 +109,7 @@ Examples of **incorrect** code for this rule with the `{ "skipBlankLines": true
 ```js
 /*eslint max-lines: ["error", {"max": 3, "skipBlankLines": true}]*/
 
-var a,
+let a,
     b,
     c;
 ```
@@ -123,7 +123,7 @@ Examples of **correct** code for this rule with the `{ "skipBlankLines": true }`
 ```js
 /*eslint max-lines: ["error", {"max": 3, "skipBlankLines": true}]*/
 
-var a,
+let a,
     b, c;
 ```
 
@@ -138,7 +138,7 @@ Examples of **incorrect** code for this rule with the `{ "skipComments": true }`
 ```js
 /*eslint max-lines: ["error", {"max": 2, "skipComments": true}]*/
 // a comment
-var a,
+let a,
     b,
     c;
 ```
@@ -152,7 +152,7 @@ Examples of **correct** code for this rule with the `{ "skipComments": true }` o
 ```js
 /*eslint max-lines: ["error", {"max": 2, "skipComments": true}]*/
 // a comment
-var a,
+let a,
     b, c;
 ```
 

Original file line number	Diff line number	Diff line change
`@@ -96,7 +96,7 @@ while (true) {`
`96`	`96`	`doSomething();`
`97`	`97`	`}`
`98`	`98`
`99`		`-for (var i=0; i < items.length; i++) {`
	`99`	`+for (let i=0; i < items.length; i++) {`
`100`	`100`	`doSomething();`
`101`	`101`	`}`
`102`	`102`	```
`@@ -209,7 +209,7 @@ while (true) {`
`209`	`209`	`doSomething();`
`210`	`210`	`}`
`211`	`211`
`212`		`-for (var i = 0; foo; i++) {`
	`212`	`+for (let i = 0; foo; i++) {`
`213`	`213`	`doSomething();`
`214`	`214`	`}`
`215`	`215`	```
`@@ -243,7 +243,7 @@ if (foo)`
`243`	`243`	`while (true)`
`244`	`244`	`doSomething();`
`245`	`245`
`246`		`-for (var i = 0; foo; i++)`
	`246`	`+for (let i = 0; foo; i++)`
`247`	`247`	`doSomething();`
`248`	`248`	```
`249`	`249`