feat: make require-returns-description accept void functions (fixes #157

) feat: make require-returns-description accept void functions (fixes #157)
gajus · Mar 13, 2019 · 39918c8 · 39918c8
2 parents af5a9a9 + 8e9f35e
commit 39918c8
Show file tree

Hide file tree

Showing 3 changed files with 47 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -2145,6 +2145,20 @@ function quux () {
  */
 function quux () {
 
+}
+
+/**
+ * @returns {undefined}
+ */
+function quux () {
+
+}
+
+/**
+ * @returns {void}
+ */
+function quux () {
+
 }
 ````
 
@@ -2358,6 +2372,13 @@ function quux (bar) {
  * @returns Array
  */
 const quux = (bar) => bar.filter(({ corge }) => corge())
+
+/**
+ * @inheritdoc
+ */
+function quux (foo) {
+  return "test"
+}
 ````
 
 

diff --git a/src/rules/requireReturnsDescription.js b/src/rules/requireReturnsDescription.js
@@ -13,6 +13,12 @@ export default iterateJsdoc(({
   });
 
   _.forEach(jsdocTags, (jsdocTag) => {
+    const type = jsdocTag.type && jsdocTag.type.trim();
+
+    if (type === 'void' || type === 'undefined') {
+      return;
+    }
+
     if (!jsdocTag.description) {
       report('Missing JSDoc @' + targetTagName + ' description.', null, jsdocTag);
     }

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