fix: ensure all rules marked with recommended status; add table prope…

…rty for recommended status; fixes #652

.README/README.md

@@ -44,27 +44,39 @@ Finally, enable all of the rules that you would like to use.
 ```javascript
 {
     "rules": {
+        "jsdoc/check-access": 1, // Recommended
         "jsdoc/check-alignment": 1, // Recommended
         "jsdoc/check-examples": 1,
         "jsdoc/check-indentation": 1,
+        "jsdoc/check-line-alignment": 1,
         "jsdoc/check-param-names": 1, // Recommended
+        "jsdoc/check-property-names": 1, // Recommended
         "jsdoc/check-syntax": 1,
         "jsdoc/check-tag-names": 1, // Recommended
         "jsdoc/check-types": 1, // Recommended
+        "jsdoc/check-values": 1, // Recommended
+        "jsdoc/empty-tags": 1, // Recommended
         "jsdoc/implements-on-classes": 1, // Recommended
         "jsdoc/match-description": 1,
         "jsdoc/newline-after-description": 1, // Recommended
+        "jsdoc/no-bad-blocks": 1,
+        "jsdoc/no-defaults": 1,
         "jsdoc/no-types": 1,
         "jsdoc/no-undefined-types": 1, // Recommended
         "jsdoc/require-description": 1,
         "jsdoc/require-description-complete-sentence": 1,
         "jsdoc/require-example": 1,
+        "jsdoc/require-file-overview": 1,
         "jsdoc/require-hyphen-before-param-description": 1,
         "jsdoc/require-jsdoc": 1, // Recommended
         "jsdoc/require-param": 1, // Recommended
         "jsdoc/require-param-description": 1, // Recommended
         "jsdoc/require-param-name": 1, // Recommended
         "jsdoc/require-param-type": 1, // Recommended
+        "jsdoc/require-property": 1, // Recommended
+        "jsdoc/require-property-description": 1, // Recommended
+        "jsdoc/require-property-name": 1, // Recommended
+        "jsdoc/require-property-type": 1, // Recommended
         "jsdoc/require-returns": 1, // Recommended
         "jsdoc/require-returns-check": 1, // Recommended
         "jsdoc/require-returns-description": 1, // Recommended

.README/rules/check-access.md

@@ -15,6 +15,7 @@ Also reports:
 |---|---|
 |Context|everywhere|
 |Tags|`@access`|
+|Recommended|false|
 |Settings||
 |Options||
 

.README/rules/check-alignment.md

@@ -6,5 +6,6 @@ Reports invalid alignment of JSDoc block asterisks.
 |---|---|
 |Context|everywhere|
 |Tags|N/A|
+|Recommended|true|
 
 <!-- assertions checkAlignment -->

.README/rules/check-examples.md

@@ -166,6 +166,7 @@ expression-oriented rules will be used by default as well:
 |---|---|
 |Context|everywhere|
 |Tags|`example`|
+|Recommended|false|
 |Options| *See above* |
 
 <!-- assertions checkExamples -->

.README/rules/check-indentation.md

@@ -46,6 +46,7 @@ report a padding issue:
 |---|---|
 |Context|everywhere|
 |Tags|N/A|
+|Recommended|false|
 |Options| `excludeTags` |
 
 <!-- assertions checkIndentation -->

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

@@ -17,5 +17,6 @@ line's parts. **Only the non-default `"always"` is implemented for now.**
 |Options|(a string matching `"always"|"never"`)|
 |Tags|`param`, `property`|
 |Aliases|`arg`, `argument`, `prop`|
+|Recommended|false|
 
 <!-- assertions checkLineAlignment -->

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

@@ -63,4 +63,5 @@ Whether to check destructured properties. Defaults to `true`.
 |Options|`allowExtraTrailingParamDocs`, `checkDestructured`, `checkRestProperty`, `checkTypesPattern`|
 |Tags|`param`|
 |Aliases|`arg`, `argument`|
+|Recommended|true|
 <!-- assertions checkParamNames -->

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

@@ -20,5 +20,6 @@ be removed even if it has a different type or description).
 |Options|`enableFixer`|
 |Tags|`property`|
 |Aliases|`prop`|
+|Recommended|true|
 
 <!-- assertions checkPropertyNames -->

.README/rules/check-syntax.md

@@ -17,5 +17,6 @@ rule is enforced (except under "permissive" and "closure" modes).
 |---|---|
 |Context|everywhere|
 |Tags|N/A|
+|Recommended|false|
 
 <!-- assertions checkSyntax -->

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

@@ -187,6 +187,7 @@ The format is as follows:
 |---|---|
 |Context|everywhere|
 |Tags|N/A|
+|Recommended|true|
 |Options|`definedTags`|
 |Settings|`tagNamePreference`, `mode`|
 

.README/rules/check-types.md

@@ -130,6 +130,7 @@ for types, you can use `settings.jsdoc.structuredTags` with a tag `type` of
 |Tags|`augments`, `class`, `constant`, `enum`, `implements`, `member`, `module`, `namespace`, `param`, `property`, `returns`, `throws`, `type`, `typedef`, `yields`|
 |Aliases|`constructor`, `const`, `extends`, `var`, `arg`, `argument`, `prop`, `return`, `exception`, `yield`|
 |Closure-only|`package`, `private`, `protected`, `public`, `static`|
+|Recommended|true|
 |Options|`noDefaults`, `exemptTagContexts`, `unifyParentAndChildTypeChecks`|
 |Settings|`preferredTypes`, `mode`, `structuredTags`|
 

.README/rules/check-values.md

@@ -35,6 +35,7 @@ is expected before any line breaks.
 |---|---|
 |Context|everywhere|
 |Tags|`@version`, `@since`, `@license`, `@author`|
+|Recommended|true|
 |Options|`allowedAuthors`, `allowedLicenses`, `licensePattern`|
 |Settings|`tagNamePreference`|
 

.README/rules/empty-tags.md

@@ -48,5 +48,6 @@ add them within this option.
 |---|---|
 |Context|everywhere|
 |Tags| `abstract`, `async`, `generator`, `global`, `hideconstructor`, `ignore`, `inheritdoc`, `inner`, `instance`, `internal`, `override`, `readonly`, `package`, `private`, `protected`, `public`, `static` and others added by `tags`|
+|Recommended|true|
 |Options|`tags`|
 <!-- assertions emptyTags -->

.README/rules/implements-on-classes.md

@@ -29,6 +29,7 @@ section of our README for more on the expected format.
 |---|---|
 |Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`; others when `contexts` option enabled|
 |Tags|`implements` (prevented)|
+|Recommended|true|
 |Options|`contexts`|
 
 <!-- assertions implementsOnClasses -->

.README/rules/match-description.md

@@ -99,6 +99,7 @@ section of our README for more on the expected format.
 |Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`; others when `contexts` option enabled|
 |Tags|docblock and `@description` by default but more with `tags`|
 |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`|
 

.README/rules/newline-after-description.md

@@ -12,7 +12,8 @@ description. The default value is `"always"`.
 |||
 |---|---|
 |Context|everywhere|
-|Options|(a string matching `"always"|"never"`)|
 |Tags|N/A (doc block)|
+|Options|(a string matching `"always"|"never"`)|
+|Recommended|true|
 
 <!-- assertions newlineAfterDescription -->

.README/rules/no-bad-blocks.md

@@ -21,7 +21,8 @@ Defaults to `['ts-check', 'ts-expect-error', 'ts-ignore', 'ts-nocheck']`
 |||
 |---|---|
 |Context|Everywhere|
-|Options|`ignore`|
 |Tags|N/A|
+|Recommended|false|
+|Options|`ignore`|
 
 <!-- assertions noBadBlocks -->

.README/rules/no-defaults.md

@@ -40,6 +40,7 @@ section of our README for more on the expected format.
 |Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`; others when `contexts` option enabled|
 |Tags|`param`, `default`|
 |Aliases|`arg`, `argument`, `defaultvalue`|
+|Recommended|false|
 |Options|`contexts`, `noOptionalParamNames`|
 
 <!-- assertions noDefaults -->

.README/rules/no-types.md

@@ -25,6 +25,7 @@ section of our README for more on the expected format.
 |Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`; others when `contexts` option enabled|
 |Tags|`param`, `returns`|
 |Aliases|`arg`, `argument`, `return`|
+|Recommended|false|
 |Options|`contexts`|
 
 <!-- assertions noTypes -->

.README/rules/no-undefined-types.md

@@ -55,6 +55,7 @@ An option object may have the following key:
 |Tags|`augments`, `class`, `constant`, `enum`, `implements`, `member`, `module`, `namespace`, `param`, `property`, `returns`, `throws`, `type`, `typedef`, `yields`|
 |Aliases|`constructor`, `const`, `extends`, `var`, `arg`, `argument`, `prop`, `return`, `exception`, `yield`|
 |Closure-only|`package`, `private`, `protected`, `public`, `static`|
+|Recommended|true|
 |Options|`definedTypes`|
 |Settings|`preferredTypes`, `mode`, `structuredTags`|
 

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

@@ -56,5 +56,6 @@ nouns, for example).
 |Context|everywhere|
 |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`|
 <!-- assertions requireDescriptionCompleteSentence -->

.README/rules/require-description.md

@@ -36,6 +36,7 @@ An options object may have any of the following properties:
 | Context  | `ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`; others when `contexts` option enabled |
 | Tags     | `description` or jsdoc block                                                                                  |
 | Aliases  | `desc`                                                                                                        |
+| Recommended | false |
 | Options  | `contexts`, `exemptedBy`, `descriptionStyle`, `checkConstructors`, `checkGetters`, `checkSetters`             |
 | Settings | `overrideReplacesDocs`, `augmentsExtendsReplacesDocs`, `implementsReplacesDocs`                               |
 

.README/rules/require-example.md

@@ -55,6 +55,7 @@ report a missing example description after this is added.
 |---|---|
 |Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`; others when `contexts` option enabled|
 |Tags|`example`|
+|Recommended|false|
 |Options|`exemptedBy`, `exemptNoArguments`, `avoidExampleOnConstructors`, `contexts`|
 |Settings|`overrideReplacesDocs`, `augmentsExtendsReplacesDocs`, `implementsReplacesDocs`|
 

.README/rules/require-file-overview.md

@@ -72,6 +72,7 @@ will be checked, but you must use `file` on the configuration object).
 |Context|Everywhere|
 |Tags|`file`; others when `tags` set|
 |Aliases|`fileoverview`, `overview`|
+|Recommended|false|
 |Options|`tags`|
 
 <!-- assertions requireFileOverview -->

.README/rules/require-hyphen-before-param-description.md

@@ -26,6 +26,7 @@ other tags besides the `@param` tag (or the `@arg` tag if so set):
 |Context|everywhere|
 |Tags|`param` and optionally other tags within `tags`|
 |Aliases|`arg`, `argument`; potentially `prop` or other aliases|
+|Recommended|false|
 |Options|(a string matching `"always"|"never"`) followed by an optional object with a `tags` property|
 
 <!-- assertions requireHyphenBeforeParamDescription -->

.README/rules/require-jsdoc.md

@@ -82,6 +82,7 @@ Defaults to `true`.
 |---|---|
 |Context|`ArrowFunctionExpression`, `ClassDeclaration`, `ClassExpression`, `FunctionDeclaration`, `FunctionExpression`; others when `contexts` option enabled|
 |Tags|N/A|
+|Recommended|true|
 |Options|`publicOnly`, `require`, `contexts`, `exemptEmptyConstructors`, `exemptEmptyFunctions`, `enableFixer`|
 
 <!-- assertions requireJsdoc -->

.README/rules/require-param-description.md

@@ -22,6 +22,7 @@ section of our README for more on the expected format.
 |Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`; others when `contexts` option enabled|
 |Tags|`param`|
 |Aliases|`arg`, `argument`|
+|Recommended|true|
 |Options|`contexts`|
 
 <!-- assertions requireParamDescription -->

.README/rules/require-param-name.md

@@ -26,6 +26,7 @@ section of our README for more on the expected format.
 |Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`; others when `contexts` option enabled|
 |Tags|`param`|
 |Aliases|`arg`, `argument`|
+|Recommended|true|
 |Options|`contexts`|
 
 <!-- assertions requireParamName -->

.README/rules/require-param-type.md

@@ -22,6 +22,7 @@ section of our README for more on the expected format.
 |Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`; others when `contexts` option enabled|
 |Tags|`param`|
 |Aliases|`arg`, `argument`|
+|Recommended|true|
 |Options|`contexts`|
 
 <!-- assertions requireParamType -->

.README/rules/require-param.md

@@ -364,6 +364,7 @@ documentation). Defaults to `true`.
 | Context  | `ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`; others when `contexts` option enabled |
 | Tags     | `param`                                                                                                       |
 | Aliases  | `arg`, `argument`                                                                                             |
+|Recommended|true|
 | Options  | `autoIncrementBase`, `checkDestructured`, `checkDestructuredRoots`, `contexts`, `enableFixer`, `enableRootFixer`, `enableRestElementFixer`, `checkRestProperty`, `exemptedBy`, `checkConstructors`, `checkGetters`, `checkSetters`, `checkTypesPattern`, `unnamedRootBase`                                 |
 | Settings | `overrideReplacesDocs`, `augmentsExtendsReplacesDocs`, `implementsReplacesDocs`                               |
 

.README/rules/require-property-description.md

@@ -7,5 +7,6 @@ Requires that each `@property` tag has a `description` value.
 |Context|everywhere|
 |Tags|`property`|
 |Aliases|`prop`|
+|Recommended|true|
 
 <!-- assertions requirePropertyDescription -->

.README/rules/require-property-name.md

@@ -7,5 +7,6 @@ Requires that all function `@property` tags have names.
 |Context|everywhere|
 |Tags|`property`|
 |Aliases|`prop`|
+|Recommended|true|
 
 <!-- assertions requirePropertyName -->

.README/rules/require-property-type.md

@@ -7,5 +7,6 @@ Requires that each `@property` tag has a `type` value.
 |Context|everywhere|
 |Tags|`property`|
 |Aliases|`prop`|
+|Recommended|true|
 
 <!-- assertions requirePropertyType -->

.README/rules/require-property.md

@@ -14,5 +14,6 @@ The fixer for `require-property` will add an empty `@property`.
 |---|---|
 |Context|Everywhere|
 |Tags|`typedef`, `namespace`|
+|Recommended|true|
 
 <!-- assertions requireProperty -->

.README/rules/require-returns-check.md

@@ -10,5 +10,6 @@ Will also report if multiple `@returns` tags are present.
 |Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`|
 |Tags|`returns`|
 |Aliases|`return`|
+|Recommended|true|
 
 <!-- assertions requireReturnsCheck -->

.README/rules/require-returns-description.md

@@ -24,6 +24,7 @@ section of our README for more on the expected format.
 |Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`; others when `contexts` option enabled|
 |Tags|`returns`|
 |Aliases|`return`|
+|Recommended|true|
 |Options|`contexts`|
 
 <!-- assertions requireReturnsDescription -->

.README/rules/require-returns-type.md

@@ -22,6 +22,7 @@ section of our README for more on the expected format.
 |Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`; others when `contexts` option enabled|
 |Tags|`returns`|
 |Aliases|`return`|
+|Recommended|true|
 |Options|`contexts`|
 
 <!-- assertions requireReturnsType -->

.README/rules/require-returns.md

@@ -48,6 +48,7 @@ Will also report if multiple `@returns` tags are present.
 | Context  | `ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`; others when `contexts` option enabled |
 | Tags     | `returns` |
 | Aliases  | `return` |
+|Recommended|true|
 | Options  | `checkConstructors`, `checkGetters`, `contexts`, `exemptedBy`, `forceRequireReturn`, `forceReturnsWithAsync` |
 | Settings | `overrideReplacesDocs`, `augmentsExtendsReplacesDocs`, `implementsReplacesDocs` |
 

.README/rules/require-throws.md

@@ -26,6 +26,7 @@ Requires that throw statements are documented.
 | Context  | `ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`; others when `contexts` option enabled |
 | Tags     | `throws` |
 | Aliases  | `exception` |
+|Recommended|true|
 | Options  | `contexts`, `exemptedBy` |
 | Settings | `overrideReplacesDocs`, `augmentsExtendsReplacesDocs`, `implementsReplacesDocs` |
 

.README/rules/valid-types.md

@@ -93,6 +93,7 @@ value). See the setting for more details.
 |Tags|For name only unless otherwise stated: `alias`, `augments`, `borrows`, `callback`, `class` (for name and type), `constant` (for name and type), `enum` (for type), `event`, `external`, `fires`, `function`, `implements` (for type), `interface`, `lends`, `listens`, `member` (for name and type),  `memberof`, `memberof!`, `mixes`, `mixin`, `modifies`, `module` (for name and type), `name`, `namespace` (for name and type), `param` (for name and type), `property` (for name and type), `returns` (for type), `see` (optionally for name), `this`, `throws` (for type), `type` (for type), `typedef` (for name and type), `yields` (for type)|
 |Aliases|`extends`, `constructor`, `const`, `host`, `emits`, `func`, `method`, `var`, `arg`, `argument`, `prop`, `return`, `exception`, `yield`|
 |Closure-only|For type only: `package`, `private`, `protected`, `public`, `static`|
+|Recommended|true|
 |Options|`allowEmptyNamepaths`|
 |Settings|`mode`, `structuredTags`|