Skip to content

Commit 5db0241

Browse files
committed
docs(match-name, require-complete-sentence-description): add missing fixer sections
1 parent bffa6bf commit 5db0241

File tree

3 files changed

+40
-14
lines changed

3 files changed

+40
-14
lines changed

.README/rules/match-name.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ name will actually be part of the description (e.g., for
99
`structuredTags` setting (if `name: false`, this rule will not apply to
1010
that tag).
1111

12+
#### Fixer
13+
14+
Will replace `disallowName` with `replacement` if these are provided.
15+
1216
#### Options
1317

1418
A single options object with the following properties:

.README/rules/require-description-complete-sentence.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,13 @@ Requires that block description, explicit `@description`, and
1414
* Periods after items within the `abbreviations` option array are not treated
1515
as sentence endings.
1616

17+
#### Fixer
18+
19+
If sentences do not end with terminal punctuation, a period will be added.
20+
21+
If sentences do not start with an uppercase character, the initial
22+
letter will be capitalized.
23+
1724
#### Options
1825

1926
##### `tags`

README.md

Lines changed: 29 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7845,6 +7845,12 @@ name will actually be part of the description (e.g., for
78457845
`structuredTags` setting (if `name: false`, this rule will not apply to
78467846
that tag).
78477847

7848+
<a name="user-content-eslint-plugin-jsdoc-rules-match-name-fixer"></a>
7849+
<a name="eslint-plugin-jsdoc-rules-match-name-fixer"></a>
7850+
#### Fixer
7851+
7852+
Will replace `disallowName` with `replacement` if these are provided.
7853+
78487854
<a name="user-content-eslint-plugin-jsdoc-rules-match-name-options-12"></a>
78497855
<a name="eslint-plugin-jsdoc-rules-match-name-options-12"></a>
78507856
#### Options
@@ -10976,6 +10982,15 @@ Requires that block description, explicit `@description`, and
1097610982
* Periods after items within the `abbreviations` option array are not treated
1097710983
as sentence endings.
1097810984

10985+
<a name="user-content-eslint-plugin-jsdoc-rules-require-description-complete-sentence-fixer-1"></a>
10986+
<a name="eslint-plugin-jsdoc-rules-require-description-complete-sentence-fixer-1"></a>
10987+
#### Fixer
10988+
10989+
If sentences do not end with terminal punctuation, a period will be added.
10990+
10991+
If sentences do not start with an uppercase character, the initial
10992+
letter will be capitalized.
10993+
1097910994
<a name="user-content-eslint-plugin-jsdoc-rules-require-description-complete-sentence-options-23"></a>
1098010995
<a name="eslint-plugin-jsdoc-rules-require-description-complete-sentence-options-23"></a>
1098110996
#### Options
@@ -12369,8 +12384,8 @@ A value indicating whether setters should be checked. Defaults to `false`.
1236912384
A boolean on whether to enable the fixer (which adds an empty `@example` block).
1237012385
Defaults to `true`.
1237112386

12372-
<a name="user-content-eslint-plugin-jsdoc-rules-require-example-fixer"></a>
12373-
<a name="eslint-plugin-jsdoc-rules-require-example-fixer"></a>
12387+
<a name="user-content-eslint-plugin-jsdoc-rules-require-example-fixer-2"></a>
12388+
<a name="eslint-plugin-jsdoc-rules-require-example-fixer-2"></a>
1237412389
#### Fixer
1237512390

1237612391
The fixer for `require-example` will add an empty `@example`, but it will still
@@ -15553,16 +15568,16 @@ function quux (foo, {bar: {baz}}) {
1555315568

1555415569
Requires that all function parameters are documented.
1555515570

15556-
<a name="user-content-eslint-plugin-jsdoc-rules-require-param-fixer-1"></a>
15557-
<a name="eslint-plugin-jsdoc-rules-require-param-fixer-1"></a>
15571+
<a name="user-content-eslint-plugin-jsdoc-rules-require-param-fixer-3"></a>
15572+
<a name="eslint-plugin-jsdoc-rules-require-param-fixer-3"></a>
1555815573
#### Fixer
1555915574

1556015575
Adds `@param <name>` for each tag present in the function signature but
1556115576
missing in the jsdoc. Can be disabled by setting the `enableFixer`
1556215577
option to `false`.
1556315578

15564-
<a name="user-content-eslint-plugin-jsdoc-rules-require-param-fixer-1-destructured-object-and-array-naming"></a>
15565-
<a name="eslint-plugin-jsdoc-rules-require-param-fixer-1-destructured-object-and-array-naming"></a>
15579+
<a name="user-content-eslint-plugin-jsdoc-rules-require-param-fixer-3-destructured-object-and-array-naming"></a>
15580+
<a name="eslint-plugin-jsdoc-rules-require-param-fixer-3-destructured-object-and-array-naming"></a>
1556615581
##### Destructured object and array naming
1556715582

1556815583
When the fixer is applied to destructured objects, only the input name is
@@ -15614,8 +15629,8 @@ function quux ([foo, bar]) {
1561415629
*/
1561515630
```
1561615631

15617-
<a name="user-content-eslint-plugin-jsdoc-rules-require-param-fixer-1-missing-root-fixing"></a>
15618-
<a name="eslint-plugin-jsdoc-rules-require-param-fixer-1-missing-root-fixing"></a>
15632+
<a name="user-content-eslint-plugin-jsdoc-rules-require-param-fixer-3-missing-root-fixing"></a>
15633+
<a name="eslint-plugin-jsdoc-rules-require-param-fixer-3-missing-root-fixing"></a>
1561915634
##### Missing root fixing
1562015635

1562115636
Note that unless `enableRootFixer` (or `enableFixer`) is set to `false`,
@@ -15650,8 +15665,8 @@ numeric component).
1565015665
And one can have the count begin at another number (e.g., `1`) by changing
1565115666
`autoIncrementBase` from the default of `0`.
1565215667

15653-
<a name="user-content-eslint-plugin-jsdoc-rules-require-param-fixer-1-rest-element-restelement-insertions"></a>
15654-
<a name="eslint-plugin-jsdoc-rules-require-param-fixer-1-rest-element-restelement-insertions"></a>
15668+
<a name="user-content-eslint-plugin-jsdoc-rules-require-param-fixer-3-rest-element-restelement-insertions"></a>
15669+
<a name="eslint-plugin-jsdoc-rules-require-param-fixer-3-rest-element-restelement-insertions"></a>
1565515670
##### Rest Element (<code>RestElement</code>) insertions
1565615671

1565715672
The fixer will automatically report/insert
@@ -15703,8 +15718,8 @@ function baar ([a, ...extra]) {
1570315718

1570415719
...because it does not use the `...` syntax in the type.
1570515720

15706-
<a name="user-content-eslint-plugin-jsdoc-rules-require-param-fixer-1-object-rest-property-insertions"></a>
15707-
<a name="eslint-plugin-jsdoc-rules-require-param-fixer-1-object-rest-property-insertions"></a>
15721+
<a name="user-content-eslint-plugin-jsdoc-rules-require-param-fixer-3-object-rest-property-insertions"></a>
15722+
<a name="eslint-plugin-jsdoc-rules-require-param-fixer-3-object-rest-property-insertions"></a>
1570815723
##### Object Rest Property insertions
1570915724

1571015725
If the `checkRestProperty` option is set to `true` (`false` by default),
@@ -17334,8 +17349,8 @@ when their type is a plain `object`, `Object`, or `PlainObject`.
1733417349
Note that any other type, including a subtype of object such as
1733517350
`object<string, string>`, will not be reported.
1733617351

17337-
<a name="user-content-eslint-plugin-jsdoc-rules-require-property-fixer-2"></a>
17338-
<a name="eslint-plugin-jsdoc-rules-require-property-fixer-2"></a>
17352+
<a name="user-content-eslint-plugin-jsdoc-rules-require-property-fixer-4"></a>
17353+
<a name="eslint-plugin-jsdoc-rules-require-property-fixer-4"></a>
1733917354
#### Fixer
1734017355

1734117356
The fixer for `require-property` will add an empty `@property`.

0 commit comments

Comments
 (0)