comment-parser 0.5.3 → 0.5.4

package/CHANGELOG.md

@@ -1,3 +1,6 @@
+# v0.5.4
+- allow quoted literal names, e.g. `@tag "My Var" description`
+
 # v0.5.3
 - corrected TypeScript definitions
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "comment-parser",
-  "version": "0.5.3",
+  "version": "0.5.4",
   "description": "Generic JSDoc-like comment parser. ",
   "main": "index.js",
   "types": "index.d.ts",

package/parsers.js

@@ -51,26 +51,35 @@ PARSERS.parse_name = function parse_name (str, data) {
   var pos = skipws(str)
   var name = ''
   var brackets = 0
+  var res = {optional: false}
+
+  // if it starts with quoted group assume it is a literal
+  var quotedGroups = str.slice(pos).split('"')
+  if (quotedGroups.length > 1 && quotedGroups[0] === '' && quotedGroups.length % 2 === 1) {
+    name = quotedGroups[1]
+    pos += name.length + 2
+  // assume name is non-space string or anything wrapped into brackets
+  } else {
+    while (pos < str.length) {
+      brackets += (str[pos] === '[' ? 1 : (str[pos] === ']' ? -1 : 0))
+      name += str[pos]
+      pos++
+      if (brackets === 0 && /\s/.test(str[pos])) { break }
+    }
 
-  while (pos < str.length) {
-    brackets += (str[pos] === '[' ? 1 : (str[pos] === ']' ? -1 : 0))
-    name += str[pos]
-    pos++
-    if (brackets === 0 && /\s/.test(str[pos])) { break }
-  }
-
-  if (brackets !== 0) { throw new Error('Invalid `name`, unpaired brackets') }
+    if (brackets !== 0) { throw new Error('Invalid `name`, unpaired brackets') }
 
-  var res = {name: name, optional: false}
+    res = {name: name, optional: false}
 
-  if (name[0] === '[' && name[name.length - 1] === ']') {
-    res.optional = true
-    name = name.slice(1, -1)
+    if (name[0] === '[' && name[name.length - 1] === ']') {
+      res.optional = true
+      name = name.slice(1, -1)
 
-    if (name.indexOf('=') !== -1) {
-      var parts = name.split('=')
-      name = parts[0]
-      res.default = parts[1].replace(/^(["'])(.+)(\1)$/, '$2')
+      if (name.indexOf('=') !== -1) {
+        var parts = name.split('=')
+        name = parts[0]
+        res.default = parts[1].replace(/^(["'])(.+)(\1)$/, '$2')
+      }
     }
   }
 

package/tests/parse.js

@@ -11,8 +11,8 @@ var parse = require('../index')
 
 module.exports = function (func, opts) {
   var str = func.toString()
-  return parse(str.slice(
-    str.indexOf('{') + 1,
-    str.lastIndexOf('}')
-  ), opts)
+  str = str
+    .slice(str.indexOf('{') + 1, str.lastIndexOf('}'))
+    .replace(/\r\n/g, '\n')
+  return parse(str, opts)
 }

package/tests/parse.spec.js

@@ -950,4 +950,92 @@ describe('Comment string parsing', function () {
       }]
     })
   })
+
+  it('should keep optional names spaces (issue #41)`', function () {
+    expect(parse(function () {
+      /**
+       * @section [Brand Colors] Here you can find all the brand colors
+       */
+    })[0])
+      .to.eql({
+        line: 1,
+        source: '@section [Brand Colors] Here you can find all the brand colors',
+        description: '',
+        tags: [{
+          tag: 'section',
+          line: 2,
+          type: '',
+          name: 'Brand Colors',
+          source: '@section [Brand Colors] Here you can find all the brand colors',
+          optional: true,
+          description: 'Here you can find all the brand colors'
+        }]
+      })
+  })
+
+  it('should keep quotes in description (issue #41)`', function () {
+    expect(parse(function () {
+      /**
+       * @section "Brand Colors" Here you can find all the brand colors
+       */
+    })[0])
+      .to.eql({
+        line: 1,
+        source: '@section "Brand Colors" Here you can find all the brand colors',
+        description: '',
+        tags: [{
+          tag: 'section',
+          line: 2,
+          type: '',
+          name: 'Brand Colors',
+          source: '@section "Brand Colors" Here you can find all the brand colors',
+          optional: false,
+          description: 'Here you can find all the brand colors'
+        }]
+      })
+  })
+
+  it('should use only quoted name (issue #41)`', function () {
+    expect(parse(function () {
+      /**
+       * @section "Brand Colors" Here you can find "all" the brand colors
+       */
+    })[0])
+      .to.eql({
+        line: 1,
+        source: '@section "Brand Colors" Here you can find "all" the brand colors',
+        description: '',
+        tags: [{
+          tag: 'section',
+          line: 2,
+          type: '',
+          name: 'Brand Colors',
+          source: '@section "Brand Colors" Here you can find "all" the brand colors',
+          optional: false,
+          description: 'Here you can find "all" the brand colors'
+        }]
+      })
+  })
+
+  it('should ignore inconsitent quoted groups (issue #41)`', function () {
+    expect(parse(function () {
+      /**
+       * @section "Brand Colors Here you can find all the brand colors
+       */
+    })[0])
+      .to.eql({
+        line: 1,
+        source: '@section "Brand Colors Here you can find all the brand colors',
+        description: '',
+        tags: [{
+          tag: 'section',
+          line: 2,
+          type: '',
+          name: '"Brand',
+          source: '@section "Brand Colors Here you can find all the brand colors',
+          optional: false,
+          description: 'Colors Here you can find all the brand colors'
+        }]
+      })
+  })
 })