Merge commit 'f44b25ed4cb521116a682a0d8d10406f3440cec7' into add-more-type-checks-to-valid-types

* commit 'f44b25ed4cb521116a682a0d8d10406f3440cec7':
  refactor: simplify iterateJsdoc

Author: brettz9

src/iterateJsdoc.js

@@ -406,7 +406,7 @@ export {
  * @param {{
  *   meta: any,
  *   contextDefaults?: true | string[],
- *   returns?: any,
+ *   returns?: string[],
  *   iterateAllJsdocs?: true,
  * }} ruleConfig
  */
@@ -439,15 +439,10 @@ export default function iterateJsdoc (iterator, ruleConfig) {
       const settings = getSettings(context);
 
       let contexts = ruleConfig.returns;
-      if (typeof ruleConfig.returns === 'function') {
-        contexts = ruleConfig.returns(context, sourceCode);
-      } else if (ruleConfig.contextDefaults) {
+      if (ruleConfig.contextDefaults) {
         contexts = jsdocUtils.enforcedContexts(context, ruleConfig.contextDefaults);
       }
 
-      if (!Array.isArray(contexts) && contexts) {
-        return contexts;
-      }
       const checkJsdoc = (node) => {
         const jsdocNode = getJSDocComment(sourceCode, node);
 

src/jsdocUtils.js

@@ -539,6 +539,10 @@ const enforcedContexts = (context, defaultContexts) => {
   return contexts;
 };
 
+/**
+ * @param {string[]} contexts
+ * @param {Function} checkJsdoc
+ */
 const getContextObject = (contexts, checkJsdoc) => {
   return contexts.reduce((obj, prop) => {
     obj[prop] = checkJsdoc;

src/rules/requireJsdoc.js

@@ -1,5 +1,4 @@
 import _ from 'lodash';
-import iterateJsdoc from '../iterateJsdoc';
 import jsdocUtils from '../jsdocUtils';
 import exportParser from '../exportParser';
 import getJSDocComment from '../eslint/getJSDocComment';
@@ -115,7 +114,8 @@ const getOptions = (context) => {
   };
 };
 
-export default iterateJsdoc(null, {
+/* eslint-disable sort-keys */
+export default {
   meta: {
     doc: {
       category: 'Stylistic Issues',
@@ -134,9 +134,11 @@ export default iterateJsdoc(null, {
 
     type: 'suggestion'
   },
-  returns (context, sourceCode) {
+  create (context) {
     warnRemovedSettings(context, 'require-jsdoc');
 
+    const sourceCode = context.getSourceCode();
+
     const {require: requireOption, publicOnly, exemptEmptyFunctions} = getOptions(context);
 
     const checkJsDoc = (node) => {
@@ -237,4 +239,4 @@ export default iterateJsdoc(null, {
       }
     );
   }
-});
+};

test/eslint/getJSDocComment.js

@@ -1,17 +1,19 @@
 import {
   RuleTester
 } from 'eslint';
-import iterateJsdoc from '../../src/iterateJsdoc';
 import getJSDocComment from '../../src/eslint/getJSDocComment';
 
-const rule = iterateJsdoc(null, {
+/* eslint-disable sort-keys */
+const rule = {
   meta: {
     messages: {
       missingJsDoc: 'Missing JSDoc comment.'
     },
     type: 'layout'
   },
-  returns (context, sourceCode) {
+  create (context) {
+    const sourceCode = context.getSourceCode();
+
     return {
       ObjectExpression: (node) => {
         const comment = getJSDocComment(sourceCode, node);
@@ -25,7 +27,7 @@ const rule = iterateJsdoc(null, {
       }
     };
   }
-});
+};
 
 const ruleTester = new RuleTester();