docs: add meta.docs.description to every rule

gajus · Jun 17, 2020 · 0d29a80 · 0d29a80
1 parent 96408fd
commit 0d29a80
Show file tree

Hide file tree

Showing 37 changed files with 109 additions and 1 deletion.
diff --git a/src/rules/checkAccess.js b/src/rules/checkAccess.js
@@ -35,6 +35,9 @@ export default iterateJsdoc(({
   checkPrivate: true,
   iterateAllJsdocs: true,
   meta: {
+    docs: {
+      description: 'Checks that `@access` tags have a valid value.',
+    },
     type: 'suggestion',
   },
 });
diff --git a/src/rules/checkAlignment.js b/src/rules/checkAlignment.js
@@ -48,6 +48,9 @@ export default iterateJsdoc(({
 }, {
   iterateAllJsdocs: true,
   meta: {
+    docs: {
+      description: 'Reports invalid alignment of JSDoc block asterisks.',
+    },
     fixable: 'code',
     type: 'layout',
   },

diff --git a/src/rules/checkExamples.js b/src/rules/checkExamples.js
@@ -289,6 +289,9 @@ export default iterateJsdoc(({
 }, {
   iterateAllJsdocs: true,
   meta: {
+    docs: {
+      description: 'Ensures that (JavaScript) examples within JSDoc adhere to ESLint rules.',
+    },
     schema: [
       {
         additionalProperties: false,

diff --git a/src/rules/checkIndentation.js b/src/rules/checkIndentation.js
@@ -40,6 +40,9 @@ export default iterateJsdoc(({
 }, {
   iterateAllJsdocs: true,
   meta: {
+    docs: {
+      description: 'Reports invalid padding inside JSDoc blocks.',
+    },
     schema: [{
       additionalProperties: false,
       properties: {

diff --git a/src/rules/checkParamNames.js b/src/rules/checkParamNames.js
@@ -222,6 +222,9 @@ export default iterateJsdoc(({
   );
 }, {
   meta: {
+    docs: {
+      description: 'Ensures that parameter names in JSDoc match those in the function declaration.',
+    },
     fixable: 'code',
     schema: [
       {

diff --git a/src/rules/checkPropertyNames.js b/src/rules/checkPropertyNames.js
@@ -100,6 +100,9 @@ export default iterateJsdoc(({
 }, {
   iterateAllJsdocs: true,
   meta: {
+    docs: {
+      description: 'Ensures that property names in JSDoc are not duplicated on the same block and that nested properties have defined roots.',
+    },
     fixable: 'code',
     schema: [
       {

diff --git a/src/rules/checkSyntax.js b/src/rules/checkSyntax.js
@@ -17,6 +17,9 @@ export default iterateJsdoc(({
 }, {
   iterateAllJsdocs: true,
   meta: {
+    docs: {
+      description: 'Reports against Google Closure Compiler syntax.',
+    },
     type: 'suggestion',
   },
 });
diff --git a/src/rules/checkTagNames.js b/src/rules/checkTagNames.js
@@ -76,6 +76,9 @@ export default iterateJsdoc(({
 }, {
   iterateAllJsdocs: true,
   meta: {
+    docs: {
+      description: 'Reports invalid block tag names.',
+    },
     fixable: 'code',
     schema: [
       {

diff --git a/src/rules/checkTypes.js b/src/rules/checkTypes.js
@@ -226,6 +226,9 @@ export default iterateJsdoc(({
 }, {
   iterateAllJsdocs: true,
   meta: {
+    docs: {
+      description: 'Reports invalid types.',
+    },
     fixable: 'code',
     schema: [
       {

diff --git a/src/rules/checkValues.js b/src/rules/checkValues.js
@@ -98,6 +98,9 @@ export default iterateJsdoc(({
 }, {
   iterateAllJsdocs: true,
   meta: {
+    docs: {
+      description: 'This rule checks the values for a handful of tags: `@version`, `@since`, `@license` and `@author`.',
+    },
     schema: [
       {
         additionalProperties: false,

diff --git a/src/rules/emptyTags.js b/src/rules/emptyTags.js
@@ -48,6 +48,9 @@ export default iterateJsdoc(({
   checkPrivate: true,
   iterateAllJsdocs: true,
   meta: {
+    docs: {
+      description: 'Expects specific tags to be empty of any content.',
+    },
     fixable: 'code',
     schema: [
       {

diff --git a/src/rules/implementsOnClasses.js b/src/rules/implementsOnClasses.js
@@ -25,6 +25,9 @@ export default iterateJsdoc(({
 }, {
   contextDefaults: true,
   meta: {
+    docs: {
+      description: 'Reports an issue with any non-constructor function using `@implements`.',
+    },
     schema: [
       {
         additionalProperties: false,

diff --git a/src/rules/matchDescription.js b/src/rules/matchDescription.js
@@ -81,6 +81,9 @@ export default iterateJsdoc(({
 }, {
   contextDefaults: true,
   meta: {
+    docs: {
+      description: 'Enforces a regular expression pattern on descriptions.',
+    },
     schema: [
       {
         additionalProperties: false,

diff --git a/src/rules/newlineAfterDescription.js b/src/rules/newlineAfterDescription.js
@@ -55,6 +55,9 @@ export default iterateJsdoc(({
 }, {
   iterateAllJsdocs: true,
   meta: {
+    docs: {
+      description: 'Enforces a consistent padding of the block description.',
+    },
     fixable: 'whitespace',
     schema: [
       {

diff --git a/src/rules/noBadBlocks.js b/src/rules/noBadBlocks.js
@@ -26,6 +26,9 @@ export default iterateJsdoc(({
 }, {
   checkFile: true,
   meta: {
+    docs: {
+      description: 'This rule checks for multi-line-style comments which fail to meet the criteria of a jsdoc block.',
+    },
     fixable: 'code',
     type: 'layout',
   },

diff --git a/src/rules/noDefaults.js b/src/rules/noDefaults.js
@@ -29,6 +29,9 @@ export default iterateJsdoc(({
 }, {
   contextDefaults: true,
   meta: {
+    docs: {
+      description: 'This rule reports defaults being used on the relevant portion of `@param` or `@default`.',
+    },
     fixable: 'code',
     schema: [
       {

diff --git a/src/rules/noTypes.js b/src/rules/noTypes.js
@@ -19,6 +19,9 @@ export default iterateJsdoc(({
 }, {
   contextDefaults: true,
   meta: {
+    docs: {
+      description: 'This rule reports types being used on `@param` or `@returns`.',
+    },
     fixable: 'code',
     schema: [
       {

diff --git a/src/rules/noUndefinedTypes.js b/src/rules/noUndefinedTypes.js
@@ -153,6 +153,9 @@ export default iterateJsdoc(({
 }, {
   iterateAllJsdocs: true,
   meta: {
+    docs: {
+      description: 'Checks that types in jsdoc comments are defined.',
+    },
     schema: [
       {
         additionalProperties: false,

diff --git a/src/rules/requireDescription.js b/src/rules/requireDescription.js
@@ -70,6 +70,9 @@ export default iterateJsdoc(({
 }, {
   contextDefaults: true,
   meta: {
+    docs: {
+      description: 'Requires that all functions have a description.',
+    },
     schema: [
       {
         additionalProperties: false,

diff --git a/src/rules/requireDescriptionCompleteSentence.js b/src/rules/requireDescriptionCompleteSentence.js
@@ -201,6 +201,9 @@ export default iterateJsdoc(({
 }, {
   iterateAllJsdocs: true,
   meta: {
+    docs: {
+      description: 'Requires that block description, explicit `@description`, and `@param`/`@returns` tag descriptions are written in complete sentences.',
+    },
     fixable: 'code',
     schema: [
       {

diff --git a/src/rules/requireExample.js b/src/rules/requireExample.js
@@ -45,6 +45,9 @@ export default iterateJsdoc(({
 }, {
   contextDefaults: true,
   meta: {
+    docs: {
+      description: 'Requires that all functions have examples.',
+    },
     fixable: 'code',
     schema: [
       {

diff --git a/src/rules/requireFileOverview.js b/src/rules/requireFileOverview.js
@@ -90,6 +90,9 @@ export default iterateJsdoc(({
   },
   iterateAllJsdocs: true,
   meta: {
+    docs: {
+      description: 'Checks that all files have one `@file`, `@fileoverview`, or `@overview` tag at the beginning of the file.',
+    },
     schema: [
       {
         additionalProperties: false,

diff --git a/src/rules/requireHyphenBeforeParamDescription.js b/src/rules/requireHyphenBeforeParamDescription.js
@@ -74,6 +74,9 @@ export default iterateJsdoc(({
 }, {
   iterateAllJsdocs: true,
   meta: {
+    docs: {
+      description: 'Requires a hyphen before the `@param` description.',
+    },
     fixable: 'code',
     schema: [
       {

diff --git a/src/rules/requireJsdoc.js b/src/rules/requireJsdoc.js
@@ -279,7 +279,7 @@ export default {
     );
   },
   meta: {
-    doc: {
+    docs: {
       category: 'Stylistic Issues',
       description: 'Require JSDoc comments',
       recommended: 'true',

diff --git a/src/rules/requireParam.js b/src/rules/requireParam.js
@@ -246,6 +246,9 @@ export default iterateJsdoc(({
 }, {
   contextDefaults: true,
   meta: {
+    docs: {
+      description: 'Requires that all function parameters are documented.',
+    },
     fixable: 'code',
     schema: [
       {

diff --git a/src/rules/requireParamDescription.js b/src/rules/requireParamDescription.js
@@ -16,6 +16,9 @@ export default iterateJsdoc(({
 }, {
   contextDefaults: true,
   meta: {
+    docs: {
+      description: 'Requires that each `@param` tag has a `description` value.',
+    },
     schema: [
       {
         additionalProperties: false,

diff --git a/src/rules/requireParamName.js b/src/rules/requireParamName.js
@@ -16,6 +16,9 @@ export default iterateJsdoc(({
 }, {
   contextDefaults: true,
   meta: {
+    docs: {
+      description: 'Requires that all function parameters have names.',
+    },
     schema: [
       {
         additionalProperties: false,

diff --git a/src/rules/requireParamType.js b/src/rules/requireParamType.js
@@ -16,6 +16,9 @@ export default iterateJsdoc(({
 }, {
   contextDefaults: true,
   meta: {
+    docs: {
+      description: 'Requires that each `@param` tag has a `type` value.',
+    },
     schema: [
       {
         additionalProperties: false,

diff --git a/src/rules/requireProperty.js b/src/rules/requireProperty.js
@@ -35,6 +35,9 @@ export default iterateJsdoc(({
 }, {
   iterateAllJsdocs: true,
   meta: {
+    docs: {
+      description: 'Requires that all `@typedef` and `@namespace` tags have `@property` when their type is a plain `object`, `Object`, or `PlainObject`.',
+    },
     fixable: 'code',
     type: 'suggestion',
   },

diff --git a/src/rules/requirePropertyDescription.js b/src/rules/requirePropertyDescription.js
@@ -16,6 +16,9 @@ export default iterateJsdoc(({
 }, {
   iterateAllJsdocs: true,
   meta: {
+    docs: {
+      description: 'Requires that each `@property` tag has a `description` value.',
+    },
     type: 'suggestion',
   },
 });
diff --git a/src/rules/requirePropertyName.js b/src/rules/requirePropertyName.js
@@ -16,6 +16,9 @@ export default iterateJsdoc(({
 }, {
   iterateAllJsdocs: true,
   meta: {
+    docs: {
+      description: 'Requires that all function `@property` tags have names.',
+    },
     type: 'suggestion',
   },
 });
diff --git a/src/rules/requirePropertyType.js b/src/rules/requirePropertyType.js
@@ -16,6 +16,9 @@ export default iterateJsdoc(({
 }, {
   iterateAllJsdocs: true,
   meta: {
+    docs: {
+      description: 'Requires that each `@property` tag has a `type` value.',
+    },
     type: 'suggestion',
   },
 });
diff --git a/src/rules/requireReturns.js b/src/rules/requireReturns.js
@@ -94,6 +94,9 @@ export default iterateJsdoc(({
 }, {
   contextDefaults: true,
   meta: {
+    docs: {
+      description: 'Requires returns are documented.',
+    },
     schema: [
       {
         additionalProperties: false,

diff --git a/src/rules/requireReturnsCheck.js b/src/rules/requireReturnsCheck.js
@@ -63,6 +63,9 @@ export default iterateJsdoc(({
   }
 }, {
   meta: {
+    docs: {
+      description: 'Requires a return statement in function body if a `@returns` tag is specified in jsdoc comment.',
+    },
     type: 'suggestion',
   },
 });
diff --git a/src/rules/requireReturnsDescription.js b/src/rules/requireReturnsDescription.js
@@ -18,6 +18,9 @@ export default iterateJsdoc(({
 }, {
   contextDefaults: true,
   meta: {
+    docs: {
+      description: 'Requires that the `@returns` tag has a `description` value.',
+    },
     schema: [
       {
         additionalProperties: false,

diff --git a/src/rules/requireReturnsType.js b/src/rules/requireReturnsType.js
@@ -12,6 +12,9 @@ export default iterateJsdoc(({
 }, {
   contextDefaults: true,
   meta: {
+    docs: {
+      description: 'Requires that `@returns` tag has `type` value.',
+    },
     schema: [
       {
         additionalProperties: false,

diff --git a/src/rules/validTypes.js b/src/rules/validTypes.js
@@ -116,6 +116,9 @@ export default iterateJsdoc(({
 }, {
   iterateAllJsdocs: true,
   meta: {
+    docs: {
+      description: 'Requires all types to be valid JSDoc or Closure compiler types without syntax errors.',
+    },
     schema: [
       {
         additionalProperies: false,