https://github.com/jonschlinkert/esprima-extract-comments
Extract javascript code comments with esprima. Thin wrapper to prove a simple interface for getting code comments from a string, file or glob of files.
https://github.com/jonschlinkert/esprima-extract-comments
ast comments esprima extract javascript nodejs parse
Last synced: 2 months ago
JSON representation
Extract javascript code comments with esprima. Thin wrapper to prove a simple interface for getting code comments from a string, file or glob of files.
- Host: GitHub
- URL: https://github.com/jonschlinkert/esprima-extract-comments
- Owner: jonschlinkert
- License: mit
- Created: 2014-09-24T07:01:44.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2018-02-12T11:21:57.000Z (over 7 years ago)
- Last Synced: 2025-07-11T22:47:52.745Z (3 months ago)
- Topics: ast, comments, esprima, extract, javascript, nodejs, parse
- Language: JavaScript
- Size: 290 KB
- Stars: 14
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# esprima-extract-comments [](https://www.npmjs.com/package/esprima-extract-comments) [](https://npmjs.org/package/esprima-extract-comments) [](https://npmjs.org/package/esprima-extract-comments) [](https://travis-ci.org/jonschlinkert/esprima-extract-comments)
> Extract code comments from string or from a glob of files using esprima.
Please consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install --save esprima-extract-comments
```
## Breaking changes in v1.0.0!
* line `comment.type` was changed from `line` to `LineComment`
* block `comment.type` was changed from `block` to `BlockComment`
## Usage
Add to your Node.js/JavaScript project with the following line of code:
```js
const extract = require('esprima-extract-comments');
```
## API
### [extract](index.js#L30)
Extract line and block comments from a string of JavaScript.
**Params**
* `string` **{String}**
* `options` **{Object}**: Options to pass to [esprima](http://esprima.org).
* `returns` **{Array}**: Array of code comment objects.
**Example**
```js
console.log(extract('// this is a line comment'));
// [ { type: 'Line',
// value: ' this is a line comment',
// range: [ 0, 25 ],
// loc: { start: { line: 1, column: 0 }, end: { line: 1, column: 25 } } } ]
```
### [.file](index.js#L52)
Extract code comments from a JavaScript file.
**Params**
* `file` **{String}**: Filepath to the file to parse.
* `options` **{Object}**: Options to pass to [esprima](http://esprima.org).
* `returns` **{Array}**: Array of code comment objects.
**Example**
```js
console.log(extract.file('some-file.js'), { cwd: 'some/path' });
// [ { type: 'Line',
// value: ' this is a line comment',
// range: [ 0, 25 ],
// loc: { start: { line: 1, column: 0 }, end: { line: 1, column: 25 } } } ]
```
## About
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
Running Tests
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
```sh
$ npm install && npm test
```
Building docs
_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
To generate the readme, run the following command:
```sh
$ npm install -g verbose/verb#dev verb-generate-readme && verb
```
### Related projects
You might also be interested in these projects:
* [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://github.com/jonschlinkert/extract-comments) | [homepage](https://github.com/jonschlinkert/extract-comments "Uses esprima to extract line and block comments from a string of JavaScript. Also optionally parses code context (the next line of code after a comment).")
* [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 JavaScript code comments and generate API documentation.")
* [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 "Parse code comments from JavaScript or any language that uses the same format.")
### Author
**Jon Schlinkert**
* [linkedin/in/jonschlinkert](https://linkedin.com/in/jonschlinkert)
* [github/jonschlinkert](https://github.com/jonschlinkert)
* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
### License
Copyright © 2018, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT License](LICENSE).
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on February 12, 2018._