esprima-extract-comments
Advanced tools
Extract code comments from string or from a glob of files using esprima.
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:
$ npm install --save esprima-extract-comments
comment.type was changed from line to LineCommentcomment.type was changed from block to BlockCommentAdd to your Node.js/JavaScript project with the following line of code:
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
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
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 } } } ]
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
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
(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
You might also be interested in these projects:
Jon Schlinkert
Copyright © 2018, Jon Schlinkert. Released under the MIT License.
This file was generated by verb-generate-readme, v0.6.0, on February 12, 2018.
FAQs
Extract code comments from string or from a glob of files using esprima.
We found that esprima-extract-comments demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
The Socket Research Team has discovered six new malicious npm packages linked to North Korea’s Lazarus Group, designed to steal credentials and deploy backdoors.
Security News
Socket CEO Feross Aboukhadijeh discusses the open web, open source security, and how Socket tackles software supply chain attacks on The Pair Program podcast.
Security News
Opengrep continues building momentum with the alpha release of its Playground tool, demonstrating the project's rapid evolution just two months after its initial launch.