# esprima-extract-comments
> Extract code comments from string or from a glob of files using esprima.
Latest version **1.1.0** (published 2018-02-12) · MIT license · 0 weekly downloads
## Install
```sh
npm install esprima-extract-comments
pnpm add esprima-extract-comments
yarn add esprima-extract-comments
bun add esprima-extract-comments
```
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 1.1.0 |
| Published | 2018-02-12 |
| First published | 2014-09-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4 |
| Dependencies | 1 |
| Unpacked size | 9.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 14 |
| Author | Jon Schlinkert |
| Maintainers | doowb, jonschlinkert |
| Keywords | block, code, comment, comments, context, esprima, extract, glob, javascript, parse |
## Links
- npm: https://www.npmjs.com/package/esprima-extract-comments
- Repository: https://github.com/jonschlinkert/esprima-extract-comments
- Issues: https://github.com/jonschlinkert/esprima-extract-comments/issues
- npm.io page: https://npm.io/package/esprima-extract-comments
## Dependencies (1)
- [esprima](https://npm.io/package/esprima.md) ^4.0.0
## Alternatives
- [babylon](https://npm.io/package/babylon.md) — 5.1M weekly downloads
- [csscolorparser](https://npm.io/package/csscolorparser.md) — 3.7M weekly downloads
- [expr-eval-fork](https://npm.io/package/expr-eval-fork.md) — 1.5M weekly downloads
- [@leeoniya/ufuzzy](https://npm.io/package/@leeoniya/ufuzzy.md) — 247.7K weekly downloads
- [xml-parser](https://npm.io/package/xml-parser.md) — 78.4K weekly downloads
## Recent versions
- 1.1.0 (latest) — 2018-02-12
- 1.0.1 — 2018-02-12
- 1.0.0 — 2018-02-12
- 0.2.1 — 2015-12-30
- 0.1.3 — 2015-11-10
- 0.2.0 — 2015-11-10
- 0.1.2 — 2014-11-27
- 0.1.0 — 2014-09-24
## README
# esprima-extract-comments [](https://www.npmjs.com/package/esprima-extract-comments) [](https://npmjs.org/package/esprima-extract-comments) [](https://npmjs.org/package/esprima-extract-comments) [](https://travis-ci.org/jonschlinkert/esprima-extract-comments)
> Extract code comments from string or from a glob of files using esprima.
Please consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install --save esprima-extract-comments
```
## Breaking changes in v1.0.0!
* line `comment.type` was changed from `line` to `LineComment`
* block `comment.type` was changed from `block` to `BlockComment`
## Usage
Add to your Node.js/JavaScript project with the following line of code:
```js
const extract = require('esprima-extract-comments');
```
## API
### [extract](index.js#L30)
Extract line and block comments from a string of JavaScript.
**Params**
* `string` **{String}**
* `options` **{Object}**: Options to pass to [esprima](http://esprima.org).
* `returns` **{Array}**: Array of code comment objects.
**Example**
```js
console.log(extract('// this is a line comment'));
// [ { type: 'Line',
// value: ' this is a line comment',
// range: [ 0, 25 ],
// loc: { start: { line: 1, column: 0 }, end: { line: 1, column: 25 } } } ]
```
### [.file](index.js#L52)
Extract code comments from a JavaScript file.
**Params**
* `file` **{String}**: Filepath to the file to parse.
* `options` **{Object}**: Options to pass to [esprima](http://esprima.org).
* `returns` **{Array}**: Array of code comment objects.
**Example**
```js
console.log(extract.file('some-file.js'), { cwd: 'some/path' });
// [ { type: 'Line',
// value: ' this is a line comment',
// range: [ 0, 25 ],
// loc: { start: { line: 1, column: 0 }, end: { line: 1, column: 25 } } } ]
```
## About
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
Running Tests
Running 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:
```sh
$ npm install && npm test
```
Building docs
_(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.)_
To generate the readme, run the following command:
```sh
$ npm install -g verbose/verb#dev verb-generate-readme && verb
```
### Related projects
You might also be interested in these projects:
* [extract-comments](https://www.npmjs.com/package/extract-comments): Uses esprima to extract line and block comments from a string of JavaScript. Also optionally… [more](https://github.com/jonschlinkert/extract-comments) | [homepage](https://github.com/jonschlinkert/extract-comments "Uses esprima to extract line and block comments from a string of JavaScript. Also optionally parses code context (the next line of code after a comment).")
* [js-comments](https://www.npmjs.com/package/js-comments): Parse JavaScript code comments and generate API documentation. | [homepage](https://github.com/jonschlinkert/js-comments "Parse JavaScript code comments and generate API documentation.")
* [parse-comments](https://www.npmjs.com/package/parse-comments): Parse code comments from JavaScript or any language that uses the same format. | [homepage](https://github.com/jonschlinkert/parse-comments "Parse code comments from JavaScript or any language that uses the same format.")
### Author
**Jon Schlinkert**
* [linkedin/in/jonschlinkert](https://linkedin.com/in/jonschlinkert)
* [github/jonschlinkert](https://github.com/jonschlinkert)
* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
### License
Copyright © 2018, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT License](LICENSE).
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on February 12, 2018._
---
_Source: https://npm.io/package/esprima-extract-comments · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._