diff options
Diffstat (limited to 'vanilla/node_modules/istanbul-lib-report/README.md')
| -rw-r--r-- | vanilla/node_modules/istanbul-lib-report/README.md | 43 |
1 files changed, 0 insertions, 43 deletions
diff --git a/vanilla/node_modules/istanbul-lib-report/README.md b/vanilla/node_modules/istanbul-lib-report/README.md deleted file mode 100644 index f7ff56a..0000000 --- a/vanilla/node_modules/istanbul-lib-report/README.md +++ /dev/null @@ -1,43 +0,0 @@ -# istanbul-lib-report - -[](https://greenkeeper.io/) -[](https://travis-ci.org/istanbuljs/istanbul-lib-report) - -Core reporting utilities for istanbul. - -## Example usage - -```js -const libReport = require('istanbul-lib-report'); -const reports = require('istanbul-reports'); - -// coverageMap, for instance, obtained from istanbul-lib-coverage -const coverageMap; - -const configWatermarks = { - statements: [50, 80], - functions: [50, 80], - branches: [50, 80], - lines: [50, 80] -}; - -// create a context for report generation -const context = libReport.createContext({ - dir: 'report/output/dir', - // The summarizer to default to (may be overridden by some reports) - // values can be nested/flat/pkg. Defaults to 'pkg' - defaultSummarizer: 'nested', - watermarks: configWatermarks, - coverageMap, -}) - -// create an instance of the relevant report class, passing the -// report name e.g. json/html/html-spa/text -const report = reports.create('json', { - skipEmpty: configSkipEmpty, - skipFull: configSkipFull -}) - -// call execute to synchronously create and write the report to disk -report.execute(context) -``` |
