Security News
ESLint is Now Language-Agnostic: Linting JSON, Markdown, and Beyond
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
babel-extract-comments
Advanced tools
Uses babel (babylon) to extract JavaScript code comments from a JavaScript string or file.
Uses babel (babylon) to extract JavaScript code comments from a JavaScript string or file.
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 babel-extract-comments
Add to your Node.js/JavaScript project with the following line of code:
const extract = require('babel-extract-comments');
Extract code comments from the given string
.
Params
string
{String}: String of javascriptreturns
{Array}: Array of code comment objects.Example
var extract = require('babel-extract-comments');
console.log(extract('// this is a code comment'));
// [{ type: 'CommentBlock',
// value: '!\n * babel-extract-comments <https://github.com/jonschlinkert/babel-extract-comments>\n *\n *
// Copyright (c) 2014-2018, Jon Schlinkert.\n * Released under the MIT License.\n ',
// start: 0,
// end: 173,
// loc: SourceLocation { start: [Position], end: [Position] } }]
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:
Commits | Contributor |
---|---|
4 | jonschlinkert |
1 | eventualbuddha |
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
Uses babel (babylon) to extract JavaScript code comments from a JavaScript string or file.
The npm package babel-extract-comments receives a total of 839,080 weekly downloads. As such, babel-extract-comments popularity was classified as popular.
We found that babel-extract-comments demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer 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.
Security News
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
Security News
Members Hub is conducting large-scale campaigns to artificially boost Discord server metrics, undermining community trust and platform integrity.
Security News
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.