refactor: Extract out a new exemptSpeciaMethods into jsdocUtils for…

… potential use outside of iterateJsdoc
gajus · Jul 2, 2020 · b8f7060 · b8f7060
1 parent d7a669b
commit b8f7060
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 28 deletions.
diff --git a/src/iterateJsdoc.js b/src/iterateJsdoc.js
@@ -192,14 +192,6 @@ const getUtils = (
     return jsdocUtils.isConstructor(node);
   };
 
-  utils.isGetter = () => {
-    return jsdocUtils.isGetter(node);
-  };
-
-  utils.isSetter = () => {
-    return jsdocUtils.isSetter(node);
-  };
-
   utils.getJsdocTagsDeep = (tagName) => {
     const name = utils.getPreferredTagName({tagName});
     if (!name) {
@@ -240,14 +232,6 @@ const getUtils = (
     return jsdocUtils.hasTag(jsdoc, name);
   };
 
-  const hasSchemaOption = (prop) => {
-    const schemaProperties = ruleConfig.meta.schema[0].properties;
-
-    return context.options[0]?.[prop] ??
-      (schemaProperties[prop] && schemaProperties[prop].default);
-  };
-
-  // eslint-disable-next-line complexity
   utils.avoidDocs = () => {
     if (
       overrideReplacesDocs !== false &&
@@ -262,18 +246,9 @@ const getUtils = (
       return true;
     }
 
-    if (
-      !hasSchemaOption('checkConstructors') &&
-        (
-          utils.isConstructor() ||
-          utils.hasATag([
-            'class',
-            'constructor',
-          ])) ||
-      !hasSchemaOption('checkGetters') &&
-        utils.isGetter() ||
-      !hasSchemaOption('checkSetters') &&
-        utils.isSetter()) {
+    if (jsdocUtils.exemptSpeciaMethods(
+      jsdoc, node, context, ruleConfig.meta.schema,
+    )) {
       return true;
     }
 

diff --git a/src/jsdocUtils.js b/src/jsdocUtils.js
@@ -777,8 +777,30 @@ const isSetter = (node) => {
   return node && node.parent.kind === 'set';
 };
 
+const exemptSpeciaMethods = (jsdoc, node, context, schema) => {
+  const hasSchemaOption = (prop) => {
+    const schemaProperties = schema[0].properties;
+
+    return context.options[0]?.[prop] ??
+      (schemaProperties[prop] && schemaProperties[prop].default);
+  };
+
+  return !hasSchemaOption('checkConstructors') &&
+    (
+      isConstructor(node) ||
+      hasATag(jsdoc, [
+        'class',
+        'constructor',
+      ])) ||
+  !hasSchemaOption('checkGetters') &&
+    isGetter(node) ||
+  !hasSchemaOption('checkSetters') &&
+    isSetter(node);
+};
+
 export default {
   enforcedContexts,
+  exemptSpeciaMethods,
   filterTags,
   flattenRoots,
   getContextObject,