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

)
gajus · Mar 13, 2019 · 75d51dc · 75d51dc
1 parent af5a9a9
commit 75d51dc
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 0 deletions.
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 () {
+
           }
       `
     }