refactor: extract out retrieval for tagsWithNames and tagsWithoutNames through getTagsByType; also add jsdocUtils.filterTags

Author: brettz9

README.md

@@ -3752,6 +3752,12 @@ function quux (foo) {
 
 }
 // Message: Sentence should start with an uppercase character.
+
+/**
+ * @typedef {Object} Hello World
+ * hello world
+*/
+// Message: Sentence must end with a period.
 ````
 
 The following patterns are not considered problems:

src/iterateJsdoc.js

@@ -161,7 +161,11 @@ const getUtils = (
   };
 
   utils.filterTags = (filter) => {
-    return (jsdoc.tags || []).filter(filter);
+    return jsdocUtils.filterTags(jsdoc.tags, filter);
+  };
+
+  utils.getTagsByType = (tags) => {
+    return jsdocUtils.getTagsByType(tags, tagNamePreference);
   };
 
   utils.getClassNode = () => {

src/jsdocUtils.js

@@ -520,13 +520,40 @@ const getContextObject = (contexts, checkJsdoc) => {
   }, {});
 };
 
+const filterTags = (tags = [], filter) => {
+  return tags.filter(filter);
+};
+
+const tagsWithNamesAndDescriptions = ['param', 'arg', 'argument', 'returns', 'return'];
+
+const getTagsByType = (tags, tagPreference) => {
+  const descName = getPreferredTagName('description', tagPreference);
+  const tagsWithoutNames = [];
+  const tagsWithNames = filterTags(tags, (tag) => {
+    const {tag: tagName} = tag;
+    const tagWithName = tagsWithNamesAndDescriptions.includes(tagName);
+    if (!tagWithName && tagName !== descName) {
+      tagsWithoutNames.push(tag);
+    }
+
+    return tagWithName;
+  });
+
+  return {
+    tagsWithoutNames,
+    tagsWithNames
+  };
+};
+
 export default {
   enforcedContexts,
+  filterTags,
   getContextObject,
   getFunctionParameterNames,
   getJsdocParameterNames,
   getJsdocParameterNamesDeep,
   getPreferredTagName,
+  getTagsByType,
   hasATag,
   hasDefinedTypeReturnTag,
   hasReturnValue,

src/rules/matchDescription.js

@@ -1,8 +1,6 @@
 import _ from 'lodash';
 import iterateJsdoc from '../iterateJsdoc';
 
-const tagsWithNamesAndDescriptions = ['param', 'arg', 'argument'];
-
 // If supporting Node >= 10, we could loosen the default to this for the
 //   initial letter: \\p{Upper}
 const matchDescriptionDefault = '^[A-Z`\\d_][\\s\\S]*[.?!`]$';
@@ -57,28 +55,17 @@ 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 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;
+  const whitelistedTags = utils.filterTags(({tag: tagName}) => {
+    return hasOptionTag(tagName);
   });
+  const {tagsWithNames, tagsWithoutNames} = utils.getTagsByType(whitelistedTags);
 
   tagsWithNames.some((tag) => {
     const description = _.trimStart(tag.description, '- ');