Extract JavaScript code comments from a string, using `acorn`. Optionally returns the AST and first line of code after comment - useful for parsing code context and api docs.
npm install acorn-extract-comments> Extract JavaScript code comments from a string, using acorn. Optionally returns the AST and first line of code after comment - useful for parsing code context and api docs.
[![code climate][codeclimate-img]][codeclimate-url] [![standard code style][standard-img]][standard-url] [![travis build status][travis-img]][travis-url] [![coverage status][coveralls-img]][coveralls-url] [![dependency status][david-img]][david-url]
npm i acorn-extract-comments --save
npm test
Usage
> For more use-cases see the testsjs
var acornExtractComments = require('acorn-extract-comments')
``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.
[![tunnckocore.tk][author-www-img]][author-www-url] [![keybase tunnckocore][keybase-img]][keybase-url] [![tunnckoCore npm][author-npm-img]][author-npm-url] [![tunnckoCore twitter][author-twitter-img]][author-twitter-url] [![tunnckoCore github][author-github-img]][author-github-url]
[npmjs-url]: https://www.npmjs.com/package/acorn-extract-comments
[npmjs-img]: https://img.shields.io/npm/v/acorn-extract-comments.svg
[license-url]: https://github.com/tunnckoCore/acorn-extract-comments/blob/master/LICENSE.md
[license-img]: https://img.shields.io/badge/license-MIT-blue.svg
[codeclimate-url]: https://codeclimate.com/github/tunnckoCore/acorn-extract-comments
[codeclimate-img]: https://img.shields.io/codeclimate/github/tunnckoCore/acorn-extract-comments.svg
[travis-url]: https://travis-ci.org/tunnckoCore/acorn-extract-comments
[travis-img]: https://img.shields.io/travis/tunnckoCore/acorn-extract-comments.svg
[coveralls-url]: https://coveralls.io/r/tunnckoCore/acorn-extract-comments
[coveralls-img]: https://img.shields.io/coveralls/tunnckoCore/acorn-extract-comments.svg
[david-url]: https://david-dm.org/tunnckoCore/acorn-extract-comments
[david-img]: https://img.shields.io/david/tunnckoCore/acorn-extract-comments.svg
[standard-url]: https://github.com/feross/standard
[standard-img]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg
[author-www-url]: http://www.tunnckocore.tk
[author-www-img]: https://img.shields.io/badge/www-tunnckocore.tk-fe7d37.svg
[keybase-url]: https://keybase.io/tunnckocore
[keybase-img]: https://img.shields.io/badge/keybase-tunnckocore-8a7967.svg
[author-npm-url]: https://www.npmjs.com/~tunnckocore
[author-npm-img]: https://img.shields.io/badge/npm-~tunnckocore-cb3837.svg
[author-twitter-url]: https://twitter.com/tunnckoCore
[author-twitter-img]: https://img.shields.io/badge/twitter-@tunnckoCore-55acee.svg
[author-github-url]: https://github.com/tunnckoCore
[author-github-img]: https://img.shields.io/badge/github-@tunnckoCore-4183c4.svg
[freenode-url]: http://webchat.freenode.net/?channels=charlike
[freenode-img]: https://img.shields.io/badge/freenode-%23charlike-5654a4.svg
[new-message-url]: https://github.com/tunnckoCore/messages
[new-message-img]: https://img.shields.io/badge/send%20me-message-green.svg