# esprima-extract-comments [![NPM version](https://img.shields.io/npm/v/esprima-extract-comments.svg)](https://www.npmjs.com/package/esprima-extract-comments) [![Build Status](https://img.shields.io/travis/jonschlinkert/esprima-extract-comments.svg)](https://travis-ci.org/jonschlinkert/esprima-extract-comments)

> Extract code comments from string or from a glob of files using esprima.

## Install

Install with [npm](https://www.npmjs.com/):

```sh
$ npm i esprima-extract-comments --save
```

## API

**Params**

* `string` **{String}**
* `options` **{Object}**: Options to pass to esprima.
* `returns` **{Object}**: Object of code comments.

**Example**

```js
var extract = require('esprima-extract-comments');
extract('// this is a code comment');
```

## Example results

See [fixtures/app.js](./fixtures/app.js) to see the code comments used to generate the following:

```js
[{
  type: 'Block',
  value: '*\n * Create an instance of App with `options`
    .\n *\n * @param {Object} options\n * @api public\n ',
  loc: {
    start: {line: 3, column: 0 },
    end: {line: 8, column: 3 }
  }
}, {
  type: 'Block',
  value: '*\n * Set `key` on cache with the given `value`
    \n *\n * @param {String} `key`\n * @param {any} 
    `value`\n * @api public\n ',
  loc: {
    start: {line: 15, column: 0 },
    end: {line: 21, column: 3 }
  }
}, {
  type: 'Block',
  value: '*\n * Get `key` from cache.\n *\n * @param 
    {String} `key`\n * @api public\n ',
  loc: {
    start: {line: 25, column: 0 },
    end: {line: 30, column: 3 }
  }
}, {
  type: 'Block',
  value: '*\n * Delete `key` from cache\n *\n * 
    @param {String} `key`\n * @param {any} value\n * 
    @api public\n ',
  loc: {
    start: {line: 34, column: 0 },
    end: {line: 40, column: 3 }
  }
}]
```

## Related projects

* [extract-comments](https://www.npmjs.com/package/extract-comments): Extract code comments from string or from a glob of files. | [homepage](https://github.com/jonschlinkert/extract-comments)
* [js-comments](https://www.npmjs.com/package/js-comments): Parse JavaScript code comments and generate API documentation. | [homepage](https://github.com/jonschlinkert/js-comments)
* [parse-comments](https://www.npmjs.com/package/parse-comments): Parse code comments from JavaScript or any language that uses the same format. | [homepage](https://github.com/jonschlinkert/parse-comments)

## Running tests

Install dev dependencies:

```sh
$ npm i -d && npm test
```

## Contributing

Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/esprima-extract-comments/issues/new).

## Author

**Jon Schlinkert**

* [github/jonschlinkert](https://github.com/jonschlinkert)
* [twitter/jonschlinkert](http://twitter.com/jonschlinkert)

## License

Copyright © 2015 [Jon Schlinkert](https://github.com/jonschlinkert)
Released under the MIT license.

***

_This file was generated by [verb](https://github.com/verbose/verb) on December 30, 2015._