fix: require returns

Require returns

Author: gajus

README.md

@@ -2648,7 +2648,18 @@ const quux = (bar) => bar.filter(({ corge }) => corge())
  * @inheritdoc
  */
 function quux (foo) {
-  return "test"
+}
+
+/**
+ * @override
+ */
+function quux (foo) {
+}
+
+/**
+ * @constructor
+ */
+function quux (foo) {
 }
 ````
 

src/iterateJsdoc.js

@@ -48,10 +48,14 @@ const curryUtils = (
     return jsdocUtils.getFunctionParameterNames(functionNode);
   };
 
-  utils.getFunctionSourceCode = function () {
+  utils.getFunctionSourceCode = () => {
     return sourceCode.getText(functionNode);
   };
 
+  utils.isConstructor = () => {
+    return functionNode.parent && functionNode.parent.kind === 'constructor';
+  };
+
   utils.getJsdocParameterNamesDeep = () => {
     return jsdocUtils.getJsdocParameterNamesDeep(jsdoc, utils.getPreferredTagName('param'));
   };
@@ -80,6 +84,10 @@ const curryUtils = (
     return jsdocUtils.isValidTag(name, additionalTagNames);
   };
 
+  utils.hasATag = (name) => {
+    return jsdocUtils.hasATag(jsdoc, name);
+  };
+
   utils.hasTag = (name) => {
     return jsdocUtils.hasTag(jsdoc, name);
   };
@@ -124,20 +132,28 @@ const curryUtils = (
     return allowAugmentsExtendsWithoutParam;
   };
 
-  utils.classHasTag = (tagName) => {
+  utils.getClassJsdocNode = () => {
     const greatGrandParent = ancestors.slice(-3)[0];
     const greatGrandParentValue = greatGrandParent && sourceCode.getFirstToken(greatGrandParent).value;
 
     if (greatGrandParentValue === 'class') {
       const classJsdocNode = sourceCode.getJSDocComment(greatGrandParent);
 
-      if (classJsdocNode) {
-        const indent = _.repeat(' ', classJsdocNode.loc.start.column);
-        const classJsdoc = parseComment(classJsdocNode, indent);
+      return classJsdocNode;
+    }
 
-        if (jsdocUtils.hasTag(classJsdoc, tagName)) {
-          return true;
-        }
+    return false;
+  };
+
+  utils.classHasTag = (tagName) => {
+    const classJsdocNode = utils.getClassJsdocNode();
+
+    if (classJsdocNode) {
+      const indent = _.repeat(' ', classJsdocNode.loc.start.column);
+      const classJsdoc = parseComment(classJsdocNode, indent);
+
+      if (jsdocUtils.hasTag(classJsdoc, tagName)) {
+        return true;
       }
     }
 

src/jsdocUtils.js

@@ -86,11 +86,18 @@ const hasTag = (jsdoc : Object, targetTagName : string) : boolean => {
   });
 };
 
+const hasATag = (jsdoc : Object, targetTagNames : Array) : boolean => {
+  return targetTagNames.some((targetTagName) => {
+    return hasTag(jsdoc, targetTagName);
+  });
+};
+
 export default {
   getFunctionParameterNames,
   getJsdocParameterNames,
   getJsdocParameterNamesDeep,
   getPreferredTagName,
+  hasATag,
   hasTag,
   isValidTag
 };

src/rules/requireReturns.js

@@ -6,11 +6,21 @@ export default iterateJsdoc(({
   report,
   utils
 }) => {
-  // inheritdoc implies that all documentation is inherited
-  // see http://usejsdoc.org/tags-inheritdoc.html
-  //
-  // As we do not know the parent method, we cannot perform any checks.
-  if (utils.hasTag('inheritdoc')) {
+  if (utils.hasATag([
+    // inheritdoc implies that all documentation is inherited
+    // see http://usejsdoc.org/tags-inheritdoc.html
+    //
+    // As we do not know the parent method, we cannot perform any checks.
+    'inheritdoc',
+    'override',
+
+    // A constructor function is assumed to return a class instance
+    'constructor'
+  ])) {
+    return;
+  }
+
+  if (utils.isConstructor()) {
     return;
   }
 

test/rules/assertions/requireReturns.js

@@ -145,7 +145,24 @@ export default {
            * @inheritdoc
            */
           function quux (foo) {
-            return "test"
+          }
+      `
+    },
+    {
+      code: `
+          /**
+           * @override
+           */
+          function quux (foo) {
+          }
+      `
+    },
+    {
+      code: `
+          /**
+           * @constructor
+           */
+          function quux (foo) {
           }
       `
     }