v0.4.0

- no longer uses esprima because of how slow it was
- comment key is now the line number
- strings are now parsed by default
- `.fromFile()` must be used to parse files/globs

Author: jonschlinkert

.verbrc.md

@@ -5,7 +5,7 @@ tags: ['verb-tag-jscomments']
 > {%= description %}
 
 ## Install
-{%= include("install") %}
+{%= include("install", {save: true}) %}
 
 ## Run tests
 
@@ -81,4 +81,10 @@ Or when `extract.fromString()` is used:
 
 ***
 
-{%= include("footer") %}
+{%= include("footer") %}
+
+
+
+[globby]: https://github.com/sindresorhus/globby
+[esprima]: https://github.com/ariya/esprima
+[map-files]: https://github.com/jonschlinkert/map-files

README.md

@@ -18,34 +18,33 @@ npm test
 ```
 
 ## API
-### [extract](index.js#L32)
+### [extract](index.js#L31)
 
-Extract code comments from a glob of files:
+Extract code comments from the given `string`.
 
-* `patterns` **{String}**: Glob patterns to used.    
-* `options` **{Object}**: Options to pass to [esprima] or [globby], or [map-files].    
+* `string` **{String}**    
 * `returns` **{Object}**: Object of code comments.  
 
 **Example:**
 
 ```js
 var extract = require('extract-comments');
-extract('lib/*.js');
+extract('// this is a code comment');
 ```
 
-### [.fromString](index.js#L62)
+### [.fromFiles](index.js#L74)
 
-Extract code comments from the given `string`.
+Extract code comments from a file or glob of files:
 
-* `string` **{String}**    
-* `options` **{Object}**: Options to pass to esprima.    
+* `patterns` **{String}**: Glob patterns to used.    
+* `options` **{Object}**: Options to pass to [globby], or [map-files].    
 * `returns` **{Object}**: Object of code comments.  
 
 **Example:**
 
 ```js
 var extract = require('extract-comments');
-extract.fromString('// this is a code comment');
+extract.fromFiles(['lib/*.js']);
 ```
 
 You may also pass a custom `rename` function on the options to change the key of each object returned. See [map-files](https://github.com/jonschlinkert/map-files) for more details and available options.
@@ -115,4 +114,10 @@ Released under the MIT license
 
 ***
 
-_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on September 20, 2014._
+_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on September 24, 2014._
+
+
+
+[globby]: https://github.com/sindresorhus/globby
+[esprima]: https://github.com/ariya/esprima
+[map-files]: https://github.com/jonschlinkert/map-files

index.js

@@ -8,60 +8,79 @@
 'use strict';
 
 var fs = require('fs');
-var esprima = require('esprima');
 var mapFiles = require('map-files');
-var _ = require('lodash');
+var lineCount = require('line-count');
+var extend = require('mixin-deep');
 
 
 /**
- * Extract code comments from a glob of files:
+ * Extract code comments from the given `string`.
  *
  * **Example:**
  *
  * ```js
  * var extract = require('extract-comments');
- * extract('lib/*.js');
+ * extract('// this is a code comment');
  * ```
  *
- * @param  {String} `patterns` Glob patterns to used.
- * @param  {Object} `options` Options to pass to [esprima] or [globby], or [map-files].
+ * @param  {String} `string`
  * @return {Object} Object of code comments.
  * @api public
  */
 
-function extract(patterns, options) {
-  return mapFiles(patterns, _.extend({
-    // noop for mapFiles
-    rename: function(filepath) {
-      return filepath;
-    },
-    parse: function (filepath, options) {
-      var code = fs.readFileSync(filepath, 'utf8');
-      return extract.fromString(code, options);
-    }
-  }, options));
+function extract(str) {
+  var match, o = {};
+  var line = 1;
+
+  while (match = (/\/\*{1,2}[^\*!]([\s\S]*?)\*\//g).exec(str)) {
+    var start = str;
+
+    // add lines from before the comment
+    line += lineCount(start.substr(0, match.index)) - 1;
+
+    // Update the string
+    str = str.substr(match.index + match[1].length);
+
+    o[line] = {
+      type: 'comment',
+      comment: match[1],
+      begin: line,
+      end: line + lineCount(match[1]) - 1
+    };
+
+    // add lines from the comment itself
+    line += lineCount(start.substr(match.index, match[1].length)) - 1;
+  }
+  return o;
 }
 
 
 /**
- * Extract code comments from the given `string`.
+ * Extract code comments from a file or glob of files:
  *
  * **Example:**
  *
  * ```js
  * var extract = require('extract-comments');
- * extract.fromString('// this is a code comment');
+ * extract.fromFiles(['lib/*.js']);
  * ```
  *
- * @param  {String} `string`
- * @param  {Object} `options` Options to pass to esprima.
+ * @param  {String} `patterns` Glob patterns to used.
+ * @param  {Object} `options` Options to pass to [globby], or [map-files].
  * @return {Object} Object of code comments.
  * @api public
  */
 
-extract.fromString = function(string, options) {
-  var opts = _.extend({comment: true, loc: true }, options);
-  return esprima.parse(string, opts).comments;
+extract.fromFiles = function(patterns, options) {
+  return mapFiles(patterns, extend({
+    rename: function(filepath) {
+      return filepath;
+    },
+    parse: function (filepath, options) {
+      var code = fs.readFileSync(filepath, 'utf8');
+      return extract(code, options);
+    }
+  }, options));
 };
 
 

package.json

@@ -1,7 +1,7 @@
 {
   "name": "extract-comments",
   "description": "Extract code comments from string or from a glob of files.",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "homepage": "https://github.com/jonschlinkert/extract-comments",
   "author": {
     "name": "Jon Schlinkert",
@@ -23,6 +23,9 @@
   "keywords": [
     "code",
     "parse",
+    "javascript",
+    "block",
+    "context",
     "comments",
     "comment",
     "extract",
@@ -43,7 +46,8 @@
     "verb-tag-jscomments": "^0.2.2"
   },
   "dependencies": {
-    "esprima": "git+https://git@github.com/ariya/esprima",
+    "mixin-deep": "^0.1.0",
+    "line-count": "^0.1.0",
     "lodash": "^2.4.1",
     "map-files": "^0.1.1"
   }