Skip to content

Commit

Permalink
Add coverageReporters to the API docs (#1677) (#1680)
Browse files Browse the repository at this point in the history
* Add coverageReporters to the API docs (#1677)

* Update API.md
  • Loading branch information
Jakub Synowiec authored and cpojer committed Sep 14, 2016
1 parent da77900 commit 5da2bd7
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/API.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,7 @@ These options let you control Jest's behavior in your `package.json` file. The J
- [`bail` [boolean]](#bail-boolean)
- [`cacheDirectory` [string]](#cachedirectory-string)
- [`coverageDirectory` [string]](#coveragedirectory-string)
- [`coverageReporters` [array<string>]](#coveragereporters-array-string)
- [`collectCoverage` [boolean]](#collectcoverage-boolean)
- [`collectCoverageOnlyFrom` [object]](#collectcoverageonlyfrom-object)
- [`coveragePathIgnorePatterns` [array<string>]](#coveragepathignorepattern-array-string)
Expand Down Expand Up @@ -955,6 +956,13 @@ Jest attempts to scan your dependency tree once (up-front) and cache it in order

The directory where Jest should output its coverage files.

### `coverageReporters` [array<string>]
(default: `['json', 'lcov', 'text']`)

A list of reporter names that Jest uses when writing coverage reports. Any [istanbul reporter](https://github.com/gotwarlost/istanbul/tree/master/lib/report) can be used.

*Note: Setting this option overwrites the default values. Add `'text'` or `'text-summary'` to see a coverage summary in the console output.*

### `collectCoverage` [boolean]
(default: `false`)

Expand Down

0 comments on commit 5da2bd7

Please sign in to comment.