Neolithic Prancing Minotaurs

    espree-extract-comments

    0.1.0 • Public • Published

    espree-extract-comments NPM version Build Status

    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.

    (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

    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

    Copyright © 2015 Jon Schlinkert Released under the MIT license.


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

    Install

    npm i espree-extract-comments

    DownloadsWeekly Downloads

    6

    Version

    0.1.0

    License

    MIT

    Last publish

    Collaborators

    • jonschlinkert