- Refactoring: Avoid arrow functions as methods (in requireJsdoc); use forEachTag utility

Author: brettz9

src/iterateJsdoc.js

@@ -205,6 +205,16 @@ const curryUtils = (
     return false;
   };
 
+  utils.forEachTag = (tagName, arrayHandler) => {
+    const matchingJsdocTags = _.filter(jsdoc.tags, {
+      tag: tagName
+    });
+
+    matchingJsdocTags.forEach((matchingJsdocTag) => {
+      arrayHandler(matchingJsdocTag);
+    });
+  };
+
   return utils;
 };
 

src/rules/checkExamples.js

@@ -1,4 +1,3 @@
-import _ from 'lodash';
 import {CLIEngine, Linter} from 'eslint';
 import iterateJsdoc from '../iterateJsdoc';
 
@@ -15,7 +14,6 @@ const countChars = (str, ch) => {
 };
 
 export default iterateJsdoc(({
-  jsdoc,
   report,
   utils
 }) => {
@@ -62,11 +60,7 @@ export default iterateJsdoc(({
   exampleCodeRegex = exampleCodeRegex && new RegExp(exampleCodeRegex, '');
   rejectExampleCodeRegex = rejectExampleCodeRegex && new RegExp(rejectExampleCodeRegex, '');
 
-  _.forEach(jsdoc.tags, (tag) => {
-    if (tag.tag !== 'example') {
-      return;
-    }
-
+  utils.forEachTag('example', (tag) => {
     // If a space is present, we should ignore it
     const initialTag = tag.source.match(/^@example ?/);
     const initialTagLength = initialTag[0].length;

src/rules/requireHyphenBeforeParamDescription.js

@@ -3,24 +3,20 @@ import iterateJsdoc from '../iterateJsdoc';
 
 export default iterateJsdoc(({
   sourceCode,
-  jsdoc,
+  utils,
   report,
   context,
   jsdocNode
 }) => {
   let always;
 
-  const jsdocTags = _.filter(jsdoc.tags, {
-    tag: 'param'
-  });
-
   if (_.has(context.options, 0)) {
     always = context.options[0] === 'always';
   } else {
     always = true;
   }
 
-  _.forEach(jsdocTags, (jsdocTag) => {
+  utils.forEachTag('param', (jsdocTag) => {
     if (!jsdocTag.description) {
       return;
     }

src/rules/requireJsdoc.js

@@ -108,7 +108,7 @@ export default iterateJsdoc(null, {
     const options = getOptions(context);
 
     return {
-      ArrowFunctionExpression: (node) => {
+      ArrowFunctionExpression (node) {
         if (!options.ArrowFunctionExpression) {
           return;
         }
@@ -120,23 +120,23 @@ export default iterateJsdoc(null, {
         checkJsDoc(node);
       },
 
-      ClassDeclaration: (node) => {
+      ClassDeclaration (node) {
         if (!options.ClassDeclaration) {
           return;
         }
 
         checkJsDoc(node);
       },
 
-      FunctionDeclaration: (node) => {
+      FunctionDeclaration (node) {
         if (!options.FunctionDeclaration) {
           return;
         }
 
         checkJsDoc(node);
       },
 
-      FunctionExpression: (node) => {
+      FunctionExpression (node) {
         if (options.MethodDefinition && node.parent.type === 'MethodDefinition') {
           checkJsDoc(node);
 

src/rules/requireParamDescription.js

@@ -1,18 +1,12 @@
-import _ from 'lodash';
 import iterateJsdoc from '../iterateJsdoc';
 
 export default iterateJsdoc(({
-  jsdoc,
   report,
   utils
 }) => {
   const targetTagName = utils.getPreferredTagName('param');
 
-  const jsdocParameters = _.filter(jsdoc.tags, {
-    tag: targetTagName
-  });
-
-  _.forEach(jsdocParameters, (jsdocParameter) => {
+  utils.forEachTag(targetTagName, (jsdocParameter) => {
     if (!jsdocParameter.description) {
       report('Missing JSDoc @' + targetTagName + ' "' + jsdocParameter.name + '" description.', null, jsdocParameter);
     }

src/rules/requireParamName.js

@@ -1,18 +1,12 @@
-import _ from 'lodash';
 import iterateJsdoc from '../iterateJsdoc';
 
 export default iterateJsdoc(({
-  jsdoc,
   report,
   utils
 }) => {
   const targetTagName = utils.getPreferredTagName('param');
 
-  const jsdocParameters = _.filter(jsdoc.tags, {
-    tag: targetTagName
-  });
-
-  _.forEach(jsdocParameters, (jsdocParameter) => {
+  utils.forEachTag(targetTagName, (jsdocParameter) => {
     if (jsdocParameter.tag && jsdocParameter.name === '') {
       report('There must be an identifier after @param ' + (jsdocParameter.type === '' ? 'type' : 'tag') + '.', null, jsdocParameter);
     }

src/rules/requireParamType.js

@@ -1,18 +1,12 @@
-import _ from 'lodash';
 import iterateJsdoc from '../iterateJsdoc';
 
 export default iterateJsdoc(({
-  jsdoc,
   report,
   utils
 }) => {
   const targetTagName = utils.getPreferredTagName('param');
 
-  const jsdocParameters = _.filter(jsdoc.tags, {
-    tag: targetTagName
-  });
-
-  _.forEach(jsdocParameters, (jsdocParameter) => {
+  utils.forEachTag(targetTagName, (jsdocParameter) => {
     if (!jsdocParameter.type) {
       report('Missing JSDoc @' + targetTagName + ' "' + jsdocParameter.name + '" type.', null, jsdocParameter);
     }

src/rules/requireReturnsDescription.js

@@ -1,18 +1,12 @@
-import _ from 'lodash';
 import iterateJsdoc from '../iterateJsdoc';
 
 export default iterateJsdoc(({
-  jsdoc,
   report,
   utils
 }) => {
   const targetTagName = utils.getPreferredTagName('returns');
 
-  const jsdocTags = _.filter(jsdoc.tags, {
-    tag: targetTagName
-  });
-
-  _.forEach(jsdocTags, (jsdocTag) => {
+  utils.forEachTag(targetTagName, (jsdocTag) => {
     const type = jsdocTag.type && jsdocTag.type.trim();
 
     if (type === 'void' || type === 'undefined') {

src/rules/requireReturnsType.js

@@ -1,18 +1,12 @@
-import _ from 'lodash';
 import iterateJsdoc from '../iterateJsdoc';
 
 export default iterateJsdoc(({
-  jsdoc,
   report,
   utils
 }) => {
   const targetTagName = utils.getPreferredTagName('returns');
 
-  const jsdocTags = _.filter(jsdoc.tags, {
-    tag: targetTagName
-  });
-
-  _.forEach(jsdocTags, (jsdocTag) => {
+  utils.forEachTag(targetTagName, (jsdocTag) => {
     if (!jsdocTag.type) {
       report('Missing JSDoc @' + targetTagName + ' type.', null, jsdocTag);
     }