- Change rule format (require-jsdoc already in this format and all other rules use iterateJsdoc.js) per issue #19

Author: brettz9

src/iterateJsdoc.js

@@ -178,113 +178,116 @@ export {
   parseComment
 };
 
-export default (iterator) => {
-  return (context) => {
-    const sourceCode = context.getSourceCode();
-    const tagNamePreference = _.get(context, 'settings.jsdoc.tagNamePreference') || {};
-    const exampleCodeRegex = _.get(context, 'settings.jsdoc.exampleCodeRegex') || null;
-    const rejectExampleCodeRegex = _.get(context, 'settings.jsdoc.rejectExampleCodeRegex') || null;
-    const matchingFileName = _.get(context, 'settings.jsdoc.matchingFileName') || null;
-    const additionalTagNames = _.get(context, 'settings.jsdoc.additionalTagNames') || {};
-    const baseConfig = _.get(context, 'settings.jsdoc.baseConfig') || {};
-    const configFile = _.get(context, 'settings.jsdoc.configFile');
-    const eslintrcForExamples = _.get(context, 'settings.jsdoc.eslintrcForExamples') !== false;
-    const allowInlineConfig = _.get(context, 'settings.jsdoc.allowInlineConfig') !== false;
-    const allowEmptyNamepaths = _.get(context, 'settings.jsdoc.allowEmptyNamepaths') !== false;
-    const reportUnusedDisableDirectives = _.get(context, 'settings.jsdoc.reportUnusedDisableDirectives') !== false;
-    const captionRequired = Boolean(_.get(context, 'settings.jsdoc.captionRequired'));
-    const noDefaultExampleRules = Boolean(_.get(context, 'settings.jsdoc.noDefaultExampleRules'));
-    const allowOverrideWithoutParam = Boolean(_.get(context, 'settings.jsdoc.allowOverrideWithoutParam'));
-    const allowImplementsWithoutParam = Boolean(_.get(context, 'settings.jsdoc.allowImplementsWithoutParam'));
-    const allowAugmentsExtendsWithoutParam = Boolean(_.get(context, 'settings.jsdoc.allowAugmentsExtendsWithoutParam'));
-    const checkSeesForNamepaths = Boolean(_.get(context, 'settings.jsdoc.checkSeesForNamepaths'));
-
-    const checkJsdoc = (functionNode) => {
-      const jsdocNode = sourceCode.getJSDocComment(functionNode);
-
-      if (!jsdocNode) {
-        return;
-      }
+export default (iterator, meta) => {
+  return {
+    create (context) {
+      const sourceCode = context.getSourceCode();
+      const tagNamePreference = _.get(context, 'settings.jsdoc.tagNamePreference') || {};
+      const exampleCodeRegex = _.get(context, 'settings.jsdoc.exampleCodeRegex') || null;
+      const rejectExampleCodeRegex = _.get(context, 'settings.jsdoc.rejectExampleCodeRegex') || null;
+      const matchingFileName = _.get(context, 'settings.jsdoc.matchingFileName') || null;
+      const additionalTagNames = _.get(context, 'settings.jsdoc.additionalTagNames') || {};
+      const baseConfig = _.get(context, 'settings.jsdoc.baseConfig') || {};
+      const configFile = _.get(context, 'settings.jsdoc.configFile');
+      const eslintrcForExamples = _.get(context, 'settings.jsdoc.eslintrcForExamples') !== false;
+      const allowInlineConfig = _.get(context, 'settings.jsdoc.allowInlineConfig') !== false;
+      const allowEmptyNamepaths = _.get(context, 'settings.jsdoc.allowEmptyNamepaths') !== false;
+      const reportUnusedDisableDirectives = _.get(context, 'settings.jsdoc.reportUnusedDisableDirectives') !== false;
+      const captionRequired = Boolean(_.get(context, 'settings.jsdoc.captionRequired'));
+      const noDefaultExampleRules = Boolean(_.get(context, 'settings.jsdoc.noDefaultExampleRules'));
+      const allowOverrideWithoutParam = Boolean(_.get(context, 'settings.jsdoc.allowOverrideWithoutParam'));
+      const allowImplementsWithoutParam = Boolean(_.get(context, 'settings.jsdoc.allowImplementsWithoutParam'));
+      const allowAugmentsExtendsWithoutParam = Boolean(_.get(context, 'settings.jsdoc.allowAugmentsExtendsWithoutParam'));
+      const checkSeesForNamepaths = Boolean(_.get(context, 'settings.jsdoc.checkSeesForNamepaths'));
+
+      const checkJsdoc = (functionNode) => {
+        const jsdocNode = sourceCode.getJSDocComment(functionNode);
+
+        if (!jsdocNode) {
+          return;
+        }
 
-      const ancestors = context.getAncestors();
+        const ancestors = context.getAncestors();
 
-      const indent = _.repeat(' ', jsdocNode.loc.start.column);
+        const indent = _.repeat(' ', jsdocNode.loc.start.column);
 
-      const jsdoc = parseComment(jsdocNode, indent);
+        const jsdoc = parseComment(jsdocNode, indent);
 
-      const report = (message, fixer = null, jsdocLoc = null) => {
-        let loc;
+        const report = (message, fixer = null, jsdocLoc = null) => {
+          let loc;
 
-        if (jsdocLoc) {
-          const lineNumber = jsdocNode.loc.start.line + jsdocLoc.line;
+          if (jsdocLoc) {
+            const lineNumber = jsdocNode.loc.start.line + jsdocLoc.line;
 
-          loc = {
-            end: {line: lineNumber},
-            start: {line: lineNumber}
-          };
-          if (jsdocLoc.column) {
-            const colNumber = jsdocNode.loc.start.column + jsdocLoc.column;
+            loc = {
+              end: {line: lineNumber},
+              start: {line: lineNumber}
+            };
+            if (jsdocLoc.column) {
+              const colNumber = jsdocNode.loc.start.column + jsdocLoc.column;
 
-            loc.end.column = colNumber;
-            loc.start.column = colNumber;
+              loc.end.column = colNumber;
+              loc.start.column = colNumber;
+            }
           }
-        }
-        if (fixer === null) {
-          context.report({
-            loc,
-            message,
-            node: jsdocNode
-          });
-        } else {
-          context.report({
-            fix: fixer,
-            loc,
-            message,
-            node: jsdocNode
-          });
-        }
+          if (fixer === null) {
+            context.report({
+              loc,
+              message,
+              node: jsdocNode
+            });
+          } else {
+            context.report({
+              fix: fixer,
+              loc,
+              message,
+              node: jsdocNode
+            });
+          }
+        };
+
+        const utils = curryUtils(
+          functionNode,
+          jsdoc,
+          tagNamePreference,
+          exampleCodeRegex,
+          rejectExampleCodeRegex,
+          additionalTagNames,
+          baseConfig,
+          configFile,
+          captionRequired,
+          matchingFileName,
+          eslintrcForExamples,
+          allowInlineConfig,
+          allowEmptyNamepaths,
+          reportUnusedDisableDirectives,
+          noDefaultExampleRules,
+          allowOverrideWithoutParam,
+          allowImplementsWithoutParam,
+          allowAugmentsExtendsWithoutParam,
+          checkSeesForNamepaths,
+          ancestors,
+          sourceCode
+        );
+
+        iterator({
+          context,
+          functionNode,
+          indent,
+          jsdoc,
+          jsdocNode,
+          report,
+          sourceCode,
+          utils
+        });
       };
 
-      const utils = curryUtils(
-        functionNode,
-        jsdoc,
-        tagNamePreference,
-        exampleCodeRegex,
-        rejectExampleCodeRegex,
-        additionalTagNames,
-        baseConfig,
-        configFile,
-        captionRequired,
-        matchingFileName,
-        eslintrcForExamples,
-        allowInlineConfig,
-        allowEmptyNamepaths,
-        reportUnusedDisableDirectives,
-        noDefaultExampleRules,
-        allowOverrideWithoutParam,
-        allowImplementsWithoutParam,
-        allowAugmentsExtendsWithoutParam,
-        checkSeesForNamepaths,
-        ancestors,
-        sourceCode
-      );
-
-      iterator({
-        context,
-        functionNode,
-        indent,
-        jsdoc,
-        jsdocNode,
-        report,
-        sourceCode,
-        utils
-      });
-    };
-
-    return {
-      ArrowFunctionExpression: checkJsdoc,
-      FunctionDeclaration: checkJsdoc,
-      FunctionExpression: checkJsdoc
-    };
+      return {
+        ArrowFunctionExpression: checkJsdoc,
+        FunctionDeclaration: checkJsdoc,
+        FunctionExpression: checkJsdoc
+      };
+    },
+    meta
   };
 };