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 :heart: and support.

Install

Install with npm:

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

1const 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

1console.log(extract('// this is a line comment'));
2// [ { type: 'Line',
3//     value: ' this is a line comment',
4//     range: [ 0, 25 ],
5//     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

1console.log(extract.file('some-file.js'), { cwd: 'some/path' });
2// [ { type: 'Line',
3//     value: ' this is a line comment',
4//     range: [ 0, 25 ],
5//     loc: { start: { line: 1, column: 0 }, end: { line: 1, column: 25 } } } ]

About

1$ npm install && npm test

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

• linkedin/in/jonschlinkert
• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2018, Jon Schlinkert. Released under the MIT License.

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