fix: if return type is missing, only check one path; fixes #949

Users can still rely on `require-returns-type` to catch missing types
gajus · Jan 23, 2023 · 8b72df4 · 8b72df4
1 parent e0f4862
commit 8b72df4
Show file tree

Hide file tree

Showing 3 changed files with 113 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -17813,7 +17813,7 @@ function quux () {
 // Message: JSDoc @returns declaration present but return expression not available in function.
 
 /**
- * @returns Baz.
+ * @returns {SomeType} Baz.
  */
 function foo() {
     switch (true) {
@@ -17827,7 +17827,7 @@ function foo() {
 // Message: JSDoc @returns declaration present but return expression not available in function.
 
 /**
- * @returns Baz.
+ * @returns {SomeType} Baz.
  */
 function foo() {
     switch (true) {
@@ -18243,6 +18243,16 @@ function assertNumber(val) {
  */
 export function readFixture(path: string): Promise<Buffer>;
 
+/**
+ * Reads a test fixture.
+ *
+ * @param path The path to resolve relative to the fixture base. It will be normalized for the
+ * operating system.
+ *
+ * @returns {SomeType} The file contents as buffer.
+ */
+export function readFixture(path: string): Promise<Buffer>;
+
 /**
  * Reads a test fixture.
  *
@@ -18430,6 +18440,41 @@ function foo( bar ) {
     return functionWithUnknownReturnType();
   }
 }
+
+/**
+ * @returns Baz.
+ */
+function foo() {
+    switch (true) {
+        default:
+            switch (false) {
+                default: return;
+            }
+            return "baz";
+    }
+};
+
+/**
+ * @returns Baz.
+ */
+function foo() {
+    switch (true) {
+        default:
+            switch (false) {
+                default: return;
+            }
+            return "baz";
+    }
+};
+
+/**
+ * @returns
+ */
+const quux = (someVar) => {
+  if (someVar) {
+    return true;
+  }
+};
 ````
 
 

diff --git a/src/rules/requireReturnsCheck.js b/src/rules/requireReturnsCheck.js
@@ -94,10 +94,14 @@ export default iterateJsdoc(({
       reportMissingReturnForUndefinedTypes ||
       !utils.mayBeUndefinedTypeTag(tag)
     ) &&
-    !utils.hasValueOrExecutorHasNonEmptyResolveValue(
+    (tag.type === '' && !utils.hasValueOrExecutorHasNonEmptyResolveValue(
+      exemptAsync,
+    ) ||
+    tag.type !== '' && !utils.hasValueOrExecutorHasNonEmptyResolveValue(
       exemptAsync,
       true,
-    ) && (!exemptGenerators || !node.generator)
+    )) &&
+    (!exemptGenerators || !node.generator)
   ) {
     report(`JSDoc @${tagName} declaration present but return expression not available in function.`);
   }

diff --git a/test/rules/assertions/requireReturnsCheck.js b/test/rules/assertions/requireReturnsCheck.js
@@ -613,7 +613,7 @@ export default {
     {
       code: `
       /**
-       * @returns Baz.
+       * @returns {SomeType} Baz.
        */
       function foo() {
           switch (true) {
@@ -635,7 +635,7 @@ export default {
     {
       code: `
       /**
-       * @returns Baz.
+       * @returns {SomeType} Baz.
        */
       function foo() {
           switch (true) {
@@ -1260,6 +1260,20 @@ export default {
       `,
       parser: require.resolve('@typescript-eslint/parser'),
     },
+    {
+      code: `
+      /**
+       * Reads a test fixture.
+       *
+       * @param path The path to resolve relative to the fixture base. It will be normalized for the
+       * operating system.
+       *
+       * @returns {SomeType} The file contents as buffer.
+       */
+      export function readFixture(path: string): Promise<Buffer>;
+      `,
+      parser: require.resolve('@typescript-eslint/parser'),
+    },
     {
       code: `
       /**
@@ -1518,5 +1532,49 @@ export default {
       }
       `,
     },
+    {
+      code: `
+      /**
+       * @returns Baz.
+       */
+      function foo() {
+          switch (true) {
+              default:
+                  switch (false) {
+                      default: return;
+                  }
+                  return "baz";
+          }
+      };
+      `,
+    },
+    {
+      code: `
+      /**
+       * @returns Baz.
+       */
+      function foo() {
+          switch (true) {
+              default:
+                  switch (false) {
+                      default: return;
+                  }
+                  return "baz";
+          }
+      };
+      `,
+    },
+    {
+      code: `
+      /**
+       * @returns
+       */
+      const quux = (someVar) => {
+        if (someVar) {
+          return true;
+        }
+      };
+  `,
+    },
   ],
 };