Skip to content

Commit ab30fad

Browse files
committed
docs(examples): improve diff formatting and readability 🎨
- Clean up spacing in diff blocks across example files - Remove unnecessary blank lines for better readability - Improve consistency in code example formatting - Streamline diff presentation for clearer understanding
1 parent 14099d2 commit ab30fad

14 files changed

Lines changed: 209 additions & 320 deletions

examples/prefer-array-every.md

Lines changed: 10 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -7,81 +7,71 @@ This rule enforces the use of `Array.every()` over manual for loops that return
77
### Basic Array Validation
88

99
```diff
10-
- function validateUsers(users) {
10+
function validateUsers(users) {
1111
- for (let i = 0; i < users.length; i++) {
1212
- if (!users[i].isActive) {
1313
- return false
1414
- }
1515
- }
1616
- return true
17-
- }
18-
+ function validateUsers(users) {
1917
+ return users.every(user => user.isActive)
20-
+ }
18+
}
2119
```
2220

2321
### Number Array Validation
2422

2523
```diff
26-
- function checkNumbers(numbers) {
24+
function checkNumbers(numbers) {
2725
- for (let i = 0; i < numbers.length; i++) {
2826
- if (numbers[i] <= 0) {
2927
- return false
3028
- }
3129
- }
3230
- return true
33-
- }
34-
+ function checkNumbers(numbers) {
3531
+ return numbers.every(number => number > 0)
36-
+ }
32+
}
3733
```
3834

3935
### Method Call Validation
4036

4137
```diff
42-
- function processItems(items) {
38+
function processItems(items) {
4339
- for (let i = 0; i < items.length; i++) {
4440
- if (!items[i].isValid()) {
4541
- return false
4642
- }
4743
- }
4844
- return true
49-
- }
50-
+ function processItems(items) {
5145
+ return items.every(item => item.isValid())
52-
+ }
46+
}
5347
```
5448

5549
### Complex Condition Validation
5650

5751
```diff
58-
- function validateComplex(items) {
52+
function validateComplex(items) {
5953
- for (let i = 0; i < items.length; i++) {
6054
- if (!items[i].active || items[i].value <= threshold) {
6155
- return false
6256
- }
6357
- }
6458
- return true
65-
- }
66-
+ function validateComplex(items) {
6759
+ return items.every(item => item.active && item.value > threshold)
68-
+ }
60+
}
6961
```
7062

7163
### Property Access Validation
7264

7365
```diff
74-
- function checkUsers(users) {
66+
function checkUsers(users) {
7567
- for (let i = 0; i < users.length; i++) {
7668
- if (!users[i].profile.isActive) {
7769
- return false
7870
- }
7971
- }
8072
- return true
81-
- }
82-
+ function checkUsers(users) {
8373
+ return users.every(user => user.profile.isActive)
84-
+ }
74+
}
8575
```
8676

8777
## Rule Scope

examples/prefer-array-flat.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ This rule enforces the use of `Array.flat()` over manual flattening patterns lik
1111
+ const flattened = nestedArray.flat()
1212
```
1313

14+
### Array.prototype.concat.apply Pattern
15+
1416
```diff
1517
- const flattened = Array.prototype.concat.apply([], nestedArray)
1618
+ const flattened = nestedArray.flat()
@@ -19,14 +21,14 @@ This rule enforces the use of `Array.flat()` over manual flattening patterns lik
1921
### Function Returns
2022

2123
```diff
22-
- function flattenArray(arr) {
24+
function flattenArray(arr) {
2325
- return Array.prototype.concat.apply([], arr)
24-
- }
25-
+ function flattenArray(arr) {
2626
+ return arr.flat()
27-
+ }
27+
}
2828
```
2929

30+
### Arrow Function Returns
31+
3032
```diff
3133
- const flattenData = (data) => Array.prototype.concat.apply([], data)
3234
+ const flattenData = (data) => data.flat()
@@ -35,16 +37,12 @@ This rule enforces the use of `Array.flat()` over manual flattening patterns lik
3537
### Class Methods
3638

3739
```diff
38-
- class ArrayUtils {
39-
- flatten(arr) {
40+
class ArrayUtils {
41+
flatten(arr) {
4042
- return Array.prototype.concat.apply([], arr)
41-
- }
42-
- }
43-
+ class ArrayUtils {
44-
+ flatten(arr) {
4543
+ return arr.flat()
46-
+ }
47-
+ }
44+
}
45+
}
4846
```
4947

5048
### Complex Expressions
@@ -54,6 +52,8 @@ This rule enforces the use of `Array.flat()` over manual flattening patterns lik
5452
+ const flattened = getNestedArrays().flat()
5553
```
5654

55+
### Spread Operator Pattern
56+
5757
```diff
5858
- const result = [].concat(...getData())
5959
+ const result = getData().flat()
@@ -66,6 +66,8 @@ This rule enforces the use of `Array.flat()` over manual flattening patterns lik
6666
+ const flattened = (condition ? arr1 : arr2).flat()
6767
```
6868

69+
### Simple Array Processing
70+
6971
```diff
7072
- const processed = [].concat(...items)
7173
+ const processed = items.flat()

examples/prefer-array-includes.md

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@ This rule enforces the use of `Array.includes()` over manual `indexOf() !== -1`
88

99
```diff
1010
- if (arr.indexOf(item) !== -1) {
11-
- console.log('Item found')
12-
- }
1311
+ if (arr.includes(item)) {
14-
+ console.log('Item found')
15-
+ }
12+
console.log('Item found')
13+
}
1614
```
1715

16+
### Variable Assignment
17+
1818
```diff
1919
- const found = arr.indexOf(item) !== -1
2020
+ const found = arr.includes(item)
@@ -23,14 +23,14 @@ This rule enforces the use of `Array.includes()` over manual `indexOf() !== -1`
2323
### Function Returns
2424

2525
```diff
26-
- function hasItem(arr, item) {
26+
function hasItem(arr, item) {
2727
- return arr.indexOf(item) !== -1
28-
- }
29-
+ function hasItem(arr, item) {
3028
+ return arr.includes(item)
31-
+ }
29+
}
3230
```
3331

32+
### Arrow Function Returns
33+
3434
```diff
3535
- const checkExists = (items, target) => items.indexOf(target) !== -1
3636
+ const checkExists = (items, target) => items.includes(target)
@@ -40,13 +40,13 @@ This rule enforces the use of `Array.includes()` over manual `indexOf() !== -1`
4040

4141
```diff
4242
- if (getArray().indexOf(getItem()) !== -1) {
43-
- console.log('Found')
44-
- }
4543
+ if (getArray().includes(getItem())) {
46-
+ console.log('Found')
47-
+ }
44+
console.log('Found')
45+
}
4846
```
4947

48+
### Simple Variable Assignment
49+
5050
```diff
5151
- const exists = items.indexOf(item) !== -1
5252
+ const exists = items.includes(item)
@@ -56,11 +56,9 @@ This rule enforces the use of `Array.includes()` over manual `indexOf() !== -1`
5656

5757
```diff
5858
- if (obj.items.indexOf(item) !== -1) {
59-
- console.log('Item in collection')
60-
- }
6159
+ if (obj.items.includes(item)) {
62-
+ console.log('Item in collection')
63-
+ }
60+
console.log('Item in collection')
61+
}
6462
```
6563

6664
```diff

examples/prefer-array-some.md

Lines changed: 10 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -7,81 +7,71 @@ This rule enforces the use of `Array.some()` over manual for loops that return `
77
### Basic Array Search
88

99
```diff
10-
- function hasActiveUsers(users) {
10+
function hasActiveUsers(users) {
1111
- for (let i = 0; i < users.length; i++) {
1212
- if (users[i].isActive) {
1313
- return true
1414
- }
1515
- }
1616
- return false
17-
- }
18-
+ function hasActiveUsers(users) {
1917
+ return users.some(user => user.isActive)
20-
+ }
18+
}
2119
```
2220

2321
### Number Array Search
2422

2523
```diff
26-
- function hasPositiveNumbers(numbers) {
24+
function hasPositiveNumbers(numbers) {
2725
- for (let i = 0; i < numbers.length; i++) {
2826
- if (numbers[i] > 0) {
2927
- return true
3028
- }
3129
- }
3230
- return false
33-
- }
34-
+ function hasPositiveNumbers(numbers) {
3531
+ return numbers.some(number => number > 0)
36-
+ }
32+
}
3733
```
3834

3935
### Method Call Search
4036

4137
```diff
42-
- function hasValidItems(items) {
38+
function hasValidItems(items) {
4339
- for (let i = 0; i < items.length; i++) {
4440
- if (items[i].isValid()) {
4541
- return true
4642
- }
4743
- }
4844
- return false
49-
- }
50-
+ function hasValidItems(items) {
5145
+ return items.some(item => item.isValid())
52-
+ }
46+
}
5347
```
5448

5549
### Complex Condition Search
5650

5751
```diff
58-
- function hasComplexMatch(items) {
52+
function hasComplexMatch(items) {
5953
- for (let i = 0; i < items.length; i++) {
6054
- if (items[i].active && items[i].value > threshold) {
6155
- return true
6256
- }
6357
- }
6458
- return false
65-
- }
66-
+ function hasComplexMatch(items) {
6759
+ return items.some(item => item.active && item.value > threshold)
68-
+ }
60+
}
6961
```
7062

7163
### Property Access Search
7264

7365
```diff
74-
- function hasActiveUsers(users) {
66+
function hasActiveUsers(users) {
7567
- for (let i = 0; i < users.length; i++) {
7668
- if (users[i].profile.isActive) {
7769
- return true
7870
- }
7971
- }
8072
- return false
81-
- }
82-
+ function hasActiveUsers(users) {
8373
+ return users.some(user => user.profile.isActive)
84-
+ }
74+
}
8575
```
8676

8777
## Rule Scope

examples/prefer-arrow-callback.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,13 +35,10 @@ This rule enforces the use of arrow functions over regular function expressions
3535

3636
```diff
3737
- const results = numbers.map(function (num) {
38-
- const doubled = num * 2
39-
- return doubled
40-
- })
4138
+ const results = numbers.map(num => {
42-
+ const doubled = num * 2
43-
+ return doubled
44-
+ })
39+
const doubled = num * 2
40+
return doubled
41+
})
4542
```
4643

4744
### Destructuring Callback

examples/prefer-const-assertions.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,23 +21,19 @@ This rule enforces the use of const assertions (`as const`) on array and object
2121
### Return Statement Array
2222

2323
```diff
24-
- function getColors() {
24+
function getColors() {
2525
- return ['red', 'green', 'blue']
26-
- }
27-
+ function getColors() {
2826
+ return ['red', 'green', 'blue'] as const
29-
+ }
27+
}
3028
```
3129

3230
### Return Statement Object
3331

3432
```diff
35-
- function getConfig() {
33+
function getConfig() {
3634
- return { apiUrl: 'https://api.example.com', timeout: 5000 }
37-
- }
38-
+ function getConfig() {
3935
+ return { apiUrl: 'https://api.example.com', timeout: 5000 } as const
40-
+ }
36+
}
4137
```
4238

4339
### Arrow Function Return

0 commit comments

Comments
 (0)