Package Exports

babel-extract-comments

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (babel-extract-comments) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

babel-extract-comments

Uses babel to extract JavaScript code comments from a string. Returns an array of comment objects, with line, column, index, comment type and comment string.

Install
API
- Transform function
Example results
Related projects
Running tests
Contributing
Author
License

(TOC generated by verb using markdown-toc)

Install

Install with npm:

$ npm i babel-extract-comments --save

API

Params

string {String}: String of javascript
fn {Function}: Optional. Functionto transform commend objects (AST tokens)
returns {Object}: Object of code comments.

Example

var extract = require('babel-extract-comments');
extract('// this is a code comment');

Transform function

Optionally pass a function as the second argument to transform comment objects.

var comments = extract(javascriptString, function(comment) {
  comment.foo = 'bar';
});
console.log(comments[0].foo);
//=> 'bar';

Example results

See fixtures/app.js to see the code comments used to generate the following:

[{ type: 'Block',
  value: '*\n * Create an instance of App with `options`.\n *\n * @param {Object} options\n * @api public\n ',
  range: [ 15, 112 ],
  loc: { 
    start: { line: 3, column: 0 }, 
    end: { line: 8, column: 3 } } 
}]

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

Running tests

Install dev dependencies:

$ npm i -d && npm test

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Author

Jon Schlinkert

License

This file was generated by verb on December 30, 2015.