split returns to separated rules

Author: Alexej Yaroshevich

lib/rules/validate-jsdoc/check-redundant-returns.js

@@ -0,0 +1,26 @@
+module.exports = checkReturnTypes;
+module.exports.tags = ['return', 'returns'];
+module.exports.scopes = ['function'];
+module.exports.options = {
+    checkRedundantReturns: {allowedValues: [true]}
+};
+
+/**
+ * checking returns types
+ * @param {(FunctionDeclaration|FunctionExpression)} node
+ * @param {DocTag} tag
+ * @param {Function} err
+ */
+function checkReturnTypes(node, tag, err) {
+    // checking consistency
+    if (!tag.type) {
+        return;
+    }
+
+    // checking redundant: invalid or not return statements in code
+    var redundant = !tag.type.valid || !this._getReturnStatementsForNode(node).length;
+
+    if (redundant) {
+        err('redundant returns statement');
+    }
+}

lib/rules/validate-jsdoc/check-return-types.js

@@ -12,16 +12,15 @@ module.exports.options = {
  * @param {Function} err
  */
 function checkReturnTypes(node, tag, err) {
-   /* var option = this._options.checkReturnTypes;
-    if (!node.jsdoc) {
+    // try to check returns types
+    if (!tag.type || !tag.type.valid) {
         return;
     }
 
-    console.log(node.jsdoc);
-
-    if (node.jsdoc) {
-
-    }*/
-    if (node) { err(); }
-    return tag;
+    var returnsArgumentStatements = this._getReturnStatementsForNode(node);
+    returnsArgumentStatements.forEach(function(argument) {
+        if (!tag.type.match(argument)) {
+            err('Wrong returns value', argument.loc.start);
+        }
+    });
 }

lib/rules/validate-jsdoc/index.js

@@ -7,7 +7,11 @@ var validatorsByName = module.exports = {
     checkRedundantParams: require('./check-redundant-params'),
     requireParamTypes: require('./require-param-types'),
 
-    returns: require('./returns'),
+    checkReturnTypes: require('./check-return-types'),
+    requireReturnTypes: require('./require-return-types'),
+    checkRedundantReturns: require('./check-redundant-returns'),
+
+    //returns: require('./returns'),
     checkRedundantAccess: require('./check-redundant-access'),
     enforceExistence: require('./enforce-existence'),
     leadingUnderscoreAccess: require('./leading-underscore-access')

lib/rules/validate-jsdoc/require-return-types.js

@@ -0,0 +1,18 @@
+module.exports = requireReturnTypes;
+module.exports.tags = ['return', 'returns'];
+module.exports.scopes = ['function'];
+module.exports.options = {
+    requireReturnTypes: {allowedValues: [true]}
+};
+
+/**
+ * requiring returns types (?)
+ * @param {(FunctionDeclaration|FunctionExpression)} node
+ * @param {DocTag} tag
+ * @param {Function} err
+ */
+function requireReturnTypes(node, tag, err) {
+    if (!tag.type) {
+        err('Missing type in @returns statement');
+    }
+}