Update: Use process @abstract when processing @return (fixes eslint#5941

) (eslint#5945) Allow @return(s) without return keyword in function when @abstract/virtual is present
vitorbal · Apr 25, 2016 · 51ddd4b · 51ddd4b
1 parent 52a4bea
commit 51ddd4b
Show file tree

Hide file tree

Showing 3 changed files with 61 additions and 1 deletion.
diff --git a/docs/rules/valid-jsdoc.md b/docs/rules/valid-jsdoc.md
@@ -131,6 +131,18 @@ class Foo {
         this.num1 = num1;
     }
 }
+
+// @returns allowed without return if used with @abstract
+class Foo {
+    /**
+     * @abstract
+     * @return {Number} num
+     */
+    abstractMethod () {
+        throw new Error('Not implemented');
+    }
+}
+
 ```
 
 ## Options

diff --git a/lib/rules/valid-jsdoc.js b/lib/rules/valid-jsdoc.js
@@ -184,6 +184,7 @@ module.exports = function(context) {
             hasConstructor = false,
             isInterface = false,
             isOverride = false,
+            isAbstract = false,
             params = Object.create(null),
             jsdoc;
 
@@ -233,7 +234,7 @@ module.exports = function(context) {
                     case "returns":
                         hasReturns = true;
 
-                        if (!requireReturn && !functionData.returnPresent && (tag.type === null || !isValidReturnType(tag))) {
+                        if (!requireReturn && !functionData.returnPresent && (tag.type === null || !isValidReturnType(tag)) && !isAbstract) {
                             context.report(jsdocNode, "Unexpected @" + tag.title + " tag; function has no return statement.");
                         } else {
                             if (requireReturnType && !tag.type) {
@@ -257,6 +258,11 @@ module.exports = function(context) {
                         isOverride = true;
                         break;
 
+                    case "abstract":
+                    case "virtual":
+                        isAbstract = true;
+                        break;
+
                     case "interface":
                         isInterface = true;
                         break;

diff --git a/tests/lib/rules/valid-jsdoc.js b/tests/lib/rules/valid-jsdoc.js
@@ -470,6 +470,48 @@ ruleTester.run("valid-jsdoc", rule, {
             parserOptions: {
                 ecmaVersion: 6
             }
+        },
+
+        // abstract
+        {
+            code:
+            "/**\n" +
+            "* Description\n" +
+            "* @abstract\n" +
+            "* @returns {Number} desc\n" +
+            "*/\n" +
+            "function foo(){ throw new Error('Not Implemented'); }",
+            options: [{ requireReturn: false }]
+        },
+        {
+            code:
+            "/**\n" +
+            "* Description\n" +
+            "* @virtual\n" +
+            "* @returns {Number} desc\n" +
+            "*/\n" +
+            "function foo(){ throw new Error('Not Implemented'); }",
+            options: [{ requireReturn: false }]
+        },
+        {
+            code:
+            "/**\n" +
+            "* Description\n" +
+            "* @abstract\n" +
+            "* @returns {Number} desc\n" +
+            "*/\n" +
+            "function foo(){ throw new Error('Not Implemented'); }",
+            options: [{ requireReturn: true }]
+        },
+        {
+            code:
+            "/**\n" +
+            "* Description\n" +
+            "* @abstract\n" +
+            "* @returns {Number} desc\n" +
+            "*/\n" +
+            "function foo(){}",
+            options: [{ requireReturn: true }]
         }
     ],