feat(require-returns-description): avoid reporting missing descroptio…

…ns for `Promise<void>` and `Promise<undefined>`
gajus · May 11, 2020 · d855301 · d855301
1 parent 548bd59
commit d855301
Show file tree

Hide file tree

Showing 4 changed files with 39 additions and 3 deletions.
diff --git a/.README/rules/require-returns-description.md b/.README/rules/require-returns-description.md
@@ -1,7 +1,8 @@
 ### `require-returns-description`
 
 Requires that the `@returns` tag has a `description` value. The error
-will not be reported if the return value is `void` or `undefined`.
+will not be reported if the return value is `void` or `undefined`
+or if it is `Promise<void>` or `Promise<undefined>`.
 
 #### Options
 

diff --git a/README.md b/README.md
@@ -11424,7 +11424,8 @@ function quux () {
 ### <code>require-returns-description</code>
 
 Requires that the `@returns` tag has a `description` value. The error
-will not be reported if the return value is `void` or `undefined`.
+will not be reported if the return value is `void` or `undefined`
+or if it is `Promise<void>` or `Promise<undefined>`.
 
 <a name="eslint-plugin-jsdoc-rules-require-returns-description-options-24"></a>
 #### Options
@@ -11547,6 +11548,20 @@ function quux () {
 
 }
 
+/**
+ * @returns {Promise<void>}
+ */
+function quux () {
+
+}
+
+/**
+ * @returns {Promise<undefined>}
+ */
+function quux () {
+
+}
+
 /**
  * @function
  * @returns

diff --git a/src/rules/requireReturnsDescription.js b/src/rules/requireReturnsDescription.js
@@ -7,7 +7,7 @@ export default iterateJsdoc(({
   utils.forEachPreferredTag('returns', (jsdocTag, targetTagName) => {
     const type = jsdocTag.type && jsdocTag.type.trim();
 
-    if (type === 'void' || type === 'undefined') {
+    if (['void', 'undefined', 'Promise<void>', 'Promise<undefined>'].includes(type)) {
       return;
     }
 

diff --git a/test/rules/assertions/requireReturnsDescription.js b/test/rules/assertions/requireReturnsDescription.js
@@ -193,6 +193,26 @@ export default {
           }
       `,
     },
+    {
+      code: `
+          /**
+           * @returns {Promise<void>}
+           */
+          function quux () {
+
+          }
+      `,
+    },
+    {
+      code: `
+          /**
+           * @returns {Promise<undefined>}
+           */
+          function quux () {
+
+          }
+      `,
+    },
     {
       code: `
           /**