istanbul-phabricator-reporter/readme.md

istanbuljs reporter for the Phabricator code coverage format.

# Istanbul Reporter AWS Cloudwatch Metrics

This is a custom [istanbuljs](https://github.com/istanbuljs/istanbuljs) reporter to generate coverage metrics to Phabricator.

## Installing

In your project:
```
npm install -i istanbul-phabricator-reporter --save-dev
```

Then run `nyc` with this custom reporter via the command line:

```
nyc --reporter=istanbul-phabricator-reporter mocha
```

Or, change your npm scripts for your project in package.json:

```json
  (...)
  "scripts": {
    "test": "nyc --reporter=istanbul-phabricator-reporter mocha"
  },
  (...)
```

## Getting Started

After running nyc and having your coverage results you'll have a `coverage/phabricator_data.json` file
ready to be published to Phabricator through `harbormaster.sendmessage`.

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details