https://github.com/jonschlinkert/espree-extract-comments
Uses espree to extract JavaScript code comments from a string. Returns an array of comment objects, with line, column, index, comment type and comment string.
https://github.com/jonschlinkert/espree-extract-comments
comments espree esprima extract extract-comments javascript jonschlinkert nodejs parse
Last synced: 6 months ago
JSON representation
Uses espree to extract JavaScript code comments from a string. Returns an array of comment objects, with line, column, index, comment type and comment string.
- Host: GitHub
- URL: https://github.com/jonschlinkert/espree-extract-comments
- Owner: jonschlinkert
- License: mit
- Created: 2015-12-30T18:56:40.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2015-12-30T19:00:44.000Z (almost 10 years ago)
- Last Synced: 2025-02-06T09:49:07.505Z (8 months ago)
- Topics: comments, espree, esprima, extract, extract-comments, javascript, jonschlinkert, nodejs, parse
- Language: JavaScript
- Size: 5.86 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# espree-extract-comments [](https://www.npmjs.com/package/espree-extract-comments) [](https://travis-ci.org/jonschlinkert/espree-extract-comments)
> Uses espree to extract JavaScript code comments from a string. Returns an array of comment objects, with line, column, index, comment type and comment string.
- [Install](#install)
- [API](#api)
- [Example results](#example-results)
- [Related projects](#related-projects)
- [Running tests](#running-tests)
- [Contributing](#contributing)
- [Author](#author)
- [License](#license)
_(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc))_
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm i espree-extract-comments --save
```
## API
**Params**
* `string` **{String}**
* `options` **{Object}**: Options to pass to espree.
* `returns` **{Object}**: Object of code comments.
**Example**
```js
var extract = require('espree-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 ',
range: [ 15, 112 ],
loc: {
start: { line: 3, column: 0 },
end: { line: 8, column: 3 } }
}]
```
## Related projects
* [esprima-extract-comments](https://www.npmjs.com/package/esprima-extract-comments): Extract code comments from string or from a glob of files using esprima. | [homepage](https://github.com/jonschlinkert/esprima-extract-comments)
* [extract-comments](https://www.npmjs.com/package/extract-comments): Uses esprima to extract line and block comments from a string of JavaScript. Also optionally… [more](https://www.npmjs.com/package/extract-comments) | [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/espree-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._