espree-extract-comments

espree-extract-comments

Uses espree 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
• Example results
• Related projects
• Running tests
• Contributing
• Author
• License

(TOC generated by verb using markdown-toc)

Install

Install with npm:

$ npm i espree-extract-comments --save

API

Params

• string {String}
• options {Object}: Options to pass to espree.
• returns {Object}: Object of code comments.

Example

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

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 } } 
}]

Related 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

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

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2015 Jon Schlinkert Released under the MIT license.

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