fix(require-returns): async with return should be documented; fixes

#518
gajus · May 18, 2020 · 99476af · 99476af
1 parent 176be5d
commit 99476af
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 21 deletions.
diff --git a/README.md b/README.md
@@ -12209,6 +12209,14 @@ class quux {
 }
 // Options: [{"contexts":["any"],"forceRequireReturn":true}]
 // Message: Missing JSDoc @returns declaration.
+
+/**
+ * @param {array} a
+ */
+async function foo(a) {
+  return Promise.all(a);
+}
+// Message: Missing JSDoc @returns declaration.
 ````
 
 The following patterns are not considered problems:
@@ -12487,13 +12495,6 @@ function quux () {
 }
 // Options: [{"exemptedBy":["type"]}]
 
-/**
- * @param {array} a
- */
-async function foo(a) {
-  return Promise.all(a);
-}
-
 /**
  * @param {array} a
  */

diff --git a/src/rules/requireReturns.js b/src/rules/requireReturns.js
@@ -88,7 +88,7 @@ export default iterateJsdoc(({
       return true;
     }
 
-    return !isAsync && iteratingFunction && utils.hasReturnValue();
+    return iteratingFunction && utils.hasReturnValue();
   };
 
   if (shouldReport()) {

diff --git a/test/rules/assertions/requireReturns.js b/test/rules/assertions/requireReturns.js
@@ -529,6 +529,25 @@ export default {
         forceRequireReturn: true,
       }],
     },
+    {
+      code: `
+      /**
+       * @param {array} a
+       */
+      async function foo(a) {
+        return Promise.all(a);
+      }
+      `,
+      errors: [
+        {
+          line: 2,
+          message: 'Missing JSDoc @returns declaration.',
+        },
+      ],
+      parserOptions: {
+        ecmaVersion: 8,
+      },
+    },
   ],
   valid: [
     {
@@ -963,19 +982,6 @@ export default {
         },
       ],
     },
-    {
-      code: `
-      /**
-       * @param {array} a
-       */
-      async function foo(a) {
-        return Promise.all(a);
-      }
-      `,
-      parserOptions: {
-        ecmaVersion: 8,
-      },
-    },
     {
       code: `
       /**