esprima-extract-comments

Extract code comments from string or from a glob of files using esprima.

Install

Install with npm:

$ npm i esprima-extract-comments --save

API

Params

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

Example

var extract = require('esprima-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 ',
  loc: {
    start: {line: 3, column: 0 },
    end: {line: 8, column: 3 }
  }
}, {
  type: 'Block',
  value: '*\n * Set `key` on cache with the given `value`
    \n *\n * @param {String} `key`\n * @param {any} 
    `value`\n * @api public\n ',
  loc: {
    start: {line: 15, column: 0 },
    end: {line: 21, column: 3 }
  }
}, {
  type: 'Block',
  value: '*\n * Get `key` from cache.\n *\n * @param 
    {String} `key`\n * @api public\n ',
  loc: {
    start: {line: 25, column: 0 },
    end: {line: 30, column: 3 }
  }
}, {
  type: 'Block',
  value: '*\n * Delete `key` from cache\n *\n * 
    @param {String} `key`\n * @param {any} value\n * 
    @api public\n ',
  loc: {
    start: {line: 34, column: 0 },
    end: {line: 40, column: 3 }
  }
}]

Related projects

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

README.md 2.9 KB Riwayat Mentahan