Support both @returns and its alias @return as described in JSDoc 3

closure_linter/error_fixer.py

@@ -199,11 +199,6 @@ def HandleError(self, error):
       self._DeleteToken(token)
       self._AddFix(token)
 
-    elif code == errors.INVALID_JSDOC_TAG:
-      if token.string == '@returns':
-        token.string = '@return'
-        self._AddFix(token)
-
     elif code == errors.FILE_MISSING_NEWLINE:
       # This error is fixed implicitly by the way we restore the file
       self._AddFix(token)

closure_linter/javascriptlintrules.py

@@ -276,7 +276,7 @@ def CheckToken(self, token, state):
         if not self._limited_doc_checks:
           if (function.has_return and function.doc and
               not is_immediately_called and
-              not function.doc.HasFlag('return') and
+              not (function.doc.HasFlag('returns') or function.doc.HasFlag('return')) and
               not function.doc.InheritsDocumentation() and
               not function.doc.HasFlag('constructor')):
             # Check for proper documentation of return value.
@@ -287,9 +287,9 @@ def CheckToken(self, token, state):
           elif (not function.has_return and
                 not function.has_throw and
                 function.doc and
-                function.doc.HasFlag('return') and
+                (function.doc.HasFlag('returns') or function.doc.HasFlag('return')) and
                 not state.InInterfaceMethod()):
-            flag = function.doc.GetFlag('return')
+            flag = function.doc.GetFlag('returns') or function.doc.GetFlag('return')
             valid_no_return_names = ['undefined', 'void', '*']
             invalid_return = flag.jstype is None or not any(
                 sub_type.identifier in valid_no_return_names

closure_linter/statetracker.py

@@ -89,6 +89,7 @@ class DocFlag(object):
       'protected',
       'public',
       'return',
+      'returns',
       'see',
       'stableIdGenerator',
       'struct',

closure_linter/testdata/jsdoc.js

@@ -51,7 +51,6 @@ goog.require('goog.math.Vec2');
 
 
 /**
- * @returns // INVALID_JSDOC_TAG
  * @params  // INVALID_JSDOC_TAG
  * @defines // INVALID_JSDOC_TAG
  * @nginject // INVALID_JSDOC_TAG
@@ -169,6 +168,14 @@ function goodReturn() {
 }
 
 
+/**
+ * @returns {boolean} A boolean primitive.
+ */
+function goodReturns() {
+  return something;
+}
+
+
 /**
  * @return {some.long.type.that.will.make.the.description.start.on.next.line}
  *     An object.
@@ -178,6 +185,15 @@ function anotherGoodReturn() {
 }
 
 
+/**
+ * @returns {some.long.type.that.will.make.the.description.start.on.next.line}
+ *     An object.
+ */
+function anotherGoodReturns() {
+  return something;
+}
+
+
 // +2: MISSING_JSDOC_TAG_TYPE
 /**
  * @return false.
@@ -187,6 +203,15 @@ function missingReturnType() {
 }
 
 
+// +2: MISSING_JSDOC_TAG_TYPE
+/**
+ * @returns false.
+ */
+function missingReturnsType() {
+  return something;
+}
+
+
 // +2: MISSING_SPACE
 /**
  * @return{type}
@@ -196,6 +221,15 @@ function missingSpaceOnReturnType() {
 }
 
 
+// +2: MISSING_SPACE
+/**
+ * @returns{type}
+ */
+function missingSpaceOnReturnsType() {
+  return something;
+}
+
+
 // +2: MISSING_JSDOC_TAG_TYPE
 /**
  * @return
@@ -204,6 +238,15 @@ function missingReturnType() {
   return something;
 }
 
+
+// +2: MISSING_JSDOC_TAG_TYPE
+/**
+ * @returns
+ */
+function missingReturnsType() {
+  return something;
+}
+
 class.missingDocs = function() { // MISSING_MEMBER_DOCUMENTATION
 };