require-returns: more AST types

gajus · Jan 31, 2021 · 923a42a · 923a42a
1 parent ba1f510
commit 923a42a
Show file tree

Hide file tree

Showing 2 changed files with 121 additions and 9 deletions.
diff --git a/src/jsdocUtils.js b/src/jsdocUtils.js
@@ -591,6 +591,10 @@ const hasNonEmptyResolverCall = (node, resolverName) => {
 
   // Arrow function without block
   switch (node.type) {
+  case 'ChainExpression':
+    return hasNonEmptyResolverCall(node.expression, resolverName);
+  // istanbul ignore next -- In Babel?
+  case 'OptionalCallExpression':
   case 'CallExpression':
     return node.callee.name === resolverName && (
 
@@ -658,11 +662,11 @@ const hasNonEmptyResolverCall = (node, resolverName) => {
   }
 
   // Comma
-  case 'SequenceExpression': {
+  case 'SequenceExpression':
+  case 'TemplateLiteral':
     return node.expressions.some((subExpression) => {
       return hasNonEmptyResolverCall(subExpression, resolverName);
     });
-  }
 
   case 'ArrayExpression':
     return node.elements.some((element) => {
@@ -693,14 +697,18 @@ const hasNonEmptyResolverCall = (node, resolverName) => {
     return hasNonEmptyResolverCall(node.init, resolverName);
   }
 
-  /*
-  // Todo: As relevant, also check these in return/throw and yield checks
+  case 'TaggedTemplateExpression':
+    return hasNonEmptyResolverCall(node.quasi, resolverName);
 
-  case 'MemberExpression': case 'OptionalMemberExpression': // ?.
-  case 'OptionalCallExpression': ?.x(resolve)
+  // ?.
+  // istanbul ignore next -- In Babel?
+  case 'OptionalMemberExpression':
+  case 'MemberExpression':
+    return hasNonEmptyResolverCall(node.object, resolverName) ||
+      hasNonEmptyResolverCall(node.property, resolverName);
 
-  case 'TaggedTemplateExpression':
-  case 'TemplateElement': case 'TemplateLiteral':
+  /*
+  // Todo: As relevant, also check these in return/throw and yield checks
 
   case 'AssignmentPattern': // Default destructuring value
   case 'ArrayPattern': case 'ObjectPattern':
@@ -714,7 +722,6 @@ const hasNonEmptyResolverCall = (node, resolverName) => {
   case 'ImportExpression':
   case 'Decorator':
 
-    // Todo: Add these (and also add to Yield/Throw checks)
     return false;
   */
   case 'ReturnStatement': {
@@ -724,6 +731,13 @@ const hasNonEmptyResolverCall = (node, resolverName) => {
 
     return hasNonEmptyResolverCall(node.argument, resolverName);
   }
+
+  /*
+  // Shouldn't need to parse literals/literal components
+
+  case 'Identifier':
+  case 'TemplateElement':
+  */
   default:
     return false;
   }

diff --git a/test/rules/assertions/requireReturns.js b/test/rules/assertions/requireReturns.js
@@ -1185,6 +1185,104 @@ export default {
       ],
       ignoreReadme: true,
     },
+    {
+      code: `
+          /**
+           *
+           */
+          function quux () {
+            return new Promise((resolve, reject) => {
+              \`abc$\{resolve(true)}\`;
+            });
+          }
+      `,
+      errors: [
+        {
+          line: 2,
+          message: 'Missing JSDoc @returns declaration.',
+        },
+      ],
+      ignoreReadme: true,
+    },
+    {
+      code: `
+          /**
+           *
+           */
+          function quux () {
+            return new Promise((resolve, reject) => {
+              tagTemp\`abc$\{resolve(true)}\`;
+            });
+          }
+      `,
+      errors: [
+        {
+          line: 2,
+          message: 'Missing JSDoc @returns declaration.',
+        },
+      ],
+      ignoreReadme: true,
+    },
+    {
+      code: `
+          /**
+           *
+           */
+          function quux () {
+            return new Promise((resolve, reject) => {
+              a.b[resolve(true)].c;
+            });
+          }
+      `,
+      errors: [
+        {
+          line: 2,
+          message: 'Missing JSDoc @returns declaration.',
+        },
+      ],
+      ignoreReadme: true,
+    },
+    {
+      code: `
+          /**
+           *
+           */
+          function quux () {
+            return new Promise((resolve, reject) => {
+              a.b[resolve(true)].c;
+            });
+          }
+      `,
+      errors: [
+        {
+          line: 2,
+          message: 'Missing JSDoc @returns declaration.',
+        },
+      ],
+      ignoreReadme: true,
+    },
+    {
+      code: `
+          /**
+           *
+           */
+          function quux () {
+            return new Promise((resolve, reject) => {
+              abc?.[resolve(true)].d?.e(resolve(true));
+            });
+          }
+      `,
+      errors: [
+        {
+          line: 2,
+          message: 'Missing JSDoc @returns declaration.',
+        },
+      ],
+      ignoreReadme: true,
+      parserOptions: {
+        ecmaVersion: 2_020,
+      },
+    },
     {
       code: `
           /**