Skip to content

Commit

Permalink
docs: generate options from schema; fixes #258
Browse files Browse the repository at this point in the history
  • Loading branch information
brettz9 committed May 30, 2023
1 parent 6042b77 commit 3d052ba
Show file tree
Hide file tree
Showing 56 changed files with 173 additions and 53 deletions.
2 changes: 1 addition & 1 deletion .README/rules/check-examples.md
Expand Up @@ -181,7 +181,7 @@ expression-oriented rules will be used by default as well:
|Context|everywhere|
|Tags|`example`|
|Recommended|false|
|Options| *See above* |
|Options|`allowInlineConfig`, `baseConfig`, `captionRequired`, `checkDefaults`, `checkEslintrc`, `checkParams`, `checkProperties`, `configFile`, `exampleCodeRegex`, `matchingFileName`, `matchingFileNameDefaults`, `matchingFileNameParams`, `matchingFileNameProperties`, `noDefaultExampleRules`, `paddedIndent`, `rejectExampleCodeRegex`, `reportUnusedDisableDirectives`|

## Failing examples

Expand Down
2 changes: 1 addition & 1 deletion .README/rules/check-indentation.md
Expand Up @@ -51,7 +51,7 @@ report a padding issue:
|Context|everywhere|
|Tags|N/A|
|Recommended|false|
|Options| `excludeTags` |
|Options|`excludeTags`|

## Failing examples

Expand Down
2 changes: 1 addition & 1 deletion .README/rules/check-line-alignment.md
Expand Up @@ -54,7 +54,7 @@ Default to the empty string (no indent).
|||
|---|---|
|Context|everywhere|
|Options|(a string matching `"always"`, `"never"`, or `"any"` and optional object with `tags`, `customSpacings`, `preserveMainDescriptionPostDelimiter`, and `wrapIndent`)|
|Options|string ("always", "never", "any") followed by object with `customSpacings`, `preserveMainDescriptionPostDelimiter`, `tags`, `wrapIndent`|
|Tags|`param`, `property`, `returns` and others added by `tags`|
|Aliases|`arg`, `argument`, `prop`, `return`|
|Recommended|false|
Expand Down
2 changes: 1 addition & 1 deletion .README/rules/check-param-names.md
Expand Up @@ -86,7 +86,7 @@ that are available and actually used in the function.
|||
|---|---|
|Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`|
|Options|`allowExtraTrailingParamDocs`, `checkDestructured`, `checkRestProperty`, `checkTypesPattern`, `useDefaultObjectProperties`, `disableExtraPropertyReporting`|
|Options|`allowExtraTrailingParamDocs`, `checkDestructured`, `checkRestProperty`, `checkTypesPattern`, `disableExtraPropertyReporting`, `enableFixer`, `useDefaultObjectProperties`|
|Tags|`param`|
|Aliases|`arg`, `argument`|
|Recommended|true|
Expand Down
2 changes: 1 addition & 1 deletion .README/rules/check-types.md
Expand Up @@ -164,7 +164,7 @@ permitted.
|Aliases|`constructor`, `const`, `extends`, `var`, `arg`, `argument`, `prop`, `return`, `exception`, `yield`|
|Closure-only|`package`, `private`, `protected`, `public`, `static`|
|Recommended|true|
|Options|`noDefaults`, `exemptTagContexts`, `unifyParentAndChildTypeChecks`|
|Options|`exemptTagContexts`, `noDefaults`, `unifyParentAndChildTypeChecks`|
|Settings|`preferredTypes`, `mode`, `structuredTags`|

## Failing examples
Expand Down
2 changes: 1 addition & 1 deletion .README/rules/check-values.md
Expand Up @@ -56,7 +56,7 @@ Whether to enable validation that `@variation` must be a number. Defaults to
|Context|everywhere|
|Tags|`@version`, `@since`, `@kind`, `@license`, `@author`, `@variation`|
|Recommended|true|
|Options|`allowedAuthors`, `allowedLicenses`, `licensePattern`|
|Options|`allowedAuthors`, `allowedLicenses`, `licensePattern`, `numericOnlyVariation`|
|Settings|`tagNamePreference`|

## Failing examples
Expand Down
2 changes: 1 addition & 1 deletion .README/rules/match-description.md
Expand Up @@ -161,7 +161,7 @@ section of our README for more on the expected format.
|Aliases|`@desc`|
|Recommended|false|
|Settings||
|Options|`contexts`, `tags` (accepts tags with names and optional type such as 'param', 'arg', 'argument', 'property', and 'prop', and accepts arbitrary list of other tags with an optional type (but without names), e.g., 'returns', 'return'), `mainDescription`, `matchDescription`|
|Options|`contexts`, `mainDescription`, `matchDescription`, `message`, `tags`|

## Failing examples

Expand Down
2 changes: 1 addition & 1 deletion .README/rules/multiline-blocks.md
Expand Up @@ -96,7 +96,7 @@ cannot be reliably added after the tag either).
|Tags|Any (though `singleLineTags` and `multilineTags` control the application)|
|Recommended|true|
|Settings||
|Options|`noZeroLineText`, `noSingleLineBlocks`, `singleLineTags`, `noMultilineBlocks`, `minimumLengthForMultiline`, `multilineTags`, `allowMultipleTags`, `noFinalLineText`|
|Options|`allowMultipleTags`, `minimumLengthForMultiline`, `multilineTags`, `noFinalLineText`, `noMultilineBlocks`, `noSingleLineBlocks`, `noZeroLineText`, `singleLineTags`|

## Failing examples

Expand Down
2 changes: 1 addition & 1 deletion .README/rules/no-multi-asterisks.md
Expand Up @@ -54,7 +54,7 @@ Prevent the likes of this:
|Tags|(any)|
|Recommended|true|
|Settings||
|Options|`preventAtEnd`, `preventAtMiddleLines`|
|Options|`allowWhitespace`, `preventAtEnd`, `preventAtMiddleLines`|

## Failing examples

Expand Down
2 changes: 1 addition & 1 deletion .README/rules/no-undefined-types.md
Expand Up @@ -69,7 +69,7 @@ An option object may have the following keys:
|Aliases|`constructor`, `const`, `extends`, `var`, `arg`, `argument`, `prop`, `return`, `exception`, `yield`|
|Closure-only|`package`, `private`, `protected`, `public`, `static`|
|Recommended|true|
|Options|`definedTypes`, `markVariablesAsUsed`, `disableReporting`|
|Options|`definedTypes`, `disableReporting`, `markVariablesAsUsed`|
|Settings|`preferredTypes`, `mode`, `structuredTags`|


Expand Down
2 changes: 1 addition & 1 deletion .README/rules/require-asterisk-prefix.md
Expand Up @@ -43,7 +43,7 @@ which applies to the main jsdoc block description.
|---|---|
|Context|everywhere|
|Tags|All or as limited by the `tags` option|
|Options|(a string matching `"always"|"never"` and optional object with `tags`)|
|Options|string ("always", "never", "any") followed by object with `tags`|

## Failing examples

Expand Down
2 changes: 1 addition & 1 deletion .README/rules/require-description-complete-sentence.md
Expand Up @@ -68,7 +68,7 @@ nouns, for example).
|Tags|doc block, `param`, `returns`, `description`, `property`, `summary`, `file`, `classdesc`, `todo`, `deprecated`, `throws`, 'yields' and others added by `tags`|
|Aliases|`arg`, `argument`, `return`, `desc`, `prop`, `fileoverview`, `overview`, `exception`, `yield`|
|Recommended|false|
|Options|`tags`, `abbreviations`, `newlineBeforeCapsAssumesBadSentenceEnd`|
|Options|`abbreviations`, `newlineBeforeCapsAssumesBadSentenceEnd`, `tags`|

## Failing examples

Expand Down
2 changes: 1 addition & 1 deletion .README/rules/require-description.md
Expand Up @@ -42,7 +42,7 @@ An options object may have any of the following properties:
| Tags | `description` or jsdoc block |
| Aliases | `desc` |
| Recommended | false |
| Options | `contexts`, `exemptedBy`, `descriptionStyle`, `checkConstructors`, `checkGetters`, `checkSetters` |
| Options |`checkConstructors`, `checkGetters`, `checkSetters`, `contexts`, `descriptionStyle`, `exemptedBy`|
| Settings | `ignoreReplacesDocs`, `overrideReplacesDocs`, `augmentsExtendsReplacesDocs`, `implementsReplacesDocs` |

## Failing examples
Expand Down
2 changes: 1 addition & 1 deletion .README/rules/require-example.md
Expand Up @@ -66,7 +66,7 @@ Defaults to `true`.
|Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`; others when `contexts` option enabled|
|Tags|`example`|
|Recommended|false|
|Options|`exemptedBy`, `exemptNoArguments`, `contexts`, `checkConstructors`, `checkGetters`, `checkSetters`, `enableFixer`|
|Options|`checkConstructors`, `checkGetters`, `checkSetters`, `contexts`, `enableFixer`, `exemptedBy`, `exemptNoArguments`|
|Settings|`ignoreReplacesDocs`, `overrideReplacesDocs`, `augmentsExtendsReplacesDocs`, `implementsReplacesDocs`|

# Failing examples
Expand Down
2 changes: 1 addition & 1 deletion .README/rules/require-hyphen-before-param-description.md
Expand Up @@ -35,7 +35,7 @@ other tags besides the `@param` tag (or the `@arg` tag if so set):
|Tags|`param` and optionally other tags within `tags`|
|Aliases|`arg`, `argument`; potentially `prop` or other aliases|
|Recommended|false|
|Options|a string matching `"always" or "never"` followed by an optional object with a `tags` property|
|Options|string ("always", "never") followed by object with `tags`|

## Failing examples

Expand Down
2 changes: 1 addition & 1 deletion .README/rules/require-param-description.md
Expand Up @@ -45,7 +45,7 @@ section of our README for more on the expected format.
|Tags|`param`|
|Aliases|`arg`, `argument`|
|Recommended|true|
|Options|`setDefaultDestructuredRootDescription`, `defaultDestructuredRootDescription`, `contexts`|
|Options|`contexts`, `defaultDestructuredRootDescription`, `setDefaultDestructuredRootDescription`|
|Settings|`exemptDestructuredRootsFromChecks`|

## Failing examples
Expand Down
2 changes: 1 addition & 1 deletion .README/rules/require-param-type.md
Expand Up @@ -44,7 +44,7 @@ section of our README for more on the expected format.
|Tags|`param`|
|Aliases|`arg`, `argument`|
|Recommended|true|
|Options|`setDefaultDestructuredRootType`, `defaultDestructuredRootType`, `contexts`|
|Options|`contexts`, `defaultDestructuredRootType`, `setDefaultDestructuredRootType`|
|Settings|`exemptDestructuredRootsFromChecks`|

## Failing examples
Expand Down
2 changes: 1 addition & 1 deletion .README/rules/require-param.md
Expand Up @@ -377,7 +377,7 @@ supplied as default values. Defaults to `false`.
| Tags | `param` |
| Aliases | `arg`, `argument` |
|Recommended | true|
| Options | `autoIncrementBase`, `checkDestructured`, `checkDestructuredRoots`, `contexts`, `enableFixer`, `enableRootFixer`, `enableRestElementFixer`, `checkRestProperty`, `exemptedBy`, `checkConstructors`, `checkGetters`, `checkSetters`, `checkTypesPattern`, `unnamedRootBase`, `useDefaultObjectProperties`|
| Options |`autoIncrementBase`, `checkConstructors`, `checkDestructured`, `checkDestructuredRoots`, `checkGetters`, `checkRestProperty`, `checkSetters`, `checkTypesPattern`, `contexts`, `enableFixer`, `enableRestElementFixer`, `enableRootFixer`, `exemptedBy`, `unnamedRootBase`, `useDefaultObjectProperties`|
| Settings | `ignoreReplacesDocs`, `overrideReplacesDocs`, `augmentsExtendsReplacesDocs`, `implementsReplacesDocs`|

## Failing examples
Expand Down
2 changes: 1 addition & 1 deletion .README/rules/require-returns-check.md
Expand Up @@ -44,7 +44,7 @@ Will also report if multiple `@returns` tags are present.
|Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`|
|Tags|`returns`|
|Aliases|`return`|
|Options|`exemptAsync`, `reportMissingReturnForUndefinedTypes`|
|Options|`exemptAsync`, `exemptGenerators`, `reportMissingReturnForUndefinedTypes`|
|Recommended|true|

## Failing examples
Expand Down
2 changes: 1 addition & 1 deletion .README/rules/require-returns.md
Expand Up @@ -51,7 +51,7 @@ Will also report if multiple `@returns` tags are present.
| Tags | `returns` |
| Aliases | `return` |
|Recommended|true|
| Options | `checkConstructors`, `checkGetters`, `contexts`, `exemptedBy`, `forceRequireReturn`, `forceReturnsWithAsync` |
| Options |`checkConstructors`, `checkGetters`, `contexts`, `exemptedBy`, `forceRequireReturn`, `forceReturnsWithAsync`|
| Settings | `ignoreReplacesDocs`, `overrideReplacesDocs`, `augmentsExtendsReplacesDocs`, `implementsReplacesDocs` |

## Failing examples
Expand Down
2 changes: 1 addition & 1 deletion .README/rules/require-throws.md
Expand Up @@ -39,7 +39,7 @@ on why TypeScript doesn't offer such a feature.
| Tags | `throws` |
| Aliases | `exception` |
|Recommended|true|
| Options | `contexts`, `exemptedBy` |
| Options |`contexts`, `exemptedBy`|
| Settings | `ignoreReplacesDocs`, `overrideReplacesDocs`, `augmentsExtendsReplacesDocs`, `implementsReplacesDocs` |

## Failing examples
Expand Down
2 changes: 1 addition & 1 deletion .README/rules/require-yields-check.md
Expand Up @@ -44,7 +44,7 @@ Will also report if multiple `@yields` tags are present.
|Tags|`yields`|
|Aliases|`yield`|
|Recommended|true|
|Options|`checkGeneratorsOnly`|
|Options|`checkGeneratorsOnly`, `contexts`, `exemptedBy`, `next`|

## Failing examples

Expand Down
2 changes: 1 addition & 1 deletion .README/rules/require-yields.md
Expand Up @@ -65,7 +65,7 @@ option to expect a non-standard `@next` tag.
|Tags|`yields`|
|Aliases|`yield`|
|Recommended|true|
| Options | `contexts`, `exemptedBy`, `withGeneratorTag`, `nextWithGeneratorTag`, `forceRequireYields`, `next` |
| Options |`contexts`, `exemptedBy`, `forceRequireNext`, `forceRequireYields`, `next`, `nextWithGeneratorTag`, `withGeneratorTag`|
| Settings | `ignoreReplacesDocs`, `overrideReplacesDocs`, `augmentsExtendsReplacesDocs`, `implementsReplacesDocs` |

## Failing examples
Expand Down
2 changes: 1 addition & 1 deletion .README/rules/sort-tags.md
Expand Up @@ -244,7 +244,7 @@ such tags. Do not use with `true` if you are using `tag-lines` and `always`.
|Tags|any|
|Recommended|false|
|Settings||
|Options|`tagSequence`, `alphabetizeExtras`, `linesBetween`, `reportTagGroupSpacing`, `reportIntraTagGroupSpacing`|
|Options|`alphabetizeExtras`, `linesBetween`, `reportIntraTagGroupSpacing`, `reportTagGroupSpacing`, `tagSequence`|

## Failing examples

Expand Down
2 changes: 1 addition & 1 deletion .README/rules/tag-lines.md
Expand Up @@ -66,7 +66,7 @@ following keys:
|Tags|Any|
|Recommended|true|
|Settings|N/A|
|Options|(a string matching `"always"`, `"never"`, or `"any"` and optional object with `count`, `applyToEndTag`, `startLines`, `endLines`)|
|Options|string ("always", "any", "never") followed by object with `applyToEndTag`, `count`, `endLines`, `startLines`, `tags`|

## Failing examples

Expand Down
2 changes: 1 addition & 1 deletion .README/rules/text-escaping.md
Expand Up @@ -33,7 +33,7 @@ This option escapes the first backtick (`` ` ``) in a paired sequence.
|Tags|``|
|Recommended|false|
|Settings||
|Options||
|Options|`escapeHTML`, `escapeMarkdown`|

## Failing examples

Expand Down
1 change: 1 addition & 0 deletions .npmignore
@@ -1,5 +1,6 @@
coverage
src
bin
test
.*
*.log
Expand Down
2 changes: 1 addition & 1 deletion docs/rules/check-examples.md
Expand Up @@ -212,7 +212,7 @@ expression-oriented rules will be used by default as well:
|Context|everywhere|
|Tags|`example`|
|Recommended|false|
|Options| *See above* |
|Options|`allowInlineConfig`, `baseConfig`, `captionRequired`, `checkDefaults`, `checkEslintrc`, `checkParams`, `checkProperties`, `configFile`, `exampleCodeRegex`, `matchingFileName`, `matchingFileNameDefaults`, `matchingFileNameParams`, `matchingFileNameProperties`, `noDefaultExampleRules`, `paddedIndent`, `rejectExampleCodeRegex`, `reportUnusedDisableDirectives`|

<a name="user-content-check-examples-failing-examples"></a>
<a name="check-examples-failing-examples"></a>
Expand Down
2 changes: 1 addition & 1 deletion docs/rules/check-indentation.md
Expand Up @@ -64,7 +64,7 @@ report a padding issue:
|Context|everywhere|
|Tags|N/A|
|Recommended|false|
|Options| `excludeTags` |
|Options|`excludeTags`|

<a name="user-content-check-indentation-failing-examples"></a>
<a name="check-indentation-failing-examples"></a>
Expand Down
2 changes: 1 addition & 1 deletion docs/rules/check-line-alignment.md
Expand Up @@ -79,7 +79,7 @@ Default to the empty string (no indent).
|||
|---|---|
|Context|everywhere|
|Options|(a string matching `"always"`, `"never"`, or `"any"` and optional object with `tags`, `customSpacings`, `preserveMainDescriptionPostDelimiter`, and `wrapIndent`)|
|Options|string ("always", "never", "any") followed by object with `customSpacings`, `preserveMainDescriptionPostDelimiter`, `tags`, `wrapIndent`|
|Tags|`param`, `property`, `returns` and others added by `tags`|
|Aliases|`arg`, `argument`, `prop`, `return`|
|Recommended|false|
Expand Down
2 changes: 1 addition & 1 deletion docs/rules/check-param-names.md
Expand Up @@ -123,7 +123,7 @@ that are available and actually used in the function.
|||
|---|---|
|Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`|
|Options|`allowExtraTrailingParamDocs`, `checkDestructured`, `checkRestProperty`, `checkTypesPattern`, `useDefaultObjectProperties`, `disableExtraPropertyReporting`|
|Options|`allowExtraTrailingParamDocs`, `checkDestructured`, `checkRestProperty`, `checkTypesPattern`, `disableExtraPropertyReporting`, `enableFixer`, `useDefaultObjectProperties`|
|Tags|`param`|
|Aliases|`arg`, `argument`|
|Recommended|true|
Expand Down
2 changes: 1 addition & 1 deletion docs/rules/check-types.md
Expand Up @@ -183,7 +183,7 @@ permitted.
|Aliases|`constructor`, `const`, `extends`, `var`, `arg`, `argument`, `prop`, `return`, `exception`, `yield`|
|Closure-only|`package`, `private`, `protected`, `public`, `static`|
|Recommended|true|
|Options|`noDefaults`, `exemptTagContexts`, `unifyParentAndChildTypeChecks`|
|Options|`exemptTagContexts`, `noDefaults`, `unifyParentAndChildTypeChecks`|
|Settings|`preferredTypes`, `mode`, `structuredTags`|

<a name="user-content-check-types-failing-examples"></a>
Expand Down
2 changes: 1 addition & 1 deletion docs/rules/check-values.md
Expand Up @@ -78,7 +78,7 @@ Whether to enable validation that `@variation` must be a number. Defaults to
|Context|everywhere|
|Tags|`@version`, `@since`, `@kind`, `@license`, `@author`, `@variation`|
|Recommended|true|
|Options|`allowedAuthors`, `allowedLicenses`, `licensePattern`|
|Options|`allowedAuthors`, `allowedLicenses`, `licensePattern`, `numericOnlyVariation`|
|Settings|`tagNamePreference`|

<a name="user-content-check-values-failing-examples"></a>
Expand Down
2 changes: 1 addition & 1 deletion docs/rules/match-description.md
Expand Up @@ -186,7 +186,7 @@ section of our README for more on the expected format.
|Aliases|`@desc`|
|Recommended|false|
|Settings||
|Options|`contexts`, `tags` (accepts tags with names and optional type such as 'param', 'arg', 'argument', 'property', and 'prop', and accepts arbitrary list of other tags with an optional type (but without names), e.g., 'returns', 'return'), `mainDescription`, `matchDescription`|
|Options|`contexts`, `mainDescription`, `matchDescription`, `message`, `tags`|

<a name="user-content-match-description-failing-examples"></a>
<a name="match-description-failing-examples"></a>
Expand Down
2 changes: 1 addition & 1 deletion docs/rules/multiline-blocks.md
Expand Up @@ -120,7 +120,7 @@ cannot be reliably added after the tag either).
|Tags|Any (though `singleLineTags` and `multilineTags` control the application)|
|Recommended|true|
|Settings||
|Options|`noZeroLineText`, `noSingleLineBlocks`, `singleLineTags`, `noMultilineBlocks`, `minimumLengthForMultiline`, `multilineTags`, `allowMultipleTags`, `noFinalLineText`|
|Options|`allowMultipleTags`, `minimumLengthForMultiline`, `multilineTags`, `noFinalLineText`, `noMultilineBlocks`, `noSingleLineBlocks`, `noZeroLineText`, `singleLineTags`|

<a name="user-content-failing-examples"></a>
<a name="failing-examples"></a>
Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-multi-asterisks.md
Expand Up @@ -68,7 +68,7 @@ Prevent the likes of this:
|Tags|(any)|
|Recommended|true|
|Settings||
|Options|`preventAtEnd`, `preventAtMiddleLines`|
|Options|`allowWhitespace`, `preventAtEnd`, `preventAtMiddleLines`|

<a name="user-content-failing-examples"></a>
<a name="failing-examples"></a>
Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-undefined-types.md
Expand Up @@ -79,7 +79,7 @@ An option object may have the following keys:
|Aliases|`constructor`, `const`, `extends`, `var`, `arg`, `argument`, `prop`, `return`, `exception`, `yield`|
|Closure-only|`package`, `private`, `protected`, `public`, `static`|
|Recommended|true|
|Options|`definedTypes`, `markVariablesAsUsed`, `disableReporting`|
|Options|`definedTypes`, `disableReporting`, `markVariablesAsUsed`|
|Settings|`preferredTypes`, `mode`, `structuredTags`|


Expand Down
2 changes: 1 addition & 1 deletion docs/rules/require-asterisk-prefix.md
Expand Up @@ -53,7 +53,7 @@ which applies to the main jsdoc block description.
|---|---|
|Context|everywhere|
|Tags|All or as limited by the `tags` option|
|Options|(a string matching `"always"|"never"` and optional object with `tags`)|
|Options|string ("always", "never", "any") followed by object with `tags`|

<a name="user-content-failing-examples"></a>
<a name="failing-examples"></a>
Expand Down
2 changes: 1 addition & 1 deletion docs/rules/require-description-complete-sentence.md
Expand Up @@ -90,7 +90,7 @@ nouns, for example).
|Tags|doc block, `param`, `returns`, `description`, `property`, `summary`, `file`, `classdesc`, `todo`, `deprecated`, `throws`, 'yields' and others added by `tags`|
|Aliases|`arg`, `argument`, `return`, `desc`, `prop`, `fileoverview`, `overview`, `exception`, `yield`|
|Recommended|false|
|Options|`tags`, `abbreviations`, `newlineBeforeCapsAssumesBadSentenceEnd`|
|Options|`abbreviations`, `newlineBeforeCapsAssumesBadSentenceEnd`, `tags`|

<a name="user-content-require-description-complete-sentence-failing-examples"></a>
<a name="require-description-complete-sentence-failing-examples"></a>
Expand Down
2 changes: 1 addition & 1 deletion docs/rules/require-description.md
Expand Up @@ -52,7 +52,7 @@ An options object may have any of the following properties:
| Tags | `description` or jsdoc block |
| Aliases | `desc` |
| Recommended | false |
| Options | `contexts`, `exemptedBy`, `descriptionStyle`, `checkConstructors`, `checkGetters`, `checkSetters` |
| Options |`checkConstructors`, `checkGetters`, `checkSetters`, `contexts`, `descriptionStyle`, `exemptedBy`|
| Settings | `ignoreReplacesDocs`, `overrideReplacesDocs`, `augmentsExtendsReplacesDocs`, `implementsReplacesDocs` |

<a name="user-content-require-description-failing-examples"></a>
Expand Down
2 changes: 1 addition & 1 deletion docs/rules/require-example.md
Expand Up @@ -98,7 +98,7 @@ Defaults to `true`.
|Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`; others when `contexts` option enabled|
|Tags|`example`|
|Recommended|false|
|Options|`exemptedBy`, `exemptNoArguments`, `contexts`, `checkConstructors`, `checkGetters`, `checkSetters`, `enableFixer`|
|Options|`checkConstructors`, `checkGetters`, `checkSetters`, `contexts`, `enableFixer`, `exemptedBy`, `exemptNoArguments`|
|Settings|`ignoreReplacesDocs`, `overrideReplacesDocs`, `augmentsExtendsReplacesDocs`, `implementsReplacesDocs`|

<a name="user-content-failing-examples"></a>
Expand Down
2 changes: 1 addition & 1 deletion docs/rules/require-hyphen-before-param-description.md
Expand Up @@ -48,7 +48,7 @@ other tags besides the `@param` tag (or the `@arg` tag if so set):
|Tags|`param` and optionally other tags within `tags`|
|Aliases|`arg`, `argument`; potentially `prop` or other aliases|
|Recommended|false|
|Options|a string matching `"always" or "never"` followed by an optional object with a `tags` property|
|Options|string ("always", "never") followed by object with `tags`|

<a name="user-content-require-hyphen-before-param-description-failing-examples"></a>
<a name="require-hyphen-before-param-description-failing-examples"></a>
Expand Down
2 changes: 1 addition & 1 deletion docs/rules/require-param-description.md
Expand Up @@ -64,7 +64,7 @@ section of our README for more on the expected format.
|Tags|`param`|
|Aliases|`arg`, `argument`|
|Recommended|true|
|Options|`setDefaultDestructuredRootDescription`, `defaultDestructuredRootDescription`, `contexts`|
|Options|`contexts`, `defaultDestructuredRootDescription`, `setDefaultDestructuredRootDescription`|
|Settings|`exemptDestructuredRootsFromChecks`|

<a name="user-content-require-param-description-failing-examples"></a>
Expand Down
2 changes: 1 addition & 1 deletion docs/rules/require-param-type.md
Expand Up @@ -63,7 +63,7 @@ section of our README for more on the expected format.
|Tags|`param`|
|Aliases|`arg`, `argument`|
|Recommended|true|
|Options|`setDefaultDestructuredRootType`, `defaultDestructuredRootType`, `contexts`|
|Options|`contexts`, `defaultDestructuredRootType`, `setDefaultDestructuredRootType`|
|Settings|`exemptDestructuredRootsFromChecks`|

<a name="user-content-require-param-type-failing-examples"></a>
Expand Down

0 comments on commit 3d052ba

Please sign in to comment.