fix(require-yields-check): remove exemptedBy option

BREAKING CHANGE:

Removes `exemptedBy` from `require-yields-check`. Should not be needed.

Also:
- docs: create options dynamically from schemas

Author: brettz9

.README/README.md

@@ -380,10 +380,10 @@ non-default-recommended fixer).
 |||[check-examples](./docs/rules/check-examples.md#readme)|Linting of JavaScript within `@example`|
 |||[check-indentation](./docs/rules/check-indentation.md#readme)|Checks for invalid padding inside JSDoc blocks|
 ||:wrench:|[check-line-alignment](./docs/rules/check-line-alignment.md#readme)|Reports invalid alignment of JSDoc block lines.|
-|:heavy_check_mark:|:wrench:|[check-param-names](./docs/rules/check-param-names.md#readme)|Checks for dupe `@param` names, that nested param names have roots, and that parameter names in function declarations match jsdoc param names.|
+|:heavy_check_mark:|:wrench:|[check-param-names](./docs/rules/check-param-names.md#readme)|Checks for dupe `@param` names, that nested param names have roots, and that parameter names in function declarations match JSDoc param names.|
 |:heavy_check_mark:|:wrench:|[check-property-names](./docs/rules/check-property-names.md#readme)|Checks for dupe `@property` names, that nested property names have roots|
 |||[check-syntax](./docs/rules/check-syntax.md#readme)|Reports use against current mode (currently only prohibits Closure-specific syntax)|
-|:heavy_check_mark:|:wrench:|[check-tag-names](./docs/rules/check-tag-names.md#readme)|Reports invalid jsdoc (block) tag names|
+|:heavy_check_mark:|:wrench:|[check-tag-names](./docs/rules/check-tag-names.md#readme)|Reports invalid JSDoc (block) tag names|
 | || [check-template-names](./docs/rules/check-template-names.md#readme)|Checks that any `@template` names are actually used in the connected `@typedef` or type alias.
 |:heavy_check_mark:|:wrench:|[check-types](./docs/rules/check-types.md#readme)|Reports types deemed invalid (customizable and with defaults, for preventing and/or recommending replacements)|
 |:heavy_check_mark:||[check-values](./docs/rules/check-values.md#readme)|Checks for expected content within some miscellaneous tags (`@version`, `@since`, `@license`, `@author`)|
@@ -394,8 +394,8 @@ non-default-recommended fixer).
 |||[lines-before-block](./docs/rules/lines-before-block.md#readme)|Enforces minimum number of newlines before JSDoc comment blocks|
 |||[match-description](./docs/rules/match-description.md#readme)|Defines customizable regular expression rules for your tag descriptions|
 ||:wrench:|[match-name](./docs/rules/match-name.md#readme)|Reports the name portion of a JSDoc tag if matching or not matching a given regular expression|
-|:heavy_check_mark:|:wrench:|[multiline-blocks](./docs/rules/multiline-blocks.md#readme)|Controls how and whether jsdoc blocks can be expressed as single or multiple line blocks|
-||:wrench:|[no-bad-blocks](./docs/rules/no-bad-blocks.md#readme)|This rule checks for multi-line-style comments which fail to meet the criteria of a jsdoc block|
+|:heavy_check_mark:|:wrench:|[multiline-blocks](./docs/rules/multiline-blocks.md#readme)|Controls how and whether JSDoc blocks can be expressed as single or multiple line blocks|
+||:wrench:|[no-bad-blocks](./docs/rules/no-bad-blocks.md#readme)|This rule checks for multi-line-style comments which fail to meet the criteria of a JSDoc block|
 ||:wrench:|[no-blank-block-descriptions](./docs/rules/no-blank-block-descriptions.md#readme)|If tags are present, this rule will prevent empty lines in the block description. If no tags are present, this rule will prevent extra empty lines in the block description.|
 ||:wrench:|[no-blank-blocks](./docs/rules/no-blank-blocks.md#readme)|Reports and optionally removes blocks with whitespace only|
 |:heavy_check_mark:|:wrench:|[no-defaults](./docs/rules/no-defaults.md#readme)|This rule reports defaults being used on the relevant portion of `@param` or `@default`|
@@ -412,7 +412,7 @@ non-default-recommended fixer).
 ||:wrench:|[require-example](./docs/rules/require-example.md#readme)|Requires that all functions (and potentially other contexts) have examples.|
 |||[require-file-overview](./docs/rules/require-file-overview.md#readme)|By default, requires a single `@file` tag at the beginning of each linted file|
 ||:wrench:|[require-hyphen-before-param-description](./docs/rules/require-hyphen-before-param-description.md#readme)|Requires a hyphen before `@param` descriptions (and optionally before `@property` descriptions)|
-|:heavy_check_mark:|:wrench:|[require-jsdoc](./docs/rules/require-jsdoc.md#readme)|Checks for presence of jsdoc comments, on functions and potentially other contexts (optionally limited to exports).|
+|:heavy_check_mark:|:wrench:|[require-jsdoc](./docs/rules/require-jsdoc.md#readme)|Checks for presence of JSDoc comments, on functions and potentially other contexts (optionally limited to exports).|
 |:heavy_check_mark:||[require-next-type](./docs/rules/require-next-type.md#readme)|Requires a type on the (non-standard) `@next` tag.|
 |:heavy_check_mark:|:wrench:|[require-param](./docs/rules/require-param.md#readme)|Requires that all function parameters are documented with a `@param` tag.|
 |:heavy_check_mark:||[require-param-description](./docs/rules/require-param-description.md#readme)|Requires that each `@param` tag has a `description` value.|
@@ -423,7 +423,7 @@ non-default-recommended fixer).
 |:heavy_check_mark:||[require-property-name](./docs/rules/require-property-name.md#readme)|Requires that all `@property` tags have names.|
 |:heavy_check_mark: (off in TS)||[require-property-type](./docs/rules/require-property-type.md#readme)|Requires that each `@property` tag has a type value (within curly brackets).|
 |:heavy_check_mark:||[require-returns](./docs/rules/require-returns.md#readme)|Requires that return statements are documented.|
-|:heavy_check_mark:||[require-returns-check](./docs/rules/require-returns-check.md#readme)|Requires a return statement be present in a function body if a `@returns` tag is specified in the jsdoc comment block (and reports if multiple `@returns` tags are present).|
+|:heavy_check_mark:||[require-returns-check](./docs/rules/require-returns-check.md#readme)|Requires a return statement be present in a function body if a `@returns` tag is specified in the JSDoc comment block (and reports if multiple `@returns` tags are present).|
 |:heavy_check_mark:||[require-returns-description](./docs/rules/require-returns-description.md#readme)|Requires that the `@returns` tag has a `description` value (not including `void`/`undefined` type returns).|
 |:heavy_check_mark: (off in TS)||[require-returns-type](./docs/rules/require-returns-type.md#readme)|Requires that `@returns` tag has a type value (in curly brackets).|
 | || [require-template](./docs/rules/require-template.md#readme) | Requires `@template` tags be present when type parameters are used.|

.README/rules/check-alignment.md

@@ -10,10 +10,7 @@ Fixes alignment.
 
 ## Options
 
-### `innerIndent`
-
-Set to 0 if you wish to avoid the normal requirement for an inner indentation of
-one space. Defaults to 1 (one space of normal inner indentation).
+{"gitdown": "options"}
 
 ## Context and settings
 

.README/rules/check-examples.md

@@ -151,8 +151,8 @@ by decreasing precedence:
 * `padded-blocks` (and `@stylistic/padded-blocks`) - It can generally look
   nicer to pad a little even if one's code follows more stringency as far
   as block padding.
-* `jsdoc/require-file-overview` - Shouldn't check example for jsdoc blocks.
-* `jsdoc/require-jsdoc` - Wouldn't expect jsdoc blocks within jsdoc blocks.
+* `jsdoc/require-file-overview` - Shouldn't check example for JSDoc blocks.
+* `jsdoc/require-jsdoc` - Wouldn't expect JSDoc blocks within JSDoc blocks.
 * `import/no-unresolved` - One wouldn't generally expect example paths to
   resolve relative to the current JavaScript file as one would with real code.
 * `import/unambiguous` - Snippets in examples are likely too short to always

.README/rules/check-indentation.md

@@ -20,29 +20,7 @@ the following description is not reported:
 
 ## Options
 
-This rule has an object option.
-
-### `excludeTags`
-
-Array of tags (e.g., `['example', 'description']`) whose content will be
-"hidden" from the `check-indentation` rule. Defaults to `['example']`.
-
-By default, the whole JSDoc block will be checked for invalid padding.
-That would include `@example` blocks too, which can get in the way
-of adding full, readable examples of code without ending up with multiple
-linting issues.
-
-When disabled (by passing `excludeTags: []` option), the following code *will*
-report a padding issue:
-
-```js
-/**
- * @example
- * anArray.filter((a) => {
- *   return a.b;
- * });
- */
-```
+{"gitdown": "options"}
 
 ## Context and settings
 

.README/rules/check-line-alignment.md

@@ -8,50 +8,12 @@ for example.
 
 ## Fixer
 
-(TODO)
+Will either add alignment between the tag, type, name, and description across
+lines of the JSDoc block or remove it.
 
 ## Options
 
-This rule allows one optional string argument. If it is `"always"` then a
-problem is raised when the lines are not aligned. If it is `"never"` then
-a problem should be raised when there is more than one space between each
-line's parts. If it is `"any"`, no alignment is made. Defaults to `"never"`.
-
-Note that in addition to alignment, the "never" and "always" options will both
-ensure that at least one space is present after the asterisk delimiter.
-
-After the string, an options object is allowed with the following properties.
-
-### `tags`
-
-Use this to change the tags which are sought for alignment changes. Defaults to an array of
-`['param', 'arg', 'argument', 'property', 'prop', 'returns', 'return', 'template']`.
-
-### `customSpacings`
-
-An object with any of the following keys set to an integer. Affects spacing:
-
-- `postDelimiter` - after the asterisk (e.g., `*   @param`)
-- `postTag` - after the tag (e.g., `* @param  `)
-- `postType` - after the type (e.g., `* @param {someType}   `)
-- `postName` - after the name (e.g., `* @param {someType} name   `)
-- `postHyphen` - after any hyphens in the description (e.g., `* @param {someType} name -  A description`)
-
-If a spacing is not defined, it defaults to one.
-
-### `preserveMainDescriptionPostDelimiter`
-
-A boolean to determine whether to preserve the post-delimiter spacing of the
-main description. If `false` or unset, will be set to a single space.
-
-### `wrapIndent`
-
-The indent that will be applied for tag text after the first line.
-Default to the empty string (no indent).
-
-### `disableWrapIndent`
-
-Disables `wrapIndent`; existing wrap indentation is preserved without changes.
+{"gitdown": "options"}
 
 ## Context and settings
 

.README/rules/check-param-names.md

@@ -7,7 +7,11 @@ the function declaration.
 
 ## Fixer
 
-(Todo)
+Auto-removes `@param` duplicates (based on identical names).
+
+Note that this option will remove duplicates of the same name even if
+the definitions do not match in other ways (e.g., the second param will
+be removed even if it has a different type or description).
 
 ## Destructuring
 
@@ -28,62 +32,15 @@ To require that `extra` be documented--and that any extraneous properties
 get reported--e.g., if there had been a `@param options.bar` above--you
 can use the `checkRestProperty` option which insists that the rest
 property be documented (and that there be no other implicit properties).
-Note, however, that jsdoc [does not appear](https://github.com/jsdoc/jsdoc/issues/1773)
+Note, however, that JSDoc [does not appear](https://github.com/jsdoc/jsdoc/issues/1773)
 to currently support syntax or output to distinguish rest properties from
 other properties, so in looking at the docs alone without looking at the
 function signature, the disadvantage of enabling this option is that it
 may appear that there is an actual property named `extra`.
 
 ## Options
 
-### `checkRestProperty`
-
-See the "Destructuring" section. Defaults to `false`.
-
-### `checkTypesPattern`
-
-See `require-param` under the option of the same name.
-
-### `enableFixer`
-
-Set to `true` to auto-remove `@param` duplicates (based on identical
-names).
-
-Note that this option will remove duplicates of the same name even if
-the definitions do not match in other ways (e.g., the second param will
-be removed even if it has a different type or description).
-
-### `allowExtraTrailingParamDocs`
-
-If set to `true`, this option will allow extra `@param` definitions (e.g.,
-representing future expected or virtual params) to be present without needing
-their presence within the function signature. Other inconsistencies between
-`@param`'s and present function parameters will still be reported.
-
-### `checkDestructured`
-
-Whether to check destructured properties. Defaults to `true`.
-
-### `useDefaultObjectProperties`
-
-Set to `true` if you wish to avoid reporting of child property documentation
-where instead of destructuring, a whole plain object is supplied as default
-value but you wish its keys to be considered as signalling that the properties
-are present and can therefore be documented. Defaults to `false`.
-
-### `disableExtraPropertyReporting`
-
-Whether to check for extra destructured properties. Defaults to `false`. Change
-to `true` if you want to be able to document properties which are not actually
-destructured. Keep as `false` if you expect properties to be documented in
-their own types. Note that extra properties will always be reported if another
-item at the same level is destructured as destructuring will prevent other
-access and this option is only intended to permit documenting extra properties
-that are available and actually used in the function.
-
-### `disableMissingParamChecks`
-
-Whether to avoid checks for missing `@param` definitions. Defaults to `false`. Change to `true` if you want to be able to omit properties.
+{"gitdown": "options"}
 
 ## Context and settings
 

.README/rules/check-property-names.md

@@ -7,19 +7,16 @@ and that nested properties have defined roots.
 
 ## Fixer
 
-(Todo)
-
-## Options
-
-### `enableFixer`
-
-Set to `true` to auto-remove `@property` duplicates (based on
-identical names).
+Auto-removes `@property` duplicates (based on identical names).
 
 Note that this option will remove duplicates of the same name even if
 the definitions do not match in other ways (e.g., the second property will
 be removed even if it has a different type or description).
 
+## Options
+
+{"gitdown": "options"}
+
 ## Context and settings
 
 |||

.README/rules/check-tag-names.md

@@ -134,7 +134,7 @@ template
 
 And for [Closure](https://github.com/google/closure-compiler/wiki/Annotating-JavaScript-for-the-Closure-Compiler),
 when `settings.jsdoc.mode` is set to `closure`, one may use the following (in
-addition to the jsdoc and TypeScript tags–though replacing `returns` with
+addition to the JSDoc and TypeScript tags–though replacing `returns` with
 `return`):
 
 ```
@@ -194,92 +194,11 @@ tag to `false`:
 
 ## Fixer
 
-(Todo)
+Auto-removes types that are redundant with the [`typed` option](#typed).
 
 ## Options
 
-### `definedTags`
-
-Use an array of `definedTags` strings to configure additional, allowed tags.
-The format is as follows:
-
-```json
-{
-  "definedTags": ["note", "record"]
-}
-```
-
-### `enableFixer`
-
-Set to `false` to disable auto-removal of types that are redundant with the [`typed` option](#typed).
-
-### `jsxTags`
-
-If this is set to `true`, all of the following tags used to control JSX output are allowed:
-
-```
-jsx
-jsxFrag
-jsxImportSource
-jsxRuntime
-```
-
-For more information, see the [babel documentation](https://babeljs.io/docs/en/babel-plugin-transform-react-jsx).
-
-### `typed`
-
-If this is set to `true`, additionally checks for tag names that are redundant when using a type checker such as TypeScript.
-
-These tags are always unnecessary when using TypeScript or similar:
-
-```
-augments
-callback
-class
-enum
-implements
-private
-property
-protected
-public
-readonly
-this
-type
-typedef
-```
-
-These tags are unnecessary except when inside a TypeScript `declare` context:
-
-```
-abstract
-access
-class
-constant
-constructs
-default
-enum
-export
-exports
-function
-global
-inherits
-instance
-interface
-member
-memberof
-memberOf
-method
-mixes
-mixin
-module
-name
-namespace
-override
-property
-requires
-static
-this
-```
+{"gitdown": "options"}
 
 ## Context and settings