Skip to content

Commit 3d322e6

Browse files
committed
chore: Update no-comments rule ID and description
1 parent cc70418 commit 3d322e6

File tree

3 files changed

+9
-9
lines changed

3 files changed

+9
-9
lines changed

docs/rules/no-comments.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@
1717

1818
<!-- end auto-generated rule options list -->
1919

20-
#### Description
20+
## Description
2121

2222
This rule disallows comments unless they match specified allowed patterns. It ensures that only relevant and permitted comments are present in the codebase, such as TODOs, warnings, JSDoc comments, ESLint directives, etc.
2323

24-
#### Rule Details
24+
## Rule Details
2525

2626
By default, the following comments are allowed:
2727

@@ -31,7 +31,7 @@ By default, the following comments are allowed:
3131

3232
You can also configure additional patterns to allow or disallow specific types of comments.
3333

34-
#### Usage
34+
## Usage
3535

3636
```json
3737
{

docs/rules/no-default-export.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@
66

77
<!-- end auto-generated rule header -->
88

9-
#### Description
9+
## Description
1010

1111
Converts unnamed default exports to named default exports based on the file name. This rule helps maintain consistency in export names and facilitates easier identification of components or modules.
1212

13-
#### Rule Details
13+
## Rule Details
1414

1515
This rule targets unnamed default exports and automatically generates a named export based on the file name.
1616

17-
#### Usage
17+
## Usage
1818
```json
1919
{
2020
"rules": {

docs/rules/no-destructuring.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,19 +15,19 @@
1515

1616
<!-- end auto-generated rule options list -->
1717

18-
#### Description
18+
## Description
1919

2020
This rule disallows destructuring that does not meet certain conditions, aiming to prevent overly complex destructuring patterns and ensure code readability.
2121

22-
#### Rule Details
22+
## Rule Details
2323

2424
This rule checks for:
2525

2626
- Destructuring at a nesting level above 3.
2727
- Destructuring of more than the specified maximum number of variables (default is 2).
2828
- Destructuring on a line exceeding the specified maximum line length (default is 100 characters).
2929

30-
#### Usage
30+
## Usage
3131

3232
```json
3333
{

0 commit comments

Comments
 (0)