Merge pull request #282 from interfaced/master

feat(require-returns-check): Skip interface class methods

Author: brettz9

README.md

@@ -5054,6 +5054,15 @@ const language = {
   }
 }
 // Message: JSDoc @returns declaration present but return expression not available in function.
+
+class Foo {
+  /**
+   * @returns {string}
+   */
+  bar () {
+  }
+}
+// Message: JSDoc @returns declaration present but return expression not available in function.
 ````
 
 The following patterns are not considered problems:
@@ -5142,6 +5151,17 @@ function quux () {
 function quux () {
 }
 
+/**
+ * @interface
+ */
+class Foo {
+  /**
+   * @returns {string}
+   */
+  bar () {
+  }
+}
+
 /**
  * @returns {undefined} Foo.
  */

src/rules/requireReturnsCheck.js

@@ -15,7 +15,7 @@ const canSkip = (utils) => {
     'class',
     'constructor',
     'interface'
-  ]) || utils.isConstructor();
+  ]) || utils.isConstructor() || utils.classHasTag('interface');
 };
 
 export default iterateJsdoc(({

test/rules/assertions/requireReturnsCheck.js

@@ -89,6 +89,23 @@ export default {
           message: 'JSDoc @returns declaration present but return expression not available in function.'
         }
       ]
+    },
+    {
+      code: `
+          class Foo {
+            /**
+             * @returns {string}
+             */
+            bar () {
+            }
+          }
+      `,
+      errors: [
+        {
+          line: 3,
+          message: 'JSDoc @returns declaration present but return expression not available in function.'
+        }
+      ]
     }
   ],
   valid: [
@@ -223,6 +240,20 @@ export default {
           }
       `
     },
+    {
+      code: `
+          /**
+           * @interface
+           */
+          class Foo {
+            /**
+             * @returns {string}
+             */
+            bar () {
+            }
+          }
+      `
+    },
     {
       code: `
           /**