validateJSDoc: Deprecate rule

Fixes jscs-dev#59
mrjoelkemp · Sep 19, 2014 · f29ca0d · f29ca0d
1 parent b615bd7
commit f29ca0d
Show file tree

Hide file tree

Showing 6 changed files with 26 additions and 353 deletions.
diff --git a/README.md b/README.md
@@ -2850,54 +2850,10 @@ function a(b, c) {}
 function a(b , c) {}
 ```
 
-### validateJSDoc
+### ~~validateJSDoc~~
 
-Enables JSDoc validation.
+Please use the [JSCS-JSDoc](https://github.com/jscs-dev/jscs-jsdoc) plugin instead.
 
-Type: `Object`
-
-Values:
-
- - "checkParamNames" ensures param names in jsdoc and in function declaration are equal
- - "requireParamTypes" ensures params in jsdoc contains type
- - "checkRedundantParams" reports redundant params in jsdoc
-
-#### Example
-
-```js
-"validateJSDoc": {
-    "checkParamNames": true,
-    "checkRedundantParams": true,
-    "requireParamTypes": true
-}
-```
-
-##### Valid
-
-```js
-/**
- * Adds style error to the list
- *
- * @param {String} message
- * @param {Number|Object} line
- * @param {Number} [column]
- */
-add: function(message, line, column) {
-}
-```
-
-##### Invalid
-
-```js
-/**
- * Adds style error to the list
- *
- * @param {String} message
- * @param {Number|Object} line
- * @param {Number} [column]
- */
-add: function() {
-}
 ```
 ### safeContextKeyword
 

diff --git a/lib/rules/validate-jsdoc.js b/lib/rules/validate-jsdoc.js
@@ -1,91 +1,19 @@
-var assert = require('assert');
-
 module.exports = function() {};
 
 module.exports.prototype = {
 
-    configure: function(options) {
-        assert(typeof options === 'object', 'validateJSDoc option requires object value');
-        this._options = options;
-    },
+    configure: function() {},
 
     getOptionName: function() {
         return 'validateJSDoc';
     },
 
     check: function(file, errors) {
-        var options = this._options;
-        var comments = file.getComments();
-        file.iterateNodesByType(['FunctionDeclaration', 'FunctionExpression'], function(node) {
-            var jsDoc = getJsDocForLine(node.loc.start.line);
-            if (jsDoc) {
-                var jsDocData = jsDoc.value;
-                var jsDocLines = jsDocData.split('\n');
-                var paramIndex = 0;
-                if (options.checkParamNames || options.checkRedundantParams || options.requireParamTypes) {
-                    for (var i = 0, l = jsDocLines.length; i < l; i++) {
-                        var line = jsDocLines[i].trim();
-                        if (line.charAt(0) === '*') {
-                            line = line.substr(1).trim();
-                            if (line.indexOf('@param') === 0) {
-                                var match = line.match(/^@param\s+(?:{(.+?)})?\s*(?:\[)?([a-zA-Z0-9_\.\$]+)/);
-                                if (match) {
-                                    var jsDocParamType = match[1];
-                                    var jsDocParamName = match[2];
-                                    if (options.requireParamTypes && !jsDocParamType) {
-                                        errors.add(
-                                            'Missing JSDoc @param type',
-                                            jsDoc.loc.start.line + i,
-                                            jsDocLines[i].indexOf('@param')
-                                        );
-                                    }
-                                    if (jsDocParamName.indexOf('.') === -1) {
-                                        var param = node.params[paramIndex];
-                                        if (param) {
-                                            if (jsDocParamName !== param.name) {
-                                                if (options.checkParamNames) {
-                                                    errors.add(
-                                                        'Invalid JSDoc @param argument name',
-                                                        jsDoc.loc.start.line + i,
-                                                        jsDocLines[i].indexOf('@param')
-                                                    );
-                                                }
-                                            }
-                                        } else {
-                                            if (options.checkRedundantParams) {
-                                                errors.add(
-                                                    'Redundant JSDoc @param',
-                                                    jsDoc.loc.start.line + i,
-                                                    jsDocLines[i].indexOf('@param')
-                                                );
-                                            }
-                                        }
-                                        paramIndex++;
-                                    }
-                                } else {
-                                    errors.add(
-                                        'Invalid JSDoc @param',
-                                        jsDoc.loc.start.line + i,
-                                        jsDocLines[i].indexOf('@param')
-                                    );
-                                }
-                            }
-                        }
-                    }
-                }
-            }
-        });
-
-        function getJsDocForLine(line) {
-            line--;
-            for (var i = 0, l = comments.length; i < l; i++) {
-                var comment = comments[i];
-                if (comment.loc.end.line === line && comment.type === 'Block' && comment.value.charAt(0) === '*') {
-                    return comment;
-                }
-            }
-            return null;
-        }
+        errors.add(
+            'The validateJSDoc rule is no longer supported.' +
+            '\nPlease use the JSCS-JSDoc plugininstead',
+            1,
+            0
+        );
     }
-
 };
diff --git a/lib/string-checker.js b/lib/string-checker.js
@@ -43,6 +43,7 @@ StringChecker.prototype = {
         this.registerRule(new (require('./rules/disallow-left-sticked-operators'))());
         this.registerRule(new (require('./rules/require-right-sticked-operators'))());
         this.registerRule(new (require('./rules/disallow-right-sticked-operators'))());
+        this.registerRule(new (require('./rules/validate-jsdoc'))());
         /* deprecated rules (end) */
 
         this.registerRule(new (require('./rules/require-operator-before-line-break'))());
@@ -60,7 +61,6 @@ StringChecker.prototype = {
         this.registerRule(new (require('./rules/disallow-keywords-on-new-line'))());
         this.registerRule(new (require('./rules/require-line-feed-at-file-end'))());
         this.registerRule(new (require('./rules/maximum-line-length'))());
-        this.registerRule(new (require('./rules/validate-jsdoc'))());
         this.registerRule(new (require('./rules/require-yoda-conditions'))());
         this.registerRule(new (require('./rules/disallow-yoda-conditions'))());
         this.registerRule(new (require('./rules/require-spaces-inside-object-brackets'))());

diff --git a/presets/google.json b/presets/google.json
@@ -57,11 +57,5 @@
     "disallowSpacesInsideArrayBrackets": "all",
     "disallowSpacesInsideParentheses": true,
 
-
-    "validateJSDoc": {
-        "checkParamNames": true,
-        "requireParamTypes": true
-    },
-
     "disallowMultipleLineBreaks": true
 }
diff --git a/presets/yandex.json b/presets/yandex.json
@@ -85,11 +85,6 @@
     "disallowSpacesInsideObjectBrackets": true,
     "disallowQuotedKeysInObjects": true,
 
-    "validateJSDoc": {
-        "checkParamNames": true,
-        "requireParamTypes": true
-    },
-
     "maximumLineLength": {
         "value": 120,
         "allowUrlComments": true