fix(return-yields, return-yields-check): allow generator detectio…

…n on exported; handle more AST types; fixes gajus#682
brettz9 · Jan 31, 2021 · bdc2ea5 · bdc2ea5
1 parent e694dfd
commit bdc2ea5
Show file tree

Hide file tree

Showing 3 changed files with 434 additions and 3 deletions.
diff --git a/src/iterateJsdoc.js b/src/iterateJsdoc.js
@@ -310,7 +310,9 @@ const getUtils = (
   utils.isGenerator = () => {
     return node && (
       node.generator ||
-      node.type === 'MethodDefinition' && node.value.generator
+      node.type === 'MethodDefinition' && node.value.generator ||
+      ['ExportNamedDeclaration', 'ExportDefaultDeclaration'].includes(node.type) &&
+        node.declaration.generator
     );
   };
 
@@ -462,6 +464,10 @@ const getUtils = (
   };
 
   utils.hasYieldValue = () => {
+    if (['ExportNamedDeclaration', 'ExportDefaultDeclaration'].includes(node.type)) {
+      return jsdocUtils.hasYieldValue(node.declaration);
+    }
+
     return jsdocUtils.hasYieldValue(node);
   };
 
@@ -891,7 +897,6 @@ export default function iterateJsdoc (iterator, ruleConfig) {
           return iterateAllJsdocs(iterator, ruleConfig).create(context);
         }
       }
-
       const sourceCode = context.getSourceCode();
       const settings = getSettings(context);
       if (!settings) {

diff --git a/src/jsdocUtils.js b/src/jsdocUtils.js
@@ -666,7 +666,6 @@ const hasNonEmptyResolverCall = (node, resolverName) => {
   case 'AssignmentPattern':
     return hasNonEmptyResolverCall(node.right, resolverName);
 
-  // Todo: Review all of the types below this for adapting to yields checks
   case 'AssignmentExpression':
   case 'BinaryExpression':
   case 'LogicalExpression': {
@@ -811,6 +810,13 @@ const hasNonFunctionYield = (node, checkYieldReturnValue) => {
       );
     });
   }
+  // istanbul ignore next -- In Babel?
+  case 'OptionalCallExpression':
+  case 'CallExpression':
+    return node.arguments.some((element) => {
+      return hasNonFunctionYield(element, checkYieldReturnValue);
+    });
+  case 'ChainExpression':
   case 'ExpressionStatement': {
     return hasNonFunctionYield(node.expression, checkYieldReturnValue);
   }
@@ -860,6 +866,71 @@ const hasNonFunctionYield = (node, checkYieldReturnValue) => {
     return hasNonFunctionYield(node.id, checkYieldReturnValue) ||
       hasNonFunctionYield(node.init, checkYieldReturnValue);
   }
+
+  case 'AssignmentExpression':
+  case 'BinaryExpression':
+  case 'LogicalExpression': {
+    return hasNonFunctionYield(node.left, checkYieldReturnValue) ||
+      hasNonFunctionYield(node.right, checkYieldReturnValue);
+  }
+
+  // Comma
+  case 'SequenceExpression':
+  case 'TemplateLiteral':
+    return node.expressions.some((subExpression) => {
+      return hasNonFunctionYield(subExpression, checkYieldReturnValue);
+    });
+
+  case 'ObjectPattern':
+  case 'ObjectExpression':
+    return node.properties.some((property) => {
+      return hasNonFunctionYield(property, checkYieldReturnValue);
+    });
+
+  // istanbul ignore next -- In Babel?
+  case 'ObjectProperty':
+  /* eslint-disable no-fallthrough */
+  // istanbul ignore next -- In Babel?
+  case 'ClassProperty':
+  /* eslint-enable no-fallthrough */
+  case 'Property':
+    return node.computed && hasNonFunctionYield(node.key, checkYieldReturnValue) ||
+      hasNonFunctionYield(node.value, checkYieldReturnValue);
+  // istanbul ignore next -- In Babel?
+  case 'ObjectMethod':
+    // istanbul ignore next -- In Babel?
+    return node.computed && hasNonFunctionYield(node.key, checkYieldReturnValue) ||
+      node.arguments.some((nde) => {
+        return hasNonFunctionYield(nde, checkYieldReturnValue);
+      });
+
+  case 'SpreadElement':
+  case 'UnaryExpression':
+    return hasNonFunctionYield(node.argument, checkYieldReturnValue);
+
+  case 'TaggedTemplateExpression':
+    return hasNonFunctionYield(node.quasi, checkYieldReturnValue);
+
+  // ?.
+  // istanbul ignore next -- In Babel?
+  case 'OptionalMemberExpression':
+  case 'MemberExpression':
+    return hasNonFunctionYield(node.object, checkYieldReturnValue) ||
+      hasNonFunctionYield(node.property, checkYieldReturnValue);
+
+  // istanbul ignore next -- In Babel?
+  case 'Import':
+  case 'ImportExpression':
+    return hasNonFunctionYield(node.source, checkYieldReturnValue);
+
+  case 'ReturnStatement': {
+    if (node.argument === null) {
+      return false;
+    }
+
+    return hasNonFunctionYield(node.argument, checkYieldReturnValue);
+  }
+
   case 'YieldExpression': {
     if (checkYieldReturnValue) {
       if (node.parent.type === 'VariableDeclarator') {