Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add example usage to istanbul-lib-report #425

Merged
merged 3 commits into from Jul 3, 2019
Merged

Add example usage to istanbul-lib-report #425

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2acc26a
Add example usage to istanbul-lib-report
lukeapage Jun 21, 2019
b6ca8e9
Fix comments
lukeapage Jun 22, 2019
14d6c93
Update based on comments.
lukeapage Jun 25, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
21 changes: 20 additions & 1 deletion packages/istanbul-lib-report/README.md
View file
Open in desktop
Expand Up @@ -3,4 +3,23 @@
[![Greenkeeper badge](https://badges.greenkeeper.io/istanbuljs/istanbul-lib-report.svg)](https://greenkeeper.io/)
[![Build Status](https://travis-ci.org/istanbuljs/istanbul-lib-report.svg?branch=master)](https://travis-ci.org/istanbuljs/istanbul-lib-report)

Core reporting utilities for istanbul. Docs to follow.
Core reporting utilities for istanbul.

## example usage
lukeapage marked this conversation as resolved.
Show resolved Hide resolved

```
lukeapage marked this conversation as resolved.
Show resolved Hide resolved
const libReport = require('istanbul-lib-report');

const context = libReport.createContext({
dir: 'source/dir',
lukeapage marked this conversation as resolved.
Show resolved Hide resolved
defaultSummarizer: 'summarizer name e.g. nested/flat/pkg',
lukeapage marked this conversation as resolved.
Show resolved Hide resolved
watermarks: configWatermarks,
coverageMap,
lukeapage marked this conversation as resolved.
Show resolved Hide resolved
})

const report = reports.create('report/name e.g. json/html/html-spa/text', {
lukeapage marked this conversation as resolved.
Show resolved Hide resolved
skipEmpty: configSkipEmpty,
skipFull: configSkipFull
})
report.execute(context)
```