fix: recognize implicit return in require-returns-check (fixes #156)

gajus · Mar 15, 2019 · b8b9692 · b8b9692
2 parents 897f205 + 3483159
commit b8b9692
Show file tree

Hide file tree

Showing 3 changed files with 39 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -2257,6 +2257,12 @@ function quux (foo) {
 }
 // Settings: {"jsdoc":{"tagNamePreference":{"returns":"return"}}}
 // Message: Present JSDoc @return declaration but not available return expression in function.
+
+/**
+ * @returns
+ */
+const quux = () => {}
+// Message: Present JSDoc @returns declaration but not available return expression in function.
 ````
 
 The following patterns are not considered problems:
@@ -2291,6 +2297,11 @@ function quux () {
  */
 function quux () {
 }
+
+/**
+ * @returns {*} Foo.
+ */
+const quux = () => foo;
 ````
 
 

diff --git a/src/rules/requireReturnsCheck.js b/src/rules/requireReturnsCheck.js
@@ -4,6 +4,7 @@ import iterateJsdoc from '../iterateJsdoc';
 export default iterateJsdoc(({
   jsdoc,
   report,
+  functionNode,
   utils
 }) => {
   const targetTagName = utils.getPreferredTagName('returns');
@@ -18,6 +19,11 @@ export default iterateJsdoc(({
     return ['undefined', 'void'].indexOf(vundef.type) !== -1;
   }) === -1;
 
+  // Implicit return like `() => foo` is ok
+  if (functionNode.type === 'ArrowFunctionExpression' && functionNode.expression) {
+    return;
+  }
+
   if (JSON.stringify(jsdocTags) !== '[]' && voidReturn && sourcecode.indexOf('return') < 1) {
     report('Present JSDoc @' + targetTagName + ' declaration but not available return expression in function.');
   }

diff --git a/test/rules/assertions/requireReturnsCheck.js b/test/rules/assertions/requireReturnsCheck.js
@@ -38,6 +38,20 @@ export default {
           }
         }
       }
+    },
+    {
+      code: `
+            /**
+             * @returns
+             */
+            const quux = () => {}
+        `,
+      errors: [
+        {
+          line: 2,
+          message: 'Present JSDoc @returns declaration but not available return expression in function.'
+        }
+      ]
     }
   ],
   valid: [
@@ -82,6 +96,14 @@ export default {
           function quux () {
           }
       `
+    },
+    {
+      code: `
+          /**
+           * @returns {*} Foo.
+           */
+          const quux = () => foo;
+      `
     }
   ]
 };