Merge pull request #195 from golopot/require-returns-check-false-positive

fix: require-returns-check false positive

Author: gajus

README.md

@@ -2531,17 +2531,27 @@ function quux () {
  */
 const quux = () => foo;
 
-/** 
+/**
+ * @returns {undefined} Foo.
+ */
+function quux () {}
+
+/**
+ * @returns { void } Foo.
+ */
+function quux () {}
+
+/**
  * @returns {Promise<void>}
  */
 async function quux() {}
 
-/** 
+/**
  * @returns {Promise<void>}
  */
 async () => {}
 
-/** 
+/**
  * @returns Foo.
  * @abstract
  */

src/rules/requireReturnsCheck.js

@@ -37,6 +37,12 @@ export default iterateJsdoc(({
     return;
   }
 
+  const returnsTagType = jsdocTags[0].type && jsdocTags[0].type.trim();
+
+  if (returnsTagType === 'void' || returnsTagType === 'undefined') {
+    return;
+  }
+
   // An abstract function is by definition incomplete
   // so it is perfectly fine if the return is missing
   // a subclass may inherits the doc an implements the

test/rules/assertions/requireReturnsCheck.js

@@ -125,7 +125,23 @@ export default {
     },
     {
       code: `
-          /** 
+          /**
+           * @returns {undefined} Foo.
+           */
+          function quux () {}
+      `
+    },
+    {
+      code: `
+          /**
+           * @returns { void } Foo.
+           */
+          function quux () {}
+      `
+    },
+    {
+      code: `
+          /**
            * @returns {Promise<void>}
            */
           async function quux() {}
@@ -136,7 +152,7 @@ export default {
     },
     {
       code: `
-          /** 
+          /**
            * @returns {Promise<void>}
            */
           async () => {}
@@ -147,7 +163,7 @@ export default {
     },
     {
       code: `
-          /** 
+          /**
            * @returns Foo.
            * @abstract
            */