Extract code comments from string or from a glob of files using esprima.
npm install 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 with npm:
``sh`
$ npm install --save esprima-extract-comments
* line comment.type was changed from line to LineComment
* block was changed from block to BlockComment
Add to your Node.js/JavaScript project with the following line of code:
`js`
const extract = require('esprima-extract-comments');
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
`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 } } } ]
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
`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 } } } ]
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:
`sh`
$ 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:
`sh``
$ npm install -g verbose/verb#dev verb-generate-readme && verb
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
Jon Schlinkert
* linkedin/in/jonschlinkert
* github/jonschlinkert
* twitter/jonschlinkert
Copyright © 2018, Jon Schlinkert.
Released under the MIT License.
*
_This file was generated by verb-generate-readme, v0.6.0, on February 12, 2018._