fix(require-returns-check, require-yields-check): avoid never b…

…eing reported
gajus · Dec 18, 2021 · 3a27c39 · 3a27c39
1 parent 4433d7e
commit 3a27c39
Show file tree

Hide file tree

Showing 5 changed files with 88 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -16637,6 +16637,19 @@ function quux () {
   return undefined;
 }
 
+/**
+ * @returns {never} Foo.
+ */
+function quux () {
+}
+
+/**
+ * @returns {never} Foo.
+ */
+function quux () {
+  return undefined;
+}
+
 /**
  * @returns {void} Foo.
  */
@@ -19583,6 +19596,12 @@ function * quux () {
 function * quux () {
 }
 
+/**
+ * @yields {never} Foo.
+ */
+function * quux () {
+}
+
 /**
  * @yields {void} Foo.
  */
@@ -19789,6 +19808,14 @@ function * quux (foo) {
   const a = yield 5;
 }
 // "jsdoc/require-yields-check": ["error"|"warn", {"next":true}]
+
+/**
+ * @next {never}
+ */
+function * quux (foo) {
+
+}
+// "jsdoc/require-yields-check": ["error"|"warn", {"next":true}]
 ````
 
 

diff --git a/src/rules/requireReturnsCheck.js b/src/rules/requireReturnsCheck.js
@@ -66,10 +66,19 @@ export default iterateJsdoc(({
     return;
   }
 
+  const [tag] = tags;
+
   // In case a return value is declared in JSDoc, we also expect one in the code.
-  if ((reportMissingReturnForUndefinedTypes || utils.hasDefinedTypeTag(tags[0])) && !utils.hasValueOrExecutorHasNonEmptyResolveValue(
-    exemptAsync,
-  ) && (!exemptGenerators || !node.generator)) {
+  if (
+    tag.type.trim() !== 'never' &&
+    (
+      reportMissingReturnForUndefinedTypes ||
+      utils.hasDefinedTypeTag(tag)
+    ) &&
+    !utils.hasValueOrExecutorHasNonEmptyResolveValue(
+      exemptAsync,
+    ) && (!exemptGenerators || !node.generator)
+  ) {
     report(`JSDoc @${tagName} declaration present but return expression not available in function.`);
   }
 }, {

diff --git a/src/rules/requireYieldsCheck.js b/src/rules/requireYieldsCheck.js
@@ -71,6 +71,10 @@ export default iterateJsdoc(({
   );
   if (preferredYieldTagName) {
     const shouldReportYields = () => {
+      if (yieldTag.type.trim() === 'never') {
+        return false;
+      }
+
       if (checkGeneratorsOnly && !utils.isGenerator()) {
         return true;
       }
@@ -90,6 +94,10 @@ export default iterateJsdoc(({
     );
     if (preferredNextTagName) {
       const shouldReportNext = () => {
+        if (nextTag.type.trim() === 'never') {
+          return false;
+        }
+
         if (checkGeneratorsOnly && !utils.isGenerator()) {
           return true;
         }

diff --git a/test/rules/assertions/requireReturnsCheck.js b/test/rules/assertions/requireReturnsCheck.js
@@ -519,6 +519,25 @@ export default {
           }
       `,
     },
+    {
+      code: `
+          /**
+           * @returns {never} Foo.
+           */
+          function quux () {
+          }
+      `,
+    },
+    {
+      code: `
+          /**
+           * @returns {never} Foo.
+           */
+          function quux () {
+            return undefined;
+          }
+      `,
+    },
     {
       code: `
           /**

diff --git a/test/rules/assertions/requireYieldsCheck.js b/test/rules/assertions/requireYieldsCheck.js
@@ -440,6 +440,15 @@ export default {
           }
       `,
     },
+    {
+      code: `
+          /**
+           * @yields {never} Foo.
+           */
+          function * quux () {
+          }
+      `,
+    },
     {
       code: `
           /**
@@ -719,5 +728,18 @@ export default {
         next: true,
       }],
     },
+    {
+      code: `
+          /**
+           * @next {never}
+           */
+          function * quux (foo) {
+
+          }
+      `,
+      options: [{
+        next: true,
+      }],
+    },
   ],
 };