fix: requireReturns Rule does not honor inheritdoc tag (fixes #153)

RequireReturns Rule does not honor inheritdoc tag.
gajus · Feb 24, 2019 · af5a9a9 · af5a9a9
2 parents 9b185d8 + 5edb2e1
commit af5a9a9
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/src/rules/requireReturns.js b/src/rules/requireReturns.js
@@ -6,6 +6,14 @@ 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')) {
+    return;
+  }
+
   const targetTagName = utils.getPreferredTagName('returns');
 
   const jsdocTags = _.filter(jsdoc.tags, {

diff --git a/test/rules/assertions/requireReturns.js b/test/rules/assertions/requireReturns.js
@@ -138,6 +138,16 @@ export default {
            */
           const quux = (bar) => bar.filter(({ corge }) => corge())
       `
+    },
+    {
+      code: `
+          /**
+           * @inheritdoc
+           */
+          function quux (foo) {
+            return "test"
+          }
+      `
     }
   ]
 };