pkg: update deps

Fixes #84

Author: Alexej Yaroshevich

.jscsrc

@@ -1,6 +1,8 @@
 {
+    "plugins": ["jscs-jsdoc"],
     "preset": "google",
-    "fileExtensions": [ ".js", "jscs" ],
+
+    "fileExtensions": [ ".js", ".jscs" ],
 
     "requireParenthesesAroundIIFE": true,
     "maximumLineLength": 120,
@@ -18,8 +20,6 @@
       "test/lib/rules/**"
     ],
 
-    "plugins": ["jscs-jsdoc"],
-
     "jsDoc": {
         "enforceExistence": true,
         "checkAnnotations": "closurecompiler",

lib/jsdoc.js

@@ -1,12 +1,22 @@
 var assert = require('assert');
 var commentParser = require('comment-parser');
+
 var TypeParser = require('jsdoctypeparser').Parser;
 var TypeBuilder = require('jsdoctypeparser').Builder;
 
 // wtf but it needed to stop writing warnings to stdout
 // and revert exceptions functionality
 TypeBuilder.ENABLE_EXCEPTIONS = true;
 
+// jscs:disable requireCamelCaseOrUpperCaseIdentifiers
+var PARSERS = {
+    tag: commentParser.PARSERS.parse_tag,
+    type: commentParser.PARSERS.parse_type,
+    description: commentParser.PARSERS.parse_description,
+};
+// jscs:enable
+var RE_SPACE = /\s/;
+
 module.exports = {
 
     /**
@@ -94,6 +104,8 @@ function DocTag(tag, loc) {
     this.id = tag.tag;
     this.line = tag.line;
     this.value = tag.value;
+    this.name = undefined;
+    this.type = undefined;
 
     this.description = tag.description;
     this.optional = tag.optional;
@@ -193,107 +205,114 @@ DocLocation.prototype.shift = function(line, column) {
  * @private
  */
 function _parseComment(comment) {
-    var notCleanTagRe = /[^\w\d_]/i;
-    var parsed = commentParser(comment, {
-        'line_numbers': true,
-        'raw_value': true
+    return commentParser(comment, {
+        parsers: [
+            // parse tag
+            function(str) {
+                var res = PARSERS.tag.call(this, str);
+                res.data.value = str;
+                return res;
+            },
+            PARSERS.type,
+            _parseName,
+            PARSERS.description,
+        ]
     })[0];
-
-    if (parsed && Array.isArray(parsed.tags)) {
-        // additional tag.name parsing logic
-        parsed.tags = parsed.tags.map(function(tag) {
-            if (!tag.name || !notCleanTagRe.test(tag.name)) {
-                return tag;
-            }
-
-            var node = _parseNameAgain(tag.name);
-            if (node.error) {
-                tag.error = node.error;
-                return tag;
-            }
-            if (node.ticked) {
-                tag.ticked = node.ticked;
-            }
-            if (node.default) {
-                tag.default = node.default;
-            }
-            if (node.required) {
-                tag.required = node.required;
-            }
-
-            tag.name = node.name;
-
-            return tag;
-        });
-    }
-
-    return parsed;
 }
 
 /**
- * Additional name parsing logic for our purposes
- * @param {string} str - unparsed name thing
- * @returns {Object}
+ * analogue of str.match(/@(\S+)(?:\s+\{([^\}]+)\})?(?:\s+(\S+))?(?:\s+([^$]+))?/);
+ * @param {string} str raw jsdoc string
+ * @returns {?Object} parsed tag node
  */
-function _parseNameAgain(str) { // (?:\s+(\S+))?
-    var out = {};
-
-    // strip ticks (support for ticked variables)
-    if (str[0] === '`' && str[str.length - 1] === '`') {
-        out.ticked = true;
-        str = str.substr(1, str.length - 2);
-    }
-
-    // strip chevrons
-    if (str[0] === '<' && str[str.length - 1] === '>') {
-        out.required = true;
-        str = str.substr(1, str.length - 2);
-        if (str.replace(/[\s\w\d]+/ig, '') === '') {
-            out.name = str.replace(/^\s+|\s+$/g, '');
-            return out;
-        } else {
-            out.error = 'Unknown name format';
-            return out;
-        }
+function _parseName(str, data) {
+    if (data.errors && data.errors.length) {
+        return null;
     }
 
-    // parsing [name="mix"]
-    var ch;
-    var res = '';
+    var l        = str.length;
+    var pos      = _skipws(str);
+    var ch       = '';
+    var name     = '';
     var brackets = 0;
-    var re = /\s/;
-    var l = str.length;
-    var pos = 0;
+    var chevrons = 0;
+    var ticks    = 0;
+
     while (pos < l) {
         ch = str[pos];
         brackets += ch === '[' ? 1 : ch === ']' ? -1 : 0;
-        res += ch;
-        pos ++;
-        if (brackets === 0 && re.test(str[pos])) {
+        chevrons += ch === '<' ? 1 : ch === '>' ? -1 : 0;
+        if (ch === '`') {
+            ticks++;
+        }
+        if (ticks % 2 === 0 && chevrons === 0 && brackets === 0 && RE_SPACE.test(ch)) {
             break;
         }
+        name += ch;
+        pos ++;
+    }
+
+    if (brackets !== 0) { throw Error('Invalid `name`, unpaired brackets'); }
+    if (chevrons !== 0) { throw Error('Invalid `name`, unpaired chevrons'); }
+    if (ticks % 2 !== 0) { throw Error('Invalid `name`, unpaired ticks'); }
+
+    var res = {
+        name: name,
+        default: undefined,
+        optional: false,
+        required: false,
+        ticked: false
+    };
+
+    // strip ticks (support for ticked variables)
+    if (name[0] === '`' && name[name.length - 1] === '`') {
+        res.ticked = true;
+        name = name.slice(1, -1).trim();
     }
-    if (brackets) {
-        // throw new Error('Unpaired curly in type doc');
-        out.error = 'Unpaired brackets in type doc';
-        return out;
+
+    // strip chevrons
+    if (name[0] === '<' && name[name.length - 1] === '>') {
+        res.required = true;
+        name = name.slice(1, -1).trim();
     }
 
-    if (res[0] === '[' && res[res.length - 1] === ']') {
-        out.optional = true;
-        res = res.substr(1, res.length - 2);
-        var eqPos = res.indexOf('=');
+    // strip brackets
+    if (name[0] === '[' && name[name.length - 1] === ']') {
+        res.optional = true;
+        name = name.slice(1, -1).trim();
+
+        var eqPos = name.indexOf('=');
         if (eqPos !== -1) {
-            out.name = res.substr(0, eqPos);
-            out.default = res.substr(eqPos + 1).replace(/^(["'])(.+)(\1)$/, '$2');
-        } else {
-            out.name = res;
+            res.default = name.substr(eqPos + 1).trim().replace(/^(["'])(.+)(\1)$/, '$2');
+            name = name.substr(0, eqPos).trim();
         }
-    } else {
-        out.name = res;
     }
 
-    return out;
+    res.name = name;
+
+    return {
+        source : str.substr(0, pos),
+        data   : res
+    };
+
+    /**
+     * Returns the next to whitespace char position in a string
+     *
+     * @param {string} str
+     * @return {number}
+     */
+    function _skipws(str) {
+        var i = 0;
+        var l = str.length;
+        var ch;
+        do {
+            ch = str[i];
+            if (ch !== ' ' && ch !== '\t') {
+                break;
+            }
+        } while (++i < l);
+        return i;
+    }
 }
 
 /**

package.json

@@ -23,14 +23,14 @@
     "node": ">= 0.10.0"
   },
   "dependencies": {
-    "comment-parser": "0.2.4",
+    "comment-parser": "0.3.0",
     "jsdoctypeparser": "^1.1.4"
   },
   "devDependencies": {
-    "chai": "^2.2.0",
-    "jscs": "^1.12.0",
-    "jshint": "^2.6.3",
-    "mocha": "^2.2.1"
+    "chai": "^2.3.0",
+    "jscs": "^1.13.1",
+    "jshint": "^2.7.0",
+    "mocha": "^2.2.4"
   },
   "_peerDependencies": {
     "jscs": ">=1.8.0 <2.0"