refactor(require-description): move context defaulting to utility

refactor: rename `opts` -> `ruleConfig` to better distinguish from user options

Author: brettz9

src/iterateJsdoc.js

@@ -277,14 +277,14 @@ export {
  * @typedef {ReturnType<typeof getSettings>} Settings
  *
  * @param {(arg: {utils: Utils, settings: Settings}) => any} iterator
- * @param {{meta: any, returns?: any}} opts
+ * @param {{contextDefaults: (true|string[]), meta: any, returns?: any}} ruleConfig
  */
-export default function iterateJsdoc (iterator, opts) {
-  const metaType = _.get(opts, 'meta.type');
+export default function iterateJsdoc (iterator, ruleConfig) {
+  const metaType = _.get(ruleConfig, 'meta.type');
   if (!metaType || !['problem', 'suggestion', 'layout'].includes(metaType)) {
     throw new TypeError('Rule must include `meta.type` option (with value "problem", "suggestion", or "layout")');
   }
-  if (typeof iterator !== 'function' && (!opts || typeof opts.returns !== 'function')) {
+  if (typeof iterator !== 'function' && (!ruleConfig || typeof ruleConfig.returns !== 'function')) {
     throw new TypeError('The iterator argument must be a function or an object with a `returns` method.');
   }
 
@@ -303,9 +303,11 @@ export default function iterateJsdoc (iterator, opts) {
 
       const settings = getSettings(context);
 
-      let contexts = opts.returns;
-      if (typeof opts.returns === 'function') {
-        contexts = opts.returns(context, sourceCode);
+      let contexts = ruleConfig.returns;
+      if (typeof ruleConfig.returns === 'function') {
+        contexts = ruleConfig.returns(context, sourceCode);
+      } else if (ruleConfig.contextDefaults) {
+        contexts = jsdocUtils.enforcedContexts(context, ruleConfig.contextDefaults);
       }
 
       if (!Array.isArray(contexts) && contexts) {
@@ -393,6 +395,6 @@ export default function iterateJsdoc (iterator, opts) {
         return obj;
       }, {});
     },
-    meta: opts.meta
+    meta: ruleConfig.meta
   };
 }

src/jsdocUtils.js

@@ -483,7 +483,36 @@ const parseClosureTemplateTag = (tag) => {
     });
 };
 
+/**
+ * Checks user option for `contexts` array, defaulting to
+ *   contexts designated by the rule. Returns an array of
+ *   ESTree AST types, indicating allowable contexts.
+ *
+ * @param {*} context
+ * @param {true|string[]} defaultContexts
+ * @returns {string[]}
+ */
+const enforcedContexts = (context, defaultContexts) => {
+  /* istanbul ignore next */
+  const defltContexts = defaultContexts === true ? [
+    'ArrowFunctionExpression',
+    'FunctionDeclaration',
+    'FunctionExpression'
+  ] : defaultContexts;
+  const {
+    noDefaults,
+    contexts: ctxts = []
+  } = context.options[0] || {};
+
+  const contexts = typeof ctxts === 'string' ? [ctxts] : ctxts;
+
+  return noDefaults ?
+    contexts :
+    [...new Set([...defltContexts, ...contexts])];
+};
+
 export default {
+  enforcedContexts,
   getFunctionParameterNames,
   getJsdocParameterNames,
   getJsdocParameterNamesDeep,

src/rules/requireDescription.js

@@ -30,6 +30,7 @@ export default iterateJsdoc(({
     }
   });
 }, {
+  contextDefaults: true,
   meta: {
     schema: [
       {
@@ -62,24 +63,5 @@ export default iterateJsdoc(({
       }
     ],
     type: 'suggestion'
-  },
-  returns (context) {
-    const defaultContexts = [
-      'ArrowFunctionExpression',
-      'FunctionDeclaration',
-      'FunctionExpression'
-    ];
-
-    const {
-      noDefaults,
-      contexts: ctxts = []
-    } = context.options[0] || {};
-
-    const contexts = typeof ctxts === 'string' ? [ctxts] : ctxts;
-
-    return noDefaults ?
-      contexts :
-      [...new Set([...defaultContexts, ...contexts])];
   }
-
 });