comment-parser 0.5.4 → 0.5.5

package/CHANGELOG.md

@@ -1,3 +1,6 @@
+# v0.5.5
+- allow loose tag names, e.g. @.tag, @-tag
+
 # v0.5.4
 - allow quoted literal names, e.g. `@tag "My Var" description`
 

package/README.md

@@ -9,7 +9,7 @@ Module provides `parse(s:String[, opts:Object]):Object` function which takes `/*
 
 It is not trying to detect relations between tags or somehow recognize their meaning. Any tag can be used, as long as it satisfies the format.
 
-```
+```javascript
 /**
  * Singleline or multiline description text. Line breaks are preserved.
  *
@@ -24,7 +24,7 @@ It is not trying to detect relations between tags or somehow recognize their mea
 
 this would be parsed into following
 
-```javascript
+```json
 [{
   "tags": [{
     "tag": "some-tag",
@@ -78,7 +78,7 @@ By default dotted names like `name.subname.subsubname` will be expanded into nes
 
 Below are examples of acceptable comment formats
 
-```
+```javascript
 /** online comment */
 
 /** first line
@@ -111,7 +111,7 @@ Each parser function takes string left after previous parsers applied and data p
 
 Tag node data is build by merging result bits from all parsers. Here is some example that is not doing actual parsing but is demonstrating the flow:
 
-```
+```javascript
 /**
  * Source to be parsed below
  * @tag {type} name Description
@@ -140,12 +140,12 @@ parse(source, {parsers: [
 
 This would produce following:
 
-```
+```json
 [{
   "tags": [{
     "tag": "tag",
     "errors": [
-      "check_tag: Unrecognized tag \\"tag\\""
+      "check_tag: Unrecognized tag \"tag\""
     ],
     "name": "name2",
     "optional": false,
@@ -168,4 +168,4 @@ This would produce following:
 
 ```
 > npm info --registry https://registry.npmjs.org comment-parser contributors
-```
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "comment-parser",
-  "version": "0.5.4",
+  "version": "0.5.5",
   "description": "Generic JSDoc-like comment parser. ",
   "main": "index.js",
   "types": "index.d.ts",
@@ -10,7 +10,7 @@
   "dependencies": {},
   "devDependencies": {
     "chai": "^4.2.0",
-    "eslint": "^4.7.1",
+    "eslint": "^5.16.0",
     "eslint-config-standard": "^10.2.1",
     "eslint-plugin-import": "^2.7.0",
     "eslint-plugin-node": "^5.1.1",
@@ -20,8 +20,9 @@
     "nodemon": "^1.18.9"
   },
   "scripts": {
-    "pretest": "eslint .",
-    "test": "mocha tests",
+    "test:lint": "eslint .",
+    "test:unit": "mocha tests",
+    "test": "npm run test:lint && npm run test:unit",
     "watch": "nodemon -q -i node_modules -x npm test"
   },
   "repository": {

package/parser.js

@@ -101,7 +101,7 @@ function parse_block (source, opts) {
     .reduce(function (tags, line) {
       line.source = trim(line.source)
 
-      if (line.source.match(/^\s*@(\w+)/)) {
+      if (line.source.match(/^\s*@(\S+)/)) {
         tags.push({source: [line.source], line: line.number})
       } else {
         var tag = tags[tags.length - 1]

package/tests/parse.spec.js

@@ -459,6 +459,47 @@ describe('Comment string parsing', function () {
       })
   })
 
+  it('should tolerate loose tag names', function () {
+    expect(parse(function () {
+      /**
+         Description text
+         @.tag0 tagname Tag 0 description
+         @-tag1 tagname Tag 1 description
+         @+tag2 tagname Tag 2 description
+      */
+    })[0])
+      .eql({
+        description: 'Description text',
+        source: 'Description text\n@.tag0 tagname Tag 0 description\n@-tag1 tagname Tag 1 description\n@+tag2 tagname Tag 2 description',
+        line: 1,
+        tags: [{
+          tag: '.tag0',
+          name: 'tagname',
+          optional: false,
+          description: 'Tag 0 description',
+          type: '',
+          line: 3,
+          source: '@.tag0 tagname Tag 0 description'
+        }, {
+          tag: '-tag1',
+          name: 'tagname',
+          optional: false,
+          description: 'Tag 1 description',
+          type: '',
+          line: 4,
+          source: '@-tag1 tagname Tag 1 description'
+        }, {
+          tag: '+tag2',
+          name: 'tagname',
+          optional: false,
+          description: 'Tag 2 description',
+          type: '',
+          line: 5,
+          source: '@+tag2 tagname Tag 2 description'
+        }]
+      })
+  })
+
   it('should tolerate default value with whitespces `@tag {my.type} [name=John Doe]`', function () {
     expect(parse(function () {
       /**