comment-parser 0.4.1 → 0.4.2

package/.travis.yml

@@ -1,8 +1,6 @@
 language: node_js
 node_js:
+  - "8.5"
+  - "6.11"
   - "4.1"
   - "4.0"
-  - "0.12"
-  - "0.11"
-  - "0.10"
-  - "iojs"

package/CHANGELOG.md

@@ -1,3 +1,6 @@
+# v0.4.2
+- tolerate inconsistent lines alignment within block
+
 # v0.4.1
 - refactored parsing, allow to not start lines with "* " inside block
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "comment-parser",
-  "version": "0.4.1",
+  "version": "0.4.2",
   "description": "Generic JSDoc-like comment parser. ",
   "main": "index.js",
   "directories": {

package/parser.js

@@ -12,8 +12,8 @@ function merge (/* ...objects */) {
   var res = {}
   var objs = Array.prototype.slice.call(arguments)
 
-  while (objs.length) {
-    obj = objs.shift()
+  for (var i = 0, l = objs.length; i < l; i++) {
+    obj = objs[i]
     for (k in obj) {
       if (obj.hasOwnProperty(k)) {
         res[k] = obj[k]
@@ -83,9 +83,9 @@ function parse_tag (str, parsers) {
  * Parses comment block (array of String lines)
  */
 function parse_block (source, opts) {
-  function trim (s) {
-    return opts.trim ? s.trim() : s
-  }
+  var trim = opts.trim
+    ? function trim (s) { return s.trim() }
+    : function trim (s) { return s }
 
   var source_str = source
     .map(function (line) { return trim(line.source) })
@@ -211,10 +211,26 @@ function mkextract (opts) {
 
     // if we are on middle of comment block
     if (chunk) {
+      var lineStart = indent
+
+      // figure out if we slice from opening marker pos
+      // or line start is shifted to the left
+      var nonSpaceChar = line.match(/\S/)
+
+      // skip for the first line starting with /** (fresh chunk)
+      // it always has the right indentation
+      if (chunk.length > 0 && nonSpaceChar) {
+        if (nonSpaceChar[0] === '*') {
+          lineStart = nonSpaceChar.index + 2
+        } else if (nonSpaceChar.index < indent) {
+          lineStart = nonSpaceChar.index
+        }
+      }
+
       // slice the line until end or until closing marker start
-      chunk = chunk.concat({
+      chunk.push({
         number: number,
-        source: line.slice(indent, endPos === -1 ? line.length : endPos)
+        source: line.slice(lineStart, endPos === -1 ? line.length : endPos)
       })
 
       // finalize block if end marker detected
@@ -238,7 +254,7 @@ module.exports = function parse (source, opts) {
   var extract = mkextract(opts)
   var lines = source.split(/\n/)
 
-  while (lines.length) {
+  for (var i = 0, l = lines.length; i < l; i++) {
     block = extract(lines.shift())
     if (block) {
       blocks.push(block)

package/tests/parse.spec.js

@@ -689,4 +689,100 @@ describe('Comment string parsing', function () {
         }]
       })
   })
+
+  it('should parse doc block with bound forced to the left', function () {
+    expect(parse(function () {
+      /**
+   * Description text
+   * @tag tagname Tag description
+   */
+    })[0])
+      .to.eql({
+        description: 'Description text',
+        source: 'Description text\n@tag tagname Tag description',
+        line: 1,
+        tags: [{
+          tag: 'tag',
+          name: 'tagname',
+          optional: false,
+          description: 'Tag description',
+          type: '',
+          line: 3,
+          source: '@tag tagname Tag description'
+        }]
+      })
+  })
+
+  it('should parse doc block with bound forced to the right', function () {
+    expect(parse(function () {
+      /**
+           * Description text
+           * @tag tagname Tag description
+           */
+    })[0])
+      .to.eql({
+        description: 'Description text',
+        source: 'Description text\n@tag tagname Tag description',
+        line: 1,
+        tags: [{
+          tag: 'tag',
+          name: 'tagname',
+          optional: false,
+          description: 'Tag description',
+          type: '',
+          line: 3,
+          source: '@tag tagname Tag description'
+        }]
+      })
+  })
+
+  it('should parse doc block with soft bound', function () {
+    expect(parse(function () {
+      /**
+   Description text
+           another line
+   @tag tagname Tag description
+   */
+    })[0])
+      .to.eql({
+        description: 'Description text\nanother line',
+        source: 'Description text\nanother line\n@tag tagname Tag description',
+        line: 1,
+        tags: [{
+          tag: 'tag',
+          name: 'tagname',
+          optional: false,
+          description: 'Tag description',
+          type: '',
+          line: 4,
+          source: '@tag tagname Tag description'
+        }]
+      })
+  })
+
+  it('should parse doc block with soft bound respecting `opts.trim = false`', function () {
+    expect(parse(function () {
+      /**
+   Description text
+           another line
+   @tag tagname Tag description
+   */
+    }, {
+      trim: false
+    })[0])
+      .to.eql({
+        description: '\nDescription text\n  another line',
+        source: '\nDescription text\n  another line\n@tag tagname Tag description\n',
+        line: 1,
+        tags: [{
+          tag: 'tag',
+          name: 'tagname',
+          optional: false,
+          description: 'Tag description\n',
+          type: '',
+          line: 4,
+          source: '@tag tagname Tag description\n'
+        }]
+      })
+  })
 })

package/.jshintrc

@@ -1,11 +0,0 @@
-{
-  "node":      true,
-  "strict":    true,
-  "maxlen":    100,
-  "undef":     true,
-  "unused":    true,
-  "onecase":   true,
-  "lastsemic": true,
-  "latedef"  : true,
-  "indent":    2
-}