{"_id":"parse-comments","_rev":"88852","name":"parse-comments","description":"Parse code comments from JavaScript or any language that uses the same format.","dist-tags":{"latest":"1.0.0"},"maintainers":[{"name":"doowb","email":"brian.woodward@gmail.com"},{"name":"jonschlinkert","email":"github@sellside.com"}],"time":{"modified":"2021-06-03T10:28:54.000Z","created":"2014-08-09T16:31:43.724Z","1.0.0":"2018-11-24T10:59:59.061Z","0.4.3":"2015-09-28T20:09:17.589Z","0.4.2":"2015-09-28T20:07:29.331Z","0.4.1":"2015-04-17T04:42:09.415Z","0.4.0":"2015-04-02T13:59:24.930Z","0.3.4":"2015-03-29T09:23:23.459Z","0.3.3":"2014-10-11T23:01:56.025Z","0.3.2":"2014-08-27T19:29:32.912Z","0.3.1":"2014-08-25T11:19:11.278Z","0.3.0":"2014-08-25T10:23:36.792Z","0.2.0":"2014-08-23T11:23:52.007Z","0.1.2":"2014-08-09T20:28:46.003Z","0.1.1":"2014-08-09T16:31:43.724Z"},"users":{"fgribreau":true,"pandao":true,"dougpuob":true},"author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git+https://github.com/jonschlinkert/parse-comments.git"},"versions":{"1.0.0":{"name":"parse-comments","description":"Parse code comments from JavaScript or any language that uses the same format.","version":"1.0.0","homepage":"https://github.com/jonschlinkert/parse-comments","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"contributors":[{"name":"Brian Woodward","url":"https://twitter.com/doowb"},{"name":"Jon Schlinkert","url":"http://twitter.com/jonschlinkert"}],"repository":{"type":"git","url":"git+https://github.com/jonschlinkert/parse-comments.git"},"bugs":{"url":"https://github.com/jonschlinkert/parse-comments/issues"},"license":"MIT","main":"index.js","engines":{"node":">=8"},"scripts":{"test":"mocha"},"dependencies":{"extract-comments":"^1.1.0","floating-point-regex":"^0.1.0","get-value":"^3.0.1","inflection":"^1.12.0","map-schema":"^0.2.4","snapdragon-node":"^3.0.0","snapdragon-parser":"^1.0.0","tokenize-comment":"^3.0.1"},"devDependencies":{"ansi":"^0.3.1","benchmark":"^2.1.4","catharsis":"^0.8.9","doctrine":"^3.0.0","gulp-format-md":"^2.0.0","mocha":"^5.2.0","object.pick":"^1.3.0"},"keywords":["code","comments","parse"],"verb":{"toc":false,"layout":"default","tasks":["readme"],"plugins":["gulp-format-md"],"lint":{"reflinks":true}},"gitHead":"71d2346fb5a543dc82a1dc10c8ab3ab7c045fced","_id":"parse-comments@1.0.0","_npmVersion":"6.4.1","_nodeVersion":"11.1.0","_npmUser":{"name":"jonschlinkert","email":"github@sellside.com"},"dist":{"shasum":"6cb0962dd429b7db0f9aead5c33a58caa663f973","size":20224,"noattachment":false,"key":"/parse-comments/-/parse-comments-1.0.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/parse-comments/download/parse-comments-1.0.0.tgz"},"maintainers":[{"name":"doowb","email":"brian.woodward@gmail.com"},{"name":"jonschlinkert","email":"github@sellside.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/parse-comments_1.0.0_1543057198935_0.04574621443633253"},"_hasShrinkwrap":false,"publish_time":1543057199061,"_cnpm_publish_time":1543057199061},"0.4.3":{"name":"parse-comments","description":"Parse code comments from JavaScript or any language that uses the same format.","version":"0.4.3","homepage":"https://github.com/jonschlinkert/parse-comments","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git://github.com/jonschlinkert/parse-comments.git"},"bugs":{"url":"https://github.com/jonschlinkert/parse-comments/issues"},"license":{"type":"MIT","url":"https://github.com/jonschlinkert/parse-comments/blob/master/LICENSE"},"files":["index.js","lib/"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha"},"dependencies":{"arrayify-compact":"^0.1.0","extract-comments":"^0.7.3","gfm-code-blocks":"^0.2.0","inflection":"^1.7.0","lodash":"^3.6.0","parse-code-context":"^0.1.3"},"devDependencies":{"mocha":"^2.2.1","should":"^5.2.0"},"keywords":["parse","code","comments"],"gitHead":"55248e756fc1454e614dc9255e44c364819694bd","_id":"parse-comments@0.4.3","_shasum":"68c955f1ec9b655a4f241b1124c79db1310d67bd","_from":".","_npmVersion":"2.13.3","_nodeVersion":"0.12.0","_npmUser":{"name":"doowb","email":"brian.woodward@gmail.com"},"dist":{"shasum":"68c955f1ec9b655a4f241b1124c79db1310d67bd","size":5880,"noattachment":false,"key":"/parse-comments/-/parse-comments-0.4.3.tgz","tarball":"http://registry.cnpm.dingdandao.com/parse-comments/download/parse-comments-0.4.3.tgz"},"maintainers":[{"name":"doowb","email":"brian.woodward@gmail.com"},{"name":"jonschlinkert","email":"github@sellside.com"}],"directories":{},"publish_time":1443470957589,"_cnpm_publish_time":1443470957589,"_hasShrinkwrap":false},"0.4.2":{"name":"parse-comments","description":"Parse code comments from JavaScript or any language that uses the same format.","version":"0.4.2","homepage":"https://github.com/jonschlinkert/parse-comments","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git://github.com/jonschlinkert/parse-comments.git"},"bugs":{"url":"https://github.com/jonschlinkert/parse-comments/issues"},"license":{"type":"MIT","url":"https://github.com/jonschlinkert/parse-comments/blob/master/LICENSE"},"files":["index.js","lib/"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha"},"dependencies":{"arrayify-compact":"^0.1.0","extract-comments":"^0.7.3","gfm-code-blocks":"^0.2.0","inflection":"^1.7.0","lodash":"^3.6.0","parse-code-context":"^0.1.3"},"devDependencies":{"mocha":"^2.2.1","should":"^5.2.0"},"keywords":["parse","code","comments"],"gitHead":"00129abfa322db0ef4a4800c8ffbec69903f97ec","_id":"parse-comments@0.4.2","_shasum":"5752ca80d2695ee3df7f8b1615bc3d224b420f38","_from":".","_npmVersion":"2.13.3","_nodeVersion":"0.12.0","_npmUser":{"name":"doowb","email":"brian.woodward@gmail.com"},"dist":{"shasum":"5752ca80d2695ee3df7f8b1615bc3d224b420f38","size":5880,"noattachment":false,"key":"/parse-comments/-/parse-comments-0.4.2.tgz","tarball":"http://registry.cnpm.dingdandao.com/parse-comments/download/parse-comments-0.4.2.tgz"},"maintainers":[{"name":"doowb","email":"brian.woodward@gmail.com"},{"name":"jonschlinkert","email":"github@sellside.com"}],"directories":{},"publish_time":1443470849331,"_cnpm_publish_time":1443470849331,"_hasShrinkwrap":false},"0.4.1":{"name":"parse-comments","description":"Parse code comments from JavaScript or any language that uses the same format.","version":"0.4.1","homepage":"https://github.com/jonschlinkert/parse-comments","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git://github.com/jonschlinkert/parse-comments.git"},"bugs":{"url":"https://github.com/jonschlinkert/parse-comments/issues"},"license":{"type":"MIT","url":"https://github.com/jonschlinkert/parse-comments/blob/master/LICENSE"},"files":["index.js","lib/"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha"},"dependencies":{"arrayify-compact":"^0.1.0","extract-comments":"^0.7.3","gfm-code-blocks":"^0.2.0","inflection":"^1.7.0","parse-code-context":"^0.1.3"},"devDependencies":{"lodash":"^3.6.0","mocha":"^2.2.1","should":"^5.2.0"},"keywords":["parse","code","comments"],"gitHead":"fe73af902a778f3fdb326557a8bf277e475545dc","_id":"parse-comments@0.4.1","_shasum":"265ef51913f5e99725454b53141b260455150e48","_from":".","_npmVersion":"2.5.1","_nodeVersion":"0.12.0","_npmUser":{"name":"jonschlinkert","email":"github@sellside.com"},"maintainers":[{"name":"doowb","email":"brian.woodward@gmail.com"},{"name":"jonschlinkert","email":"github@sellside.com"}],"dist":{"shasum":"265ef51913f5e99725454b53141b260455150e48","size":5892,"noattachment":false,"key":"/parse-comments/-/parse-comments-0.4.1.tgz","tarball":"http://registry.cnpm.dingdandao.com/parse-comments/download/parse-comments-0.4.1.tgz"},"directories":{},"publish_time":1429245729415,"_cnpm_publish_time":1429245729415,"_hasShrinkwrap":false},"0.4.0":{"name":"parse-comments","description":"Parse code comments from JavaScript or any language that uses the same format.","version":"0.4.0","homepage":"https://github.com/jonschlinkert/parse-comments","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git://github.com/jonschlinkert/parse-comments.git"},"bugs":{"url":"https://github.com/jonschlinkert/parse-comments/issues"},"license":{"type":"MIT","url":"https://github.com/jonschlinkert/parse-comments/blob/master/LICENSE"},"files":["index.js","lib/"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha"},"dependencies":{"arrayify-compact":"^0.1.0","extract-comments":"^0.7.3","gfm-code-blocks":"^0.2.0","inflection":"^1.7.0","parse-code-context":"^0.1.3"},"devDependencies":{"lodash":"^3.6.0","mocha":"^2.2.1","should":"^5.2.0"},"keywords":["parse","code","comments"],"gitHead":"e37865999460616e7817cff885345a40bb85ab6d","_id":"parse-comments@0.4.0","_shasum":"ff4ab4620638c712114afceed338a109d67599ab","_from":".","_npmVersion":"2.5.1","_nodeVersion":"0.12.0","_npmUser":{"name":"jonschlinkert","email":"github@sellside.com"},"maintainers":[{"name":"doowb","email":"brian.woodward@gmail.com"},{"name":"jonschlinkert","email":"github@sellside.com"}],"dist":{"shasum":"ff4ab4620638c712114afceed338a109d67599ab","size":5866,"noattachment":false,"key":"/parse-comments/-/parse-comments-0.4.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/parse-comments/download/parse-comments-0.4.0.tgz"},"directories":{},"publish_time":1427983164930,"_cnpm_publish_time":1427983164930,"_hasShrinkwrap":false},"0.3.4":{"name":"parse-comments","description":"Parse code comments from JavaScript or any language that uses the same format.","version":"0.3.4","homepage":"https://github.com/jonschlinkert/parse-comments","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git://github.com/jonschlinkert/parse-comments.git"},"bugs":{"url":"https://github.com/jonschlinkert/parse-comments/issues"},"license":{"type":"MIT","url":"https://github.com/jonschlinkert/parse-comments/blob/master/LICENSE"},"files":["index.js","lib/"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha"},"dependencies":{"arrayify-compact":"^0.1.0","code-context":"^0.2.3","gfm-code-blocks":"^0.2.0","inflection":"^1.7.0"},"devDependencies":{"lodash":"^2.4.1","mocha":"*","should":"^4.0.4","test-helpers":"^0.1.4"},"keywords":["parse","code","comments"],"gitHead":"8407654af4367b618d7742bd51aab8e6b5150aad","_id":"parse-comments@0.3.4","_shasum":"a39d35668d3229d27f09d1b05a130e8e8e30311b","_from":".","_npmVersion":"2.5.1","_nodeVersion":"0.12.0","_npmUser":{"name":"jonschlinkert","email":"github@sellside.com"},"maintainers":[{"name":"doowb","email":"brian.woodward@gmail.com"},{"name":"jonschlinkert","email":"github@sellside.com"}],"dist":{"shasum":"a39d35668d3229d27f09d1b05a130e8e8e30311b","size":4904,"noattachment":false,"key":"/parse-comments/-/parse-comments-0.3.4.tgz","tarball":"http://registry.cnpm.dingdandao.com/parse-comments/download/parse-comments-0.3.4.tgz"},"directories":{},"publish_time":1427621003459,"_cnpm_publish_time":1427621003459,"_hasShrinkwrap":false},"0.3.3":{"name":"parse-comments","description":"Parse code comments from JavaScript or any language that uses the same format.","version":"0.3.3","homepage":"https://github.com/jonschlinkert/parse-comments","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git://github.com/jonschlinkert/parse-comments.git"},"bugs":{"url":"https://github.com/jonschlinkert/parse-comments/issues"},"licenses":[{"type":"MIT","url":"https://github.com/jonschlinkert/parse-comments/blob/master/LICENSE-MIT"}],"keywords":["parse","code","comments"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha -R spec"},"devDependencies":{"lodash":"^2.4.1","mocha":"*","should":"^4.0.4","test-helpers":"^0.1.4","verb":">= 0.2.6","verb-tag-jscomments":"^0.2.2"},"dependencies":{"arrayify-compact":"^0.1.0","code-context":"^0.2.3","gfm-code-blocks":"^0.2.0","inflection":"^1.4.0"},"_id":"parse-comments@0.3.3","_shasum":"b7ed331812575555f3c3b224f4ac9b24b2b47089","_from":".","_npmVersion":"1.4.9","_npmUser":{"name":"jonschlinkert","email":"github@sellside.com"},"maintainers":[{"name":"doowb","email":"brian.woodward@gmail.com"},{"name":"jonschlinkert","email":"github@sellside.com"}],"dist":{"shasum":"b7ed331812575555f3c3b224f4ac9b24b2b47089","size":27012,"noattachment":false,"key":"/parse-comments/-/parse-comments-0.3.3.tgz","tarball":"http://registry.cnpm.dingdandao.com/parse-comments/download/parse-comments-0.3.3.tgz"},"directories":{},"publish_time":1413068516025,"_cnpm_publish_time":1413068516025,"_hasShrinkwrap":false},"0.3.2":{"name":"parse-comments","description":"Parse code comments from JavaScript or any language that uses the same format.","version":"0.3.2","homepage":"https://github.com/jonschlinkert/parse-comments","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git://github.com/jonschlinkert/parse-comments.git"},"bugs":{"url":"https://github.com/jonschlinkert/parse-comments/issues"},"licenses":[{"type":"MIT","url":"https://github.com/jonschlinkert/parse-comments/blob/master/LICENSE-MIT"}],"keywords":["parse","code","comments"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha -R spec"},"devDependencies":{"fs-utils":"^0.4.3","lodash":"^2.4.1","mocha":"*","should":"^4.0.4","test-helpers":"^0.1.4","verb":">= 0.2.6","verb-tag-jscomments":"^0.2.2"},"dependencies":{"arrayify-compact":"^0.1.0","code-context":"^0.2.1","gfm-code-blocks":"^0.1.0","inflection":"^1.4.0"},"_id":"parse-comments@0.3.2","_shasum":"1d4236120bc6da5d6801aa12f5c7078ef96bae2f","_from":".","_npmVersion":"1.4.9","_npmUser":{"name":"jonschlinkert","email":"github@sellside.com"},"maintainers":[{"name":"doowb","email":"brian.woodward@gmail.com"},{"name":"jonschlinkert","email":"github@sellside.com"}],"dist":{"shasum":"1d4236120bc6da5d6801aa12f5c7078ef96bae2f","size":27021,"noattachment":false,"key":"/parse-comments/-/parse-comments-0.3.2.tgz","tarball":"http://registry.cnpm.dingdandao.com/parse-comments/download/parse-comments-0.3.2.tgz"},"directories":{},"publish_time":1409167772912,"_cnpm_publish_time":1409167772912,"_hasShrinkwrap":false},"0.3.1":{"name":"parse-comments","description":"Parse code comments from JavaScript or any language that uses the same format.","version":"0.3.1","homepage":"https://github.com/jonschlinkert/parse-comments","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git://github.com/jonschlinkert/parse-comments.git"},"bugs":{"url":"https://github.com/jonschlinkert/parse-comments/issues"},"licenses":[{"type":"MIT","url":"https://github.com/jonschlinkert/parse-comments/blob/master/LICENSE-MIT"}],"keywords":["docs","documentation","generate","generator","markdown","templates","verb"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha -R spec"},"devDependencies":{"fs-utils":"^0.4.3","lodash":"^2.4.1","mocha":"*","should":"^4.0.4","test-helpers":"^0.1.4","verb":">= 0.2.6"},"dependencies":{"arrayify-compact":"^0.1.0","code-context":"^0.2.0","gfm-code-blocks":"^0.1.0","inflection":"^1.4.0","lodash":"^2.4.1"},"_id":"parse-comments@0.3.1","_shasum":"19b89d05bec57491b29b9dc6a561b21c8ab40011","_from":".","_npmVersion":"1.4.9","_npmUser":{"name":"jonschlinkert","email":"github@sellside.com"},"maintainers":[{"name":"doowb","email":"brian.woodward@gmail.com"},{"name":"jonschlinkert","email":"github@sellside.com"}],"dist":{"shasum":"8eeafa3a77e626de547e54e98b10768f2d2de36d","size":26917,"noattachment":false,"key":"/parse-comments/-/parse-comments-0.3.1.tgz","tarball":"http://registry.cnpm.dingdandao.com/parse-comments/download/parse-comments-0.3.1.tgz"},"directories":{},"publish_time":1408965551278,"_cnpm_publish_time":1408965551278,"_hasShrinkwrap":false},"0.3.0":{"name":"parse-comments","description":"Parse code comments from JavaScript or any language that uses the same format.","version":"0.3.0","homepage":"https://github.com/jonschlinkert/parse-comments","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git://github.com/jonschlinkert/parse-comments.git"},"bugs":{"url":"https://github.com/jonschlinkert/parse-comments/issues"},"licenses":[{"type":"MIT","url":"https://github.com/jonschlinkert/parse-comments/blob/master/LICENSE-MIT"}],"keywords":["docs","documentation","generate","generator","markdown","templates","verb"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha -R spec"},"devDependencies":{"fs-utils":"^0.4.3","lodash":"^2.4.1","mocha":"*","should":"^4.0.4","test-helpers":"^0.1.4","verb":">= 0.2.6"},"dependencies":{"arrayify-compact":"^0.1.0","code-context":"^0.2.0","gfm-code-blocks":"^0.1.0","inflection":"^1.4.0","lodash":"^2.4.1"},"_id":"parse-comments@0.3.0","_shasum":"19b89d05bec57491b29b9dc6a561b21c8ab40011","_from":".","_npmVersion":"1.4.9","_npmUser":{"name":"jonschlinkert","email":"github@sellside.com"},"maintainers":[{"name":"doowb","email":"brian.woodward@gmail.com"},{"name":"jonschlinkert","email":"github@sellside.com"}],"dist":{"shasum":"19b89d05bec57491b29b9dc6a561b21c8ab40011","size":27061,"noattachment":false,"key":"/parse-comments/-/parse-comments-0.3.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/parse-comments/download/parse-comments-0.3.0.tgz"},"directories":{},"publish_time":1408962216792,"_cnpm_publish_time":1408962216792,"_hasShrinkwrap":false},"0.2.0":{"name":"parse-comments","description":"Parse code comments from JavaScript or any language that uses the same format.","version":"0.2.0","homepage":"https://github.com/jonschlinkert/parse-comments","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git://github.com/jonschlinkert/parse-comments.git"},"bugs":{"url":"https://github.com/jonschlinkert/parse-comments/issues"},"licenses":[{"type":"MIT","url":"https://github.com/jonschlinkert/parse-comments/blob/master/LICENSE-MIT"}],"keywords":["docs","documentation","generate","generator","markdown","templates","verb"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha -R spec"},"devDependencies":{"fs-utils":"^0.4.3","lodash":"^2.4.1","mocha":"*","should":"^4.0.4","test-helpers":"^0.1.4","verb":">= 0.2.6"},"dependencies":{"arrayify-compact":"^0.1.0","code-context":"^0.1.1","count-lines":"^0.1.2","extract-range":"^0.1.0","inflection":"^1.4.0","lodash":"^2.4.1"},"_id":"parse-comments@0.2.0","_shasum":"045069d0cf338d72a812f7cfe357944498f80939","_from":".","_npmVersion":"1.4.9","_npmUser":{"name":"jonschlinkert","email":"github@sellside.com"},"maintainers":[{"name":"doowb","email":"brian.woodward@gmail.com"},{"name":"jonschlinkert","email":"github@sellside.com"}],"dist":{"shasum":"045069d0cf338d72a812f7cfe357944498f80939","size":17427,"noattachment":false,"key":"/parse-comments/-/parse-comments-0.2.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/parse-comments/download/parse-comments-0.2.0.tgz"},"directories":{},"publish_time":1408793032007,"_cnpm_publish_time":1408793032007,"_hasShrinkwrap":false},"0.1.2":{"name":"parse-comments","description":"Parse JavaScript comments, or comments using a similar format.","version":"0.1.2","homepage":"https://github.com/jonschlinkert/parse-comments","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git://github.com/jonschlinkert/parse-comments.git"},"bugs":{"url":"https://github.com/jonschlinkert/parse-comments/issues"},"licenses":[{"type":"MIT","url":"https://github.com/jonschlinkert/parse-comments/blob/master/LICENSE-MIT"}],"keywords":["docs","documentation","generate","generator","markdown","templates","verb"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha -R spec"},"devDependencies":{"fs-utils":"^0.4.3","lodash":"^2.4.1","mocha":"*","should":"^4.0.4","verb":">= 0.2.6","verb-tag-jscomments":">= 0.1.4"},"dependencies":{"arrayify-compact":"^0.1.0","code-context":"^0.1.1","count-lines":"^0.1.2","extract-range":"^0.1.0","lodash":"^2.4.1"},"_id":"parse-comments@0.1.2","_shasum":"8403a6ab1c56a67050fc8a0310a1586421228c6c","_from":".","_npmVersion":"1.4.9","_npmUser":{"name":"jonschlinkert","email":"github@sellside.com"},"maintainers":[{"name":"doowb","email":"brian.woodward@gmail.com"},{"name":"jonschlinkert","email":"github@sellside.com"}],"dist":{"shasum":"8403a6ab1c56a67050fc8a0310a1586421228c6c","size":18236,"noattachment":false,"key":"/parse-comments/-/parse-comments-0.1.2.tgz","tarball":"http://registry.cnpm.dingdandao.com/parse-comments/download/parse-comments-0.1.2.tgz"},"directories":{},"publish_time":1407616126003,"_cnpm_publish_time":1407616126003,"_hasShrinkwrap":false},"0.1.1":{"name":"parse-comments","description":"Parse JavaScript comments, or comments using a similar format.","version":"0.1.1","homepage":"https://github.com/jonschlinkert/parse-comments","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git://github.com/jonschlinkert/parse-comments.git"},"bugs":{"url":"https://github.com/jonschlinkert/parse-comments/issues"},"licenses":[{"type":"MIT","url":"https://github.com/jonschlinkert/parse-comments/blob/master/LICENSE-MIT"}],"keywords":["docs","documentation","generate","generator","markdown","templates","verb"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha -R spec"},"devDependencies":{"fs-utils":"^0.4.3","lodash":"^2.4.1","mocha":"*","should":"^4.0.4","verb":">= 0.2.6","verb-tag-jscomments":">= 0.1.4"},"dependencies":{"arrayify-compact":"^0.1.0","code-context":"^0.1.0","count-lines":"^0.1.2","extract-range":"^0.1.0","lodash":"^2.4.1"},"_id":"parse-comments@0.1.1","_shasum":"7275b4042470ae4e61e552bfd5b8aad62e2857ae","_from":".","_npmVersion":"1.4.9","_npmUser":{"name":"jonschlinkert","email":"github@sellside.com"},"maintainers":[{"name":"doowb","email":"brian.woodward@gmail.com"},{"name":"jonschlinkert","email":"github@sellside.com"}],"dist":{"shasum":"7275b4042470ae4e61e552bfd5b8aad62e2857ae","size":17968,"noattachment":false,"key":"/parse-comments/-/parse-comments-0.1.1.tgz","tarball":"http://registry.cnpm.dingdandao.com/parse-comments/download/parse-comments-0.1.1.tgz"},"directories":{},"publish_time":1407601903724,"_cnpm_publish_time":1407601903724,"_hasShrinkwrap":false}},"readme":"# parse-comments [![NPM version](https://img.shields.io/npm/v/parse-comments.svg?style=flat)](https://www.npmjs.com/package/parse-comments) [![NPM monthly downloads](https://img.shields.io/npm/dm/parse-comments.svg?style=flat)](https://npmjs.org/package/parse-comments) [![NPM total downloads](https://img.shields.io/npm/dt/parse-comments.svg?style=flat)](https://npmjs.org/package/parse-comments) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/parse-comments.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/parse-comments)\n\n> Parse code comments from JavaScript or any language that uses the same format.\n\nPlease consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save parse-comments\n```\n\n## Usage\n\n```js\nconst Comments = require('parse-comments');\nconst comments = new Comments();\nconst ast = comments.parse(str);\nconsole.log(ast);\n```\n\nParses a comment like this:\n\n```js\n/**\n * Create an instance of `CustomClass` with the given `options`.\n *\n * @param {String} options\n * @api public\n */\n\nclass CustomClass {\n constructor(options) {\n this.options = options;\n }\n set(type, fn) {\n // do stuff\n }\n}\n```\n\nInto an array of comment objects, like this:\n\n```js\n[\n {\n type: 'BlockComment',\n value: '\\nCreate an instance of `CustomClass` with the given `options`.\\n\\n@param {String} options\\n@api public',\n range: [0, 117],\n loc: { start: { line: 1, column: 0 }, end: { line: 6, column: 3 } },\n codeStart: 119,\n raw:\n '*\\n * Create an instance of `CustomClass` with the given `options`.\\n *\\n * @param {String} options\\n * @api public\\n ',\n code: {\n context: {\n type: 'class',\n ctor: 'CustomClass',\n name: 'CustomClass',\n extends: undefined,\n string: 'new CustomClass()'\n },\n value: 'class CustomClass {',\n range: [119, 138],\n loc: { start: { line: 8, column: 0 }, end: { line: 8, column: 19 } }\n },\n description: 'Create an instance of `CustomClass` with the given `options`.',\n footer: '',\n examples: [],\n tags: [\n {\n title: 'param',\n name: 'options',\n description: '',\n type: { type: 'NameExpression', name: 'String' }\n },\n { title: 'api', name: 'public', description: '' }\n ],\n inlineTags: []\n }\n]\n```\n\n## API\n\n### [Comments](index.js#L22)\n\nCreate an instance of `Comments` with the given `options`.\n\n**Params**\n\n* **{Object}**: options\n\n**Example**\n\n```js\nconst Comments = require('parse-comments');\nconst comments = new Comments();\n```\n\nRegister a parser function of the given `type`\n\n**Params**\n\n* `type` **{string|object}**\n* `fn` **{Function}**\n* `returns` **{Object}**\n\n**Params**\n\n* `fn` **{Function}**: plugin function\n* `returns` **{Object}**: Returns the comments instance for chaining.\n\n**Example**\n\n```js\n// plugin example\nfunction yourPlugin(options) {\n return function(comments) {\n // do stuff\n };\n}\n// usage\ncomments.use(yourPlugin());\n```\n\n**Params**\n\n* `type` **{String}**: The `node.type` to call the handler on. You can override built-in middleware by registering a handler of the same name, or register a handler for rendering a new type.\n* `fn` **{Function}**: The handler function\n* `returns` **{Object}**: Returns the instance for chaining.\n\n**Example**\n\n```js\ncomments.set('param', function(node) {\n // do stuff to node\n});\n```\n\n**Params**\n\n* `type` **{String|Object|Array}**: Handler name(s), or an object of middleware\n* `fn` **{Function}**: Handler function, if `type` is a string or array. Otherwise this argument is ignored.\n* `returns` **{Object}**: Returns the instance for chaining.\n\n**Example**\n\n```js\ncomments.before('param', function(node) {\n // do stuff to node\n});\n\n// or\ncomments.before(['param', 'returns'], function(node) {\n // do stuff to node\n});\n\n// or\ncomments.before({\n param: function(node) {\n // do stuff to node\n },\n returns: function(node) {\n // do stuff to node\n }\n});\n```\n\n**Params**\n\n* `type` **{String|Object|Array}**: Handler name(s), or an object of middleware\n* `fn` **{Function}**: Handler function, if `type` is a string or array. Otherwise this argument is ignored.\n* `returns` **{Object}**: Returns the instance for chaining.\n\n**Example**\n\n```js\ncomments.after('param', function(node) {\n // do stuff to node\n});\n\n// or\ncomments.after(['param', 'returns'], function(node) {\n // do stuff to node\n});\n\n// or\ncomments.after({\n param: function(node) {\n // do stuff to node\n },\n returns: function(node) {\n // do stuff to node\n }\n});\n```\n\n**Params**\n\n* `javascript` **{String}**: String of javascript\n* `options` **{Object}**\n* `returns` **{Object}**: Returns an object with `description` string, array of `examples`, array of `tags` (strings), and a `footer` if descriptions are defined both before and after tags.\n\n**Example**\n\n```js\nconst parser = new ParseComments();\nconst tokens = parser.tokenize([string]);\n```\n\n**Params**\n\n* `str` **{String}**: String of javascript\n* `options` **{Object}**\n* `returns` **{Array}**: Array of objects.\n\n**Example**\n\n```js\nconst parser = new ParseComments();\nconst comments = parser.parse(string);\n```\n\n**Params**\n\n* `str` **{String}**: JavaScript comment\n* `options` **{Object}**\n* `returns` **{Object}**: Parsed comment object\n\n**Example**\n\n```js\nlet parser = new ParseComments();\nlet comments = parser.parseComment(string);\n```\n\n```js\n\n**Params**\n\n* **{}**: {String} \n* **{String}**: name \n* **{String}**: name The name to use for foo ``` \n* **{Object}**: tok Takes a token from \n* `returns` **{Object}** \n\n```js\n\n**Params**\n\n* **{}**: {String}\n* **{String}**: name\n* **{String}**: name The name to use for foo ```\n* **{Object}**: tok\n* `returns` **{Object}**\n\n```js\n\n**Params**\n\n* **{}**: {String} \n* **{}**: {...string} \n* **{}**: {function(...a)} \n* **{}**: {function(...a:b)} \n* **{}**: {String|Array} \n* **{}**: {(String|Array)} \n* **{}**: {{foo: bar}} \n* **{}**: {String[]} \n* ``` **{Array=}** \n* **{String}**: value The \n* `returns` **{Object}** \n\n```js\n\n**Params**\n\n* **{}**: {String}\n* **{}**: {String|Array}\n* **{}**: {(String|Array)}\n* **{}**: {{foo: bar}} ```\n* **{string}**: str The string to parse\n* `returns` **{object}**\n\nReturns true if the given `comment` is valid. By default, comments\nare considered valid when they begin with `/**`, and do not contain\n`jslint`, `jshint`, `eshint`, or `eslint`. A custom `isValid` function may be\npassed on the constructor options.\n\n**Params**\n\n* `comment` **{Object}**\n* `options` **{Object}**\n* `returns` **{Boolean}**\n\n## About\n\n
\nContributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\nPlease read the [contributing guide](.github/contributing.md) for advice on opening issues, pull requests, and coding standards.\n\n
\n\n
\nRunning Tests\n\nRunning and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:\n\n```sh\n$ npm install && npm test\n```\n\n
\n\n
\nBuilding docs\n\n_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_\n\nTo generate the readme, run the following command:\n\n```sh\n$ npm install -g verbose/verb#dev verb-generate-readme && verb\n```\n\n
\n\n### Contributors\n\n| **Commits** | **Contributor** | \n| --- | --- | \n| 35 | [jonschlinkert](https://github.com/jonschlinkert) | \n| 4 | [doowb](https://github.com/doowb) | \n\n### Author\n\n**Jon Schlinkert**\n\n* [GitHub Profile](https://github.com/jonschlinkert)\n* [Twitter Profile](https://twitter.com/jonschlinkert)\n* [LinkedIn Profile](https://linkedin.com/in/jonschlinkert)\n\n### License\n\nCopyright © 2018, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT License](LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.8.0, on November 24, 2018._","_attachments":{},"homepage":"https://github.com/jonschlinkert/parse-comments","bugs":{"url":"https://github.com/jonschlinkert/parse-comments/issues"},"license":"MIT"}