diff --git a/.README/rules/match-name.md b/.README/rules/match-name.md index 1a88136c6..d8d36bdad 100644 --- a/.README/rules/match-name.md +++ b/.README/rules/match-name.md @@ -9,6 +9,10 @@ name will actually be part of the description (e.g., for `structuredTags` setting (if `name: false`, this rule will not apply to that tag). +#### Fixer + +Will replace `disallowName` with `replacement` if these are provided. + #### Options A single options object with the following properties: diff --git a/.README/rules/require-description-complete-sentence.md b/.README/rules/require-description-complete-sentence.md index ef0875c4a..8d325e1c5 100644 --- a/.README/rules/require-description-complete-sentence.md +++ b/.README/rules/require-description-complete-sentence.md @@ -14,6 +14,13 @@ Requires that block description, explicit `@description`, and * Periods after items within the `abbreviations` option array are not treated as sentence endings. +#### Fixer + +If sentences do not end with terminal punctuation, a period will be added. + +If sentences do not start with an uppercase character, the initial +letter will be capitalized. + #### Options ##### `tags` diff --git a/README.md b/README.md index 5cc9d2091..2c7f8422b 100644 --- a/README.md +++ b/README.md @@ -7845,6 +7845,12 @@ name will actually be part of the description (e.g., for `structuredTags` setting (if `name: false`, this rule will not apply to that tag). + + +#### Fixer + +Will replace `disallowName` with `replacement` if these are provided. + #### Options @@ -10976,6 +10982,15 @@ Requires that block description, explicit `@description`, and * Periods after items within the `abbreviations` option array are not treated as sentence endings. + + +#### Fixer + +If sentences do not end with terminal punctuation, a period will be added. + +If sentences do not start with an uppercase character, the initial +letter will be capitalized. + #### Options @@ -12369,8 +12384,8 @@ A value indicating whether setters should be checked. Defaults to `false`. A boolean on whether to enable the fixer (which adds an empty `@example` block). Defaults to `true`. - - + + #### Fixer The fixer for `require-example` will add an empty `@example`, but it will still @@ -15553,16 +15568,16 @@ function quux (foo, {bar: {baz}}) { Requires that all function parameters are documented. - - + + #### Fixer Adds `@param ` for each tag present in the function signature but missing in the jsdoc. Can be disabled by setting the `enableFixer` option to `false`. - - + + ##### Destructured object and array naming When the fixer is applied to destructured objects, only the input name is @@ -15614,8 +15629,8 @@ function quux ([foo, bar]) { */ ``` - - + + ##### Missing root fixing Note that unless `enableRootFixer` (or `enableFixer`) is set to `false`, @@ -15650,8 +15665,8 @@ numeric component). And one can have the count begin at another number (e.g., `1`) by changing `autoIncrementBase` from the default of `0`. - - + + ##### Rest Element (RestElement) insertions The fixer will automatically report/insert @@ -15703,8 +15718,8 @@ function baar ([a, ...extra]) { ...because it does not use the `...` syntax in the type. - - + + ##### Object Rest Property insertions 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`. Note that any other type, including a subtype of object such as `object`, will not be reported. - - + + #### Fixer The fixer for `require-property` will add an empty `@property`.