comment-parser 0.3.1 → 0.4.2

package/.eslintignore

@@ -0,0 +1 @@
+node_modules/*

package/.eslintrc

@@ -0,0 +1,11 @@
+{
+  "extends": "standard",
+  "env": {
+    "browser": true,
+    "node": true,
+    "mocha": true
+  },
+  "rules": {
+    "camelcase": "off"
+  }
+}

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,12 @@
+# v0.4.2
+- tolerate inconsistent lines alignment within block
+
+# v0.4.1
+- refactored parsing, allow to not start lines with "* " inside block
+
+# v0.3.2
+- fix RegExp for `description` extraction to allow $ char
+
 # v0.3.1
 - use `readable-stream` fro Node 0.8 comatibility
 - allow to pass optional parameters to `parse.file(path [,opts], done)`  
@@ -39,4 +48,4 @@
 
 # v0.1.0
 
-Initial implementation
+Initial implementation

package/README.md

@@ -66,7 +66,29 @@ this would be parsed into following
 
 By default dotted names like `name.subname.subsubname` will be expanded into nested sections, this can be prevented by passing `opts.dotted_names = false`.
 
-Invalid comment blocks are skipped. Comments starting with `/*` and `/***` are considered not valid.
+Below are examples of acceptable comment formats
+
+```
+/** online comment */
+
+/** first line
+ * second line */
+
+/**
+   No *s on middle lines is acceptable too
+   which might be convenient for writing big
+   chunks of text.
+
+ * keeping *s on some lines
+ * would work either
+
+   left bound is dermined by opening marker position
+   and white space will be trimmed as there was '* '
+ */
+
+```
+
+Comments starting with `/***` and `/*` are ignored.
 
 Also you can parse entire file with `parse.file('path/to/file', callback)` or acquire an instance of [Transform](http://nodejs.org/api/stream.html#stream_class_stream_transform) stream with `parse.stream()`.
 
@@ -74,7 +96,7 @@ Also you can parse entire file with `parse.file('path/to/file', callback)` or ac
 
 
 In case you need to parse tags in different way you can pass `opts.parsers = [parser1, ..., parserN]`, where each parser is `function name(str:String, data:Object):{source:String, data:Object}`.
-	
+
 Each parser function takes string left after previous parsers applied and data produced by them. And returns `null` or `{source: '', data:{}}` where `source` is consumed substring and `data` is a payload with tag node fields.
 
 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:
@@ -86,23 +108,23 @@ Tag node data is build by merging result bits from all parsers. Here is some exa
  */
 parse(source, {parsers: [
 	// takes entire string
-	function parse_tag(str, data) { 
-		return {source: ' @tag', data: {tag: 'tag'}}; 
-	}, 
+	function parse_tag(str, data) {
+		return {source: ' @tag', data: {tag: 'tag'}};
+	},
 	// parser throwing exception
 	function check_tag(str, data) {
-		if (allowed_tags.indexOf(data.tag) === -1) { 
+		if (allowed_tags.indexOf(data.tag) === -1) {
 			throw new Error('Unrecognized tag "' + data.tag + '"');
 		}			
 	},
 	// takes the rest of the string after ' @tag''
-	function parse_name1(str, data) { 
-		return {source: ' name', data: {name: 'name1'}}; 
+	function parse_name1(str, data) {
+		return {source: ' name', data: {name: 'name1'}};
 	},
 	// alternative name parser
-	function parse_name2(str, data) { 
-		return {source: ' name', data: {name: 'name2'}}; 
-	}	
+	function parse_name2(str, data) {
+		return {source: ' name', data: {name: 'name2'}};
+	}
 ]});
 ```
 
@@ -134,10 +156,7 @@ This would produce following:
 
 ## Contributors
 
-
-- [Sergii Iavorskyi](https://github.com/yavorskiy)
 - [Alexej Yaroshevich](https://github.com/zxqfox)
+- [Evgeny Reznichenko](https://github.com/zxcabs)
 - [Jordan Harband](https://github.com/ljharb)
-
-
-Happy coding :)
+- [Sergii Iavorskyi](https://github.com/yavorskiy)

package/index.js

@@ -1,64 +1,61 @@
 
-'use strict';
+'use strict'
 
-var fs     = require('fs');
-var stream = require('readable-stream');
-var util   = require('util');
+var fs = require('fs')
+var stream = require('readable-stream')
+var util = require('util')
 
-var parse  = require('./parser.js');
+var parse = require('./parser')
 
-module.exports = parse;
+module.exports = parse
 
 /* ------- Transform stream ------- */
 
-function Parser(opts) {
-  opts = opts || {};
-  stream.Transform.call(this, {objectMode: true});
-  this._extract = parse.mkextract(opts);
+function Parser (opts) {
+  opts = opts || {}
+  stream.Transform.call(this, {objectMode: true})
+  this._extract = parse.mkextract(opts)
 }
 
-util.inherits(Parser, stream.Transform);
+util.inherits(Parser, stream.Transform)
 
-Parser.prototype._transform = function transform(data, encoding, done) {
-
-  var block;
-  var lines = data.toString().split(/\n/);
+Parser.prototype._transform = function transform (data, encoding, done) {
+  var block
+  var lines = data.toString().split(/\n/)
 
   while (lines.length) {
-    block = this._extract(lines.shift());
+    block = this._extract(lines.shift())
     if (block) {
-      this.push(block);
+      this.push(block)
     }
   }
 
-  done();
-};
+  done()
+}
 
-module.exports.stream = function stream(opts) {
-  return new Parser(opts);
-};
+module.exports.stream = function stream (opts) {
+  return new Parser(opts)
+}
 
 /* ------- File parser ------- */
 
-module.exports.file = function file(file_path, done) {
-
-  var opts = {};
-  var collected = [];
+module.exports.file = function file (file_path, done) {
+  var opts = {}
+  var collected = []
 
   if (arguments.length === 3) {
-    opts = done;
-    done = arguments[2];
+    opts = done
+    done = arguments[2]
   }
 
   return fs.createReadStream(file_path, {encoding: 'utf8'})
     .on('error', done)
     .pipe(new Parser(opts))
     .on('error', done)
-    .on('data', function(data) {
-      collected.push(data);
+    .on('data', function (data) {
+      collected.push(data)
     })
     .on('finish', function () {
-      done(null, collected);
-    });
-};
-
+      done(null, collected)
+    })
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "comment-parser",
-  "version": "0.3.1",
+  "version": "0.4.2",
   "description": "Generic JSDoc-like comment parser. ",
   "main": "index.js",
   "directories": {
@@ -11,14 +11,19 @@
   },
   "devDependencies": {
     "chai": "~1.9.0",
-    "jshint": "^2.5.10",
-    "jshint-stylish": "^1.0.0",
-    "mocha": "~1.17.1",
+    "eslint": "^4.7.1",
+    "eslint-config-standard": "^10.2.1",
+    "eslint-plugin-import": "^2.7.0",
+    "eslint-plugin-node": "^5.1.1",
+    "eslint-plugin-promise": "^3.5.0",
+    "eslint-plugin-standard": "^3.0.1",
+    "mocha": "^3.5.3",
     "nodemon": "^1.2.1"
   },
   "scripts": {
-    "test": "jshint --reporter node_modules/jshint-stylish/stylish.js index.js && mocha tests/*",
-    "watch": "nodemon -q -w index.js -w tests/ -x npm test"
+    "pretest": "eslint .",
+    "test": "mocha tests",
+    "watch": "nodemon -q -i node_modules -x npm test"
   },
   "repository": {
     "type": "git",