babel-extract-comments

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 ❤️ and support.

Install

Install with npm:

$ npm install --save babel-extract-comments

Usage

Add to your Node.js/JavaScript project with the following line of code:

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

API

extract

Extract code comments from the given string.

Params

• string {String}: String of javascript
• returns {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] } }]

.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

$ npm install && npm test

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

Related projects

You might also be interested in these projects:

• esprima-extract-comments: Extract code comments from string or from a glob of files using esprima. | homepage
• 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

Contributors

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.