- Allow tentative API for options in iterateJsdoc to support returning objects defining scopes beyond just the default functions; utilize in requireJsdoc

Author: brettz9

Diff for: src/iterateJsdoc.js

@@ -22,7 +22,7 @@ const parseComment = (commentNode, indent) => {
 };
 
 const curryUtils = (
-  functionNode,
+  node,
   jsdoc,
   tagNamePreference,
   exampleCodeRegex,
@@ -47,15 +47,15 @@ const curryUtils = (
   const utils = {};
 
   utils.getFunctionParameterNames = () => {
-    return jsdocUtils.getFunctionParameterNames(functionNode);
+    return jsdocUtils.getFunctionParameterNames(node);
   };
 
   utils.getFunctionSourceCode = () => {
-    return sourceCode.getText(functionNode);
+    return sourceCode.getText(node);
   };
 
   utils.isConstructor = () => {
-    return functionNode.parent && functionNode.parent.kind === 'constructor';
+    return node.parent && node.parent.kind === 'constructor';
   };
 
   utils.getJsdocParameterNamesDeep = () => {
@@ -178,8 +178,19 @@ export {
   parseComment
 };
 
-export default (iterator, meta) => {
+export default (iterator, options) => {
+  const opts = options || {};
+
   return {
+    /**
+     * The entrypoint for the JSDoc rule.
+     *
+     * @param {*} context
+     *   a reference to the context which hold all important information
+     *   like settings and the sourcecode to check.
+     * @returns {Object}
+     *   a list with parser callback function.
+     */
     create (context) {
       const sourceCode = context.getSourceCode();
       const tagNamePreference = _.get(context, 'settings.jsdoc.tagNamePreference') || {};
@@ -200,8 +211,8 @@ export default (iterator, meta) => {
       const allowAugmentsExtendsWithoutParam = Boolean(_.get(context, 'settings.jsdoc.allowAugmentsExtendsWithoutParam'));
       const checkSeesForNamepaths = Boolean(_.get(context, 'settings.jsdoc.checkSeesForNamepaths'));
 
-      const checkJsdoc = (functionNode) => {
-        const jsdocNode = sourceCode.getJSDocComment(functionNode);
+      const checkJsdoc = (node) => {
+        const jsdocNode = sourceCode.getJSDocComment(node);
 
         if (!jsdocNode) {
           return;
@@ -247,7 +258,7 @@ export default (iterator, meta) => {
         };
 
         const utils = curryUtils(
-          functionNode,
+          node,
           jsdoc,
           tagNamePreference,
           exampleCodeRegex,
@@ -272,22 +283,26 @@ export default (iterator, meta) => {
 
         iterator({
           context,
-          functionNode,
           indent,
           jsdoc,
           jsdocNode,
+          node,
           report,
           sourceCode,
           utils
         });
       };
 
+      if (opts.returns) {
+        return opts.returns(context, sourceCode, checkJsdoc);
+      }
+
       return {
         ArrowFunctionExpression: checkJsdoc,
         FunctionDeclaration: checkJsdoc,
         FunctionExpression: checkJsdoc
       };
     },
-    meta
+    meta: opts.meta
   };
 };

Diff for: src/rules/requireJsdoc.js

@@ -1,3 +1,5 @@
+import iterateJsdoc from '../iterateJsdoc';
+
 const OPTIONS_SCHEMA = {
   additionalProperties: false,
   properties: {
@@ -58,30 +60,39 @@ const getOptions = (context) => {
   };
 };
 
-const checkJsDoc = (context, node) => {
-  const jsDocNode = context.getSourceCode().getJSDocComment(node);
+export default iterateJsdoc(null, {
+  meta: {
+    doc: {
+      category: 'Stylistic Issues',
+      description: 'Require JSDoc comments',
+      recommended: 'true',
+      url: 'https://github.com/gajus/eslint-plugin-jsdoc'
+    },
 
-  if (jsDocNode) {
-    return;
-  }
+    messages: {
+      missingJsDoc: 'Missing JSDoc comment.'
+    },
 
-  context.report({
-    messageId: 'missingJsDoc',
-    node
-  });
-};
+    schema: [
+      OPTIONS_SCHEMA
+    ],
+
+    type: 'suggestion'
+  },
+  returns (context, sourceCode) {
+    const checkJsDoc = (node) => {
+      const jsDocNode = sourceCode.getJSDocComment(node);
+
+      if (jsDocNode) {
+        return;
+      }
+
+      context.report({
+        messageId: 'missingJsDoc',
+        node
+      });
+    };
 
-export default {
-  /**
-   * The entrypoint for the JSDoc rule.
-   *
-   * @param {*} context
-   *   a reference to the context which hold all important information
-   *   like settings and the sourcecode to check.
-   * @returns {*}
-   *   a list with parser callback function.
-   */
-  create (context) {
     const options = getOptions(context);
 
     return {
@@ -94,28 +105,28 @@ export default {
           return;
         }
 
-        checkJsDoc(context, node);
+        checkJsDoc(node);
       },
 
       ClassDeclaration: (node) => {
         if (!options.ClassDeclaration) {
           return;
         }
 
-        checkJsDoc(context, node);
+        checkJsDoc(node);
       },
 
       FunctionDeclaration: (node) => {
         if (!options.FunctionDeclaration) {
           return;
         }
 
-        checkJsDoc(context, node);
+        checkJsDoc(node);
       },
 
       FunctionExpression: (node) => {
         if (options.MethodDefinition && node.parent.type === 'MethodDefinition') {
-          checkJsDoc(context, node);
+          checkJsDoc(node);
 
           return;
         }
@@ -125,32 +136,13 @@ export default {
         }
 
         if (node.parent.type === 'VariableDeclarator') {
-          checkJsDoc(context, node);
+          checkJsDoc(node);
         }
 
         if (node.parent.type === 'Property' && node === node.parent.value) {
-          checkJsDoc(context, node);
+          checkJsDoc(node);
         }
       }
     };
-  },
-
-  meta: {
-    doc: {
-      category: 'Stylistic Issues',
-      description: 'Require JSDoc comments',
-      recommended: 'true',
-      url: 'https://github.com/gajus/eslint-plugin-jsdoc'
-    },
-
-    messages: {
-      missingJsDoc: 'Missing JSDoc comment.'
-    },
-
-    schema: [
-      OPTIONS_SCHEMA
-    ],
-
-    type: 'suggestion'
   }
-};
+});

Diff for: src/rules/requireReturnsCheck.js

@@ -3,16 +3,16 @@ import iterateJsdoc from '../iterateJsdoc';
 export default iterateJsdoc(({
   jsdoc,
   report,
-  functionNode,
+  node,
   utils
 }) => {
   // Implicit return like `() => foo` is ok
-  if (functionNode.type === 'ArrowFunctionExpression' && functionNode.expression) {
+  if (node.type === 'ArrowFunctionExpression' && node.expression) {
     return;
   }
 
   // Async function always returns a promise
-  if (functionNode.async) {
+  if (node.async) {
     return;
   }