get-comments

Extract javascript comments on per character basis. Comment object compatible with `acorn-extract-comments` and Esprima format.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
get-comments
1231.0.19 years ago9 years agoMinified + gzip package size for get-comments in KB

Readme

Extract javascript comments on per character basis. Comment object compatible with acorn-extract-comments and Esprima format.

Notice: It extracts only first level block comments, not include nested comments.
!code climatecodeclimate-imgcodeclimate-url !standard code stylestandard-imgstandard-url !travis build statustravis-imgtravis-url !coverage statuscoveralls-imgcoveralls-url !dependency statusdavid-imgdavid-url

Install

npm i get-comments --save
npm test

Usage

For more use-cases see the tests

  • <input> {String} string to extract from
  • [resType] {Boolean} if true, will return array, otherwise object
  • return {Array|Object}

Example
var getComments = require('get-comments');

var input = fs.readFileSync('./fixture.js', 'utf8')
var comments = getComments(input, true)
//=>
// [ {
//   "start": 249,
//   "end": 1353,
//   "type": "Block",
//   "loc": {
//     "start": {
//       "line": 12,
//       "column": 0
//     },
//     "end": {
//       "line": 48,
//       "column": 3
//     }
//   },
//   "value": "*\n * > Filtering incoming request ...",
//   "api": true,
//   "after": "module.exports = function koaIpFilter (options) {"
// }, {
//   "start": 2187,
//   "end": 2267,
//   "type": "Block",
//   "loc": {
//     "start": {
//       "line": 82,
//       "column": 0
//     },
//     "end": {
//       "line": 87,
//       "column": 3
//     }
//   },
//   "value": "*\n * abcd description\n *\n * @name koaIpFilter\n * @param {Object} `options`\n ",
//   "api": false,
//   "after": "exports.data = function () {"
// } ]

See also

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
But before doing anything, please read the CONTRIBUTING.md guidelines.

Charlike Make Reagent !new message to charlikenew-message-imgnew-message-url !freenode #charlikefreenode-imgfreenode-url

!tunnckocore.tkauthor-www-imgauthor-www-url !keybase tunnckocorekeybase-imgkeybase-url !tunnckoCore npmauthor-npm-imgauthor-npm-url !tunnckoCore twitterauthor-twitter-imgauthor-twitter-url !tunnckoCore githubauthor-github-imgauthor-github-url