fix(require-returns): regression with forcing all async returns to …

…be ignored; fixes #1019
gajus · Apr 17, 2023 · 41d1cf3 · 41d1cf3
1 parent b23a587
commit 41d1cf3
Show file tree

Hide file tree

Showing 3 changed files with 56 additions and 21 deletions.
diff --git a/README.md b/README.md
@@ -20446,6 +20446,22 @@ export function readFixture(path: string): void;
 export function readFixture(path: string);
 // "jsdoc/require-returns": ["error"|"warn", {"forceRequireReturn":true}]
 // Message: Missing JSDoc @returns declaration.
+
+/**
+ * @param {array} a
+ */
+async function foo(a) {
+  return Promise.all(a);
+}
+// Message: Missing JSDoc @returns declaration.
+
+/**
+ * Description.
+ */
+export default async function demo() {
+  return true;
+}
+// Message: Missing JSDoc @returns declaration.
 ````
 
 The following patterns are not considered problems:
@@ -20930,13 +20946,6 @@ async function foo() {
   return new Promise(resolve => resolve());
 }
 
-/**
- * @param {array} a
- */
-async function foo(a) {
-  return Promise.all(a);
-}
-
 /**
  * @param ms time in millis
  */

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

diff --git a/test/rules/assertions/requireReturns.js b/test/rules/assertions/requireReturns.js
@@ -1726,6 +1726,45 @@ export default {
       ],
       parser: require.resolve('@typescript-eslint/parser'),
     },
+    {
+      code: `
+      /**
+       * @param {array} a
+       */
+      async function foo(a) {
+        return Promise.all(a);
+      }
+      `,
+      errors: [
+        {
+          line: 2,
+          message: 'Missing JSDoc @returns declaration.',
+        },
+      ],
+      parserOptions: {
+        ecmaVersion: 8,
+      },
+    },
+    {
+      code: `
+      /**
+       * Description.
+       */
+      export default async function demo() {
+        return true;
+      }
+      `,
+      errors: [
+        {
+          line: 2,
+          message: 'Missing JSDoc @returns declaration.',
+        },
+      ],
+      parserOptions: {
+        ecmaVersion: 8,
+        sourceType: 'module',
+      },
+    },
   ],
   valid: [
     {
@@ -2562,19 +2601,6 @@ export default {
       ],
       parser: require.resolve('@typescript-eslint/parser'),
     },
-    {
-      code: `
-      /**
-       * @param {array} a
-       */
-      async function foo(a) {
-        return Promise.all(a);
-      }
-      `,
-      parserOptions: {
-        ecmaVersion: 8,
-      },
-    },
     {
       code: `
         /**