comment-parser 0.7.4 → 0.7.5

package/CHANGELOG.md

@@ -1,3 +1,6 @@
+# v0.7.5
+- name parsing fixes
+
 # v0.7.4
 - node 8 backward compatibility fixes
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "comment-parser",
-  "version": "0.7.4",
+  "version": "0.7.5",
   "description": "Generic JSDoc-like comment parser. ",
   "main": "index.js",
   "types": "index.d.ts",
@@ -61,7 +61,8 @@
     "Evgeny Reznichenko (https://github.com/zxcabs)",
     "Javier \"Ciberma\" Mora (https://github.com/jhm-ciberman)",
     "Jordan Harband (https://github.com/ljharb)",
-    "tengattack (https://github.com/tengattack)"
+    "tengattack (https://github.com/tengattack)",
+    "Jayden Seric (https://github.com/jaydenseric)"
   ],
   "license": "MIT",
   "bugs": {

package/parsers.js

@@ -13,12 +13,12 @@ function skipws (str) {
 const PARSERS = {}
 
 PARSERS.parse_tag = function parse_tag (str) {
-  const result = str.match(/^\s*@(\S+)/)
-  if (!result) { throw new Error('Invalid `@tag`, missing @ symbol') }
+  const match = str.match(/^\s*@(\S+)/)
+  if (!match) { throw new SyntaxError('Invalid `@tag`, missing @ symbol') }
 
   return {
-    source: result[0],
-    data: { tag: result[1] }
+    source: match[0],
+    data: { tag: match[1] }
   }
 }
 
@@ -38,7 +38,7 @@ PARSERS.parse_type = function parse_type (str, data) {
     if (curlies === 0) { break }
   }
 
-  if (curlies !== 0) { throw new Error('Invalid `{type}`, unpaired curlies') }
+  if (curlies !== 0) { throw new SyntaxError('Invalid `{type}`, unpaired curlies') }
 
   return {
     source: str.slice(0, pos),
@@ -68,7 +68,7 @@ PARSERS.parse_name = function parse_name (str, data) {
       if (brackets === 0 && /\s/.test(str[pos])) { break }
     }
 
-    if (brackets !== 0) { throw new Error('Invalid `name`, unpaired brackets') }
+    if (brackets !== 0) { throw new SyntaxError('Invalid `name`, unpaired brackets') }
 
     res = { name, optional: false }
 
@@ -76,11 +76,14 @@ PARSERS.parse_name = function parse_name (str, data) {
       res.optional = true
       name = name.slice(1, -1)
 
-      if (name.indexOf('=') !== -1) {
-        const parts = name.split('=')
-        name = parts[0]
-        res.default = parts[1].replace(/^(["'])(.+)(\1)$/, '$2')
-      }
+      const match = name.match(
+        /^\s*([^=]+?)(?:\s*=\s*(.+?))?\s*(?=$)/
+      )
+
+      if (!match) throw new SyntaxError('Invalid `name`, bad syntax')
+
+      name = match[1]
+      if (match[2]) res.default = match[2]
     }
   }
 
@@ -95,12 +98,12 @@ PARSERS.parse_name = function parse_name (str, data) {
 PARSERS.parse_description = function parse_description (str, data) {
   if (data.errors && data.errors.length) { return null }
 
-  const result = str.match(/^\s+((.|\s)+)?/)
+  const match = str.match(/^\s+((.|\s)+)?/)
 
-  if (result) {
+  if (match) {
     return {
-      source: result[0],
-      data: { description: result[1] === undefined ? '' : result[1] }
+      source: match[0],
+      data: { description: match[1] === undefined ? '' : match[1] }
     }
   }