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, and consider starring the project to show your ❤️ and support.

Install

Install with npm:

$ 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:

const extract = require('esprima-extract-comments');

API

extract

Extract line and block comments from a string of JavaScript.

Params

string {String}
options {Object}: Options to pass to esprima.
returns {Array}: Array of code comment objects.

Example

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

Extract code comments from a JavaScript file.

Params

file {String}: Filepath to the file to parse.
options {Object}: Options to pass to esprima.
returns {Array}: Array of code comment objects.

Example

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.

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:

$ npm install && npm test

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Related projects

You might also be interested in these projects:

extract-comments: Uses esprima to extract line and block comments from a string of JavaScript. Also optionally… more | homepage
js-comments: Parse JavaScript code comments and generate API documentation. | homepage
parse-comments: Parse code comments from JavaScript or any language that uses the same format. | homepage

Author

Jon Schlinkert

License

This file was generated by verb-generate-readme, v0.6.0, on February 12, 2018.