feat(match-description): allow arbitrary tags; also fixes returns/return to avoid skipping matching of an initial "name" and space

Author: brettz9

.README/rules/match-description.md

@@ -50,6 +50,11 @@ tag should be linted with the `matchDescription` value (or the default).
 }
 ```
 
+The tags `@param`/`@arg`/`@argument` will be properly parsed to ensure that
+the "description" subject to matching refers to only the text after the name.
+All other tags will treat all text after the tag and space as being part of
+its "description".
+
 ##### `mainDescription`
 
 If you wish to override the main function description without changing the
@@ -82,6 +87,6 @@ Overrides the default contexts (see below).
 |Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`; others when `contexts` option enabled|
 |Tags|N/A by default but see `tags` options|
 |Settings||
-|Options|`contexts`, `tags` (allows for 'param', 'arg', 'argument', 'returns', 'return', 'description', 'desc'), `mainDescription`, `matchDescription`|
+|Options|`contexts`, `tags` (allows for 'param', 'arg', 'argument', 'description', 'desc', and any added to `tags` option, e.g., 'returns', 'return'), `mainDescription`, `matchDescription`|
 
 <!-- assertions matchDescription -->

README.md

@@ -2428,6 +2428,11 @@ tag should be linted with the `matchDescription` value (or the default).
 }
 ```
 
+The tags `@param`/`@arg`/`@argument` will be properly parsed to ensure that
+the "description" subject to matching refers to only the text after the name.
+All other tags will treat all text after the tag and space as being part of
+its "description".
+
 <a name="eslint-plugin-jsdoc-rules-match-description-options-3-maindescription"></a>
 ##### <code>mainDescription</code>
 
@@ -2462,7 +2467,7 @@ Overrides the default contexts (see below).
 |Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`; others when `contexts` option enabled|
 |Tags|N/A by default but see `tags` options|
 |Settings||
-|Options|`contexts`, `tags` (allows for 'param', 'arg', 'argument', 'returns', 'return', 'description', 'desc'), `mainDescription`, `matchDescription`|
+|Options|`contexts`, `tags` (allows for 'param', 'arg', 'argument', 'description', 'desc', and any added to `tags` option, e.g., 'returns', 'return'), `mainDescription`, `matchDescription`|
 
 The following patterns are considered problems:
 
@@ -2538,6 +2543,39 @@ function quux (foo) {
 // Options: [{"tags":{"param":true}}]
 // Message: JSDoc description does not satisfy the regex pattern.
 
+/**
+ * Foo.
+ *
+ * @summary foo.
+ */
+function quux () {
+
+}
+// Options: [{"tags":{"summary":true}}]
+// Message: JSDoc description does not satisfy the regex pattern.
+
+/**
+ * Foo.
+ *
+ * @author
+ */
+function quux () {
+
+}
+// Options: [{"tags":{"author":".+"}}]
+// Message: JSDoc description does not satisfy the regex pattern.
+
+/**
+ * Foo.
+ *
+ * @x-tag
+ */
+function quux () {
+
+}
+// Options: [{"tags":{"x-tag":".+"}}]
+// Message: JSDoc description does not satisfy the regex pattern.
+
 /**
  * Foo.
  *
@@ -2797,6 +2835,14 @@ function quux () {
 }
 // Options: [{"tags":{"returns":true}}]
 
+/**
+ * @returns {type1} Foo bar.
+ */
+function quux () {
+
+}
+// Options: [{"tags":{"returns":true}}]
+
 /**
  * @description Foo bar.
  */
@@ -2934,6 +2980,36 @@ function quux () {
 
 }
 // Options: [{"tags":{"param":true}}]
+
+/**
+ * Foo.
+ *
+ * @summary Foo.
+ */
+function quux () {
+
+}
+// Options: [{"tags":{"summary":true}}]
+
+/**
+ * Foo.
+ *
+ * @author Somebody
+ */
+function quux () {
+
+}
+// Options: [{"tags":{"author":".+"}}]
+
+/**
+ * Foo.
+ *
+ * @x-tag something
+ */
+function quux () {
+
+}
+// Options: [{"tags":{"x-tag":".+"}}]
 ````
 
 

src/rules/matchDescription.js

@@ -1,7 +1,7 @@
 import _ from 'lodash';
 import iterateJsdoc from '../iterateJsdoc';
 
-const tagsWithDescriptions = ['param', 'arg', 'argument', 'returns', 'return'];
+const tagsWithNamesAndDescriptions = ['param', 'arg', 'argument'];
 
 // If supporting Node >= 10, we could loosen the default to this for the
 //   initial letter: \\p{Upper}
@@ -57,22 +57,40 @@ export default iterateJsdoc(({
     return Boolean(options.tags[tagName]);
   };
 
+  let descName;
   utils.forEachPreferredTag('description', (matchingJsdocTag, targetTagName) => {
+    descName = targetTagName;
     const description = (matchingJsdocTag.name + ' ' + matchingJsdocTag.description).trim();
     if (hasOptionTag(targetTagName)) {
       validateDescription(description, matchingJsdocTag);
     }
   });
 
-  const tags = utils.filterTags(({tag}) => {
-    return tagsWithDescriptions.includes(tag) && hasOptionTag(tag);
+  const tagsWithoutNames = [];
+  const tagsWithNames = utils.filterTags((tag) => {
+    const {tag: tagName} = tag;
+    if (!hasOptionTag(tagName)) {
+      return false;
+    }
+    const tagWithName = tagsWithNamesAndDescriptions.includes(tagName);
+    if (!tagWithName && tagName !== descName) {
+      tagsWithoutNames.push(tag);
+    }
+
+    return tagWithName;
   });
 
-  tags.some((tag) => {
+  tagsWithNames.some((tag) => {
     const description = _.trimStart(tag.description, '- ');
 
     return validateDescription(description, tag);
   });
+
+  tagsWithoutNames.some((tag) => {
+    const description = (tag.name + ' ' + tag.description).trim();
+
+    return validateDescription(description, tag);
+  });
 }, {
   contextDefaults: true,
   meta: {

test/rules/assertions/matchDescription.js

@@ -160,6 +160,81 @@ export default {
         }
       ]
     },
+    {
+      code: `
+          /**
+           * Foo.
+           *
+           * @summary foo.
+           */
+          function quux () {
+
+          }
+      `,
+      errors: [
+        {
+          line: 5,
+          message: 'JSDoc description does not satisfy the regex pattern.'
+        }
+      ],
+      options: [
+        {
+          tags: {
+            summary: true
+          }
+        }
+      ]
+    },
+    {
+      code: `
+          /**
+           * Foo.
+           *
+           * @author
+           */
+          function quux () {
+
+          }
+      `,
+      errors: [
+        {
+          line: 5,
+          message: 'JSDoc description does not satisfy the regex pattern.'
+        }
+      ],
+      options: [
+        {
+          tags: {
+            author: '.+'
+          }
+        }
+      ]
+    },
+    {
+      code: `
+          /**
+           * Foo.
+           *
+           * @x-tag
+           */
+          function quux () {
+
+          }
+      `,
+      errors: [
+        {
+          line: 5,
+          message: 'JSDoc description does not satisfy the regex pattern.'
+        }
+      ],
+      options: [
+        {
+          tags: {
+            'x-tag': '.+'
+          }
+        }
+      ]
+    },
     {
       code: `
           /**
@@ -706,6 +781,23 @@ export default {
         }
       ]
     },
+    {
+      code: `
+          /**
+           * @returns {type1} Foo bar.
+           */
+          function quux () {
+
+          }
+      `,
+      options: [
+        {
+          tags: {
+            returns: true
+          }
+        }
+      ]
+    },
     {
       code: `
           /**
@@ -937,6 +1029,63 @@ export default {
           param: true
         }}
       ]
+    },
+    {
+      code: `
+          /**
+           * Foo.
+           *
+           * @summary Foo.
+           */
+          function quux () {
+
+          }
+      `,
+      options: [
+        {
+          tags: {
+            summary: true
+          }
+        }
+      ]
+    },
+    {
+      code: `
+          /**
+           * Foo.
+           *
+           * @author Somebody
+           */
+          function quux () {
+
+          }
+      `,
+      options: [
+        {
+          tags: {
+            author: '.+'
+          }
+        }
+      ]
+    },
+    {
+      code: `
+          /**
+           * Foo.
+           *
+           * @x-tag something
+           */
+          function quux () {
+
+          }
+      `,
+      options: [
+        {
+          tags: {
+            'x-tag': '.+'
+          }
+        }
+      ]
     }
   ]
 };