comment-parser 0.7.5 → 0.7.6

package/.github/workflows/node.js.yml

@@ -0,0 +1,24 @@
+name: test
+
+on:
+  push:
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [8.x, 10.x, 12.x, 14.x]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+    - run: npm ci
+    - run: npm test

package/CHANGELOG.md

@@ -1,3 +1,6 @@
+# v0.7.6
+- distinct non-critical errors by providing `err.warning`
+
 # v0.7.5
 - name parsing fixes
 

package/package.json

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

package/parser.js

@@ -33,11 +33,16 @@ function find (list, filter) {
  * @returns {object} parsed tag node
  */
 function parse_tag (str, parsers) {
-  const data = parsers.reduce(function (state, parser) {
+  const { data } = parsers.reduce(function (state, parser) {
     let result
 
     try {
       result = parser(state.source, Object.assign({}, state.data))
+      if (result && result.data && result.data.warning) {
+        state.data.warnings = (state.data.warnings || [])
+          .concat(parser.name + ': ' + result.data.warning)
+        delete result.data.warning
+      }
     } catch (err) {
       state.data.errors = (state.data.errors || [])
         .concat(parser.name + ': ' + err.message)
@@ -52,7 +57,7 @@ function parse_tag (str, parsers) {
   }, {
     source: str,
     data: {}
-  }).data
+  })
 
   data.optional = !!data.optional
   data.type = data.type === undefined ? '' : data.type
@@ -177,6 +182,13 @@ function parse_block (source, opts) {
     return tags.concat(tag_node)
   }, [])
 
+  for (const tag of tags) {
+    if (!tag.errors && tag.warnings) {
+      tag.errors = [...tag.warnings]
+      delete tag.warnings
+    }
+  }
+
   return {
     tags,
     line: start,
@@ -215,7 +227,7 @@ function mkextract (opts) {
     const endPos = line.indexOf(MARKER_END)
 
     // if open marker detected and it's not, skip one
-    if (startPos !== -1 && line.indexOf(MARKER_START_SKIP) !== startPos) {
+    if (!chunk && startPos !== -1 && line.indexOf(MARKER_START_SKIP) !== startPos) {
       chunk = []
       indent = startPos + MARKER_START.length
     }

package/parsers.js

@@ -77,13 +77,19 @@ PARSERS.parse_name = function parse_name (str, data) {
       name = name.slice(1, -1)
 
       const match = name.match(
-        /^\s*([^=]+?)(?:\s*=\s*(.+?))?\s*(?=$)/
+        /^\s*([^=]+?)(?:\s*=\s*(.*?))?\s*(?=$)/
       )
 
       if (!match) throw new SyntaxError('Invalid `name`, bad syntax')
 
       name = match[1]
       if (match[2]) res.default = match[2]
+      // We will throw this later after processing other tags (so we
+      //  will collect enough data for the user to be able to fully recover)
+      else if (match[2] === '') {
+        res.default = match[2]
+        res.warning = 'Empty `name`, bad syntax'
+      }
     }
   }
 

package/stringifier.js

@@ -57,7 +57,7 @@ const stringifyTag = exports.stringifyTag = function stringifyTag (
     (type ? ` {${type}}` : '') +
     (name.trim() ? ` ${
       optional ? '[' : ''
-    }${name.trimRight()}${deflt ? `=${deflt}` : ''}${
+    }${name.trimRight()}${deflt !== undefined ? `=${deflt}` : ''}${
       optional ? ']' : ''
     }` : '') +
     (description ? ` ${description.replace(/\n/g, '\n' + indnt + '* ')}` : '') + '\n'