chore: move utils.<someSetting> to settings.<someSetting>

Author: chiawendt

src/iterateJsdoc.js

@@ -27,27 +27,15 @@ const curryUtils = (
   jsdoc,
   {
     tagNamePreference,
-    exampleCodeRegex,
-    rejectExampleCodeRegex,
     additionalTagNames,
-    baseConfig,
-    configFile,
-    captionRequired,
-    matchingFileName,
-    eslintrcForExamples,
-    allowInlineConfig,
     allowEmptyNamepaths,
-    reportUnusedDisableDirectives,
-    noDefaultExampleRules,
     overrideReplacesDocs,
     implementsReplacesDocs,
     augmentsExtendsReplacesDocs,
     allowOverrideWithoutParam,
     allowImplementsWithoutParam,
     allowAugmentsExtendsWithoutParam,
-    checkSeesForNamepaths,
-    forceRequireReturn,
-    avoidExampleOnConstructors
+    checkSeesForNamepaths
   },
   ancestors,
   sourceCode,
@@ -83,18 +71,6 @@ const curryUtils = (
     return jsdocUtils.getPreferredTagName(name, tagNamePreference);
   };
 
-  utils.getExampleCodeRegex = () => {
-    return exampleCodeRegex;
-  };
-
-  utils.getRejectExampleCodeRegex = () => {
-    return rejectExampleCodeRegex;
-  };
-
-  utils.getMatchingFileName = () => {
-    return matchingFileName;
-  };
-
   utils.isValidTag = (name) => {
     return jsdocUtils.isValidTag(name, additionalTagNames);
   };
@@ -107,34 +83,6 @@ const curryUtils = (
     return jsdocUtils.hasTag(jsdoc, name);
   };
 
-  utils.useEslintrcForExamples = () => {
-    return eslintrcForExamples;
-  };
-
-  utils.allowInlineConfig = () => {
-    return allowInlineConfig;
-  };
-
-  utils.reportUnusedDisableDirectives = () => {
-    return reportUnusedDisableDirectives;
-  };
-
-  utils.hasNoDefaultExampleRules = () => {
-    return noDefaultExampleRules;
-  };
-
-  utils.getBaseConfig = () => {
-    return baseConfig;
-  };
-
-  utils.getConfigFile = () => {
-    return configFile;
-  };
-
-  utils.isCaptionRequired = () => {
-    return captionRequired;
-  };
-
   // These settings are deprecated and may be removed in the future along with this method.
   utils.avoidDocsParamOnly = () => {
     // These three checks are all for deprecated settings and may be removed in the future
@@ -188,10 +136,6 @@ const curryUtils = (
     return jsdocUtils.isTagWithType(tagName);
   };
 
-  utils.avoidExampleOnConstructors = () => {
-    return avoidExampleOnConstructors;
-  };
-
   utils.passesEmptyNamepathCheck = (tag) => {
     return !tag.name && allowEmptyNamepaths &&
       jsdocUtils.isPotentiallyEmptyNamepathTag(tag.tag);
@@ -211,10 +155,6 @@ const curryUtils = (
     });
   };
 
-  utils.isForceRequireReturn = () => {
-    return forceRequireReturn;
-  };
-
   utils.filterTags = (filter) => {
     return (jsdoc.tags || []).filter(filter);
   };
@@ -310,7 +250,14 @@ export {
   parseComment
 };
 
-export default (iterator, opts = {}) => {
+/**
+ * @typedef {ReturnType<typeof curryUtils>} Utils
+ * @typedef {ReturnType<typeof getSettings>} Settings
+ *
+ * @param {(arg: {utils: Utils, settings: Settings}) => any} iterator
+ * @param {{returns?: any}} opts
+ */
+export default function iterateJsdoc (iterator, opts = {}) {
   return {
     /**
      * The entrypoint for the JSDoc rule.
@@ -396,6 +343,7 @@ export default (iterator, opts = {}) => {
           jsdocNode,
           node,
           report,
+          settings,
           sourceCode,
           utils
         });
@@ -424,4 +372,4 @@ export default (iterator, opts = {}) => {
     },
     meta: opts.meta
   };
-};
+}

src/rules/checkExamples.js

@@ -15,17 +15,19 @@ const countChars = (str, ch) => {
 
 export default iterateJsdoc(({
   report,
-  utils
+  utils,
+  settings
 }) => {
-  let exampleCodeRegex = utils.getExampleCodeRegex();
-  let rejectExampleCodeRegex = utils.getRejectExampleCodeRegex();
-  const noDefaultExampleRules = utils.hasNoDefaultExampleRules();
-  const eslintrcForExamples = utils.useEslintrcForExamples();
-  const filename = utils.getMatchingFileName();
-  const baseConfig = utils.getBaseConfig();
-  const configFile = utils.getConfigFile();
-  const allowInlineConfig = utils.allowInlineConfig();
-  const reportUnusedDisableDirectives = utils.reportUnusedDisableDirectives();
+  let {exampleCodeRegex, rejectExampleCodeRegex} = settings;
+  const {
+    noDefaultExampleRules,
+    eslintrcForExamples,
+    matchingFileName: filename,
+    baseConfig,
+    configFile,
+    allowInlineConfig,
+    reportUnusedDisableDirectives
+  } = settings;
 
   // Make this configurable?
   const rulePaths = [];
@@ -69,7 +71,7 @@ export default iterateJsdoc(({
     let source = tag.source.slice(initialTagLength);
     const match = source.match(hasCaptionRegex);
 
-    if (utils.isCaptionRequired() && !match) {
+    if (settings.captionRequired && !match) {
       report('Caption is expected for examples.', null, tag);
     }
 

src/rules/requireExample.js

@@ -4,7 +4,8 @@ import iterateJsdoc from '../iterateJsdoc';
 export default iterateJsdoc(({
   jsdoc,
   report,
-  utils
+  utils,
+  settings
 }) => {
   if (utils.avoidDocs()) {
     return;
@@ -16,7 +17,7 @@ export default iterateJsdoc(({
     tag: targetTagName
   });
 
-  if (utils.avoidExampleOnConstructors() && (
+  if (settings.avoidExampleOnConstructors && (
     utils.hasATag([
       'class',
       'constructor'

src/rules/requireReturns.js

@@ -39,7 +39,8 @@ const canSkip = (utils) => {
 
 export default iterateJsdoc(({
   report,
-  utils
+  utils,
+  settings
 }) => {
   // A preflight check. We do not need to run a deep check
   // in case the @returns comment is optional or undefined.
@@ -58,7 +59,7 @@ export default iterateJsdoc(({
   const [tag] = tags;
   const missingReturnTag = typeof tag === 'undefined' || tag === null;
   if (missingReturnTag &&
-    (utils.hasReturnValue() || utils.isForceRequireReturn())
+    (utils.hasReturnValue() || settings.forceRequireReturn)
   ) {
     report('Missing JSDoc @' + tagName + ' declaration.');
   }