Skip to content

Commit

Permalink
updated doc zip
Browse files Browse the repository at this point in the history
  • Loading branch information
cenfun committed Nov 20, 2024
1 parent 11c5b65 commit 0704fbc
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,19 @@ Single HTML file (data compressed), easy to transfer/deploy or open directly any
- path-to/your-filename.json (requires option `json` is true)
Separated data file which can be used for debugging or data provider (It's included in the above HTML and compressed).
- path-to/your-filename.zip (requires option `zip` is true)
Zip file for merging reports
Zip file for merging reports
- custom zip options
```js
{
zip: {
// custom zip `outputFile`, defaults to reporter `outputFile` but uses `.zip` extension
outputFile: path.resolve(YourOutputDir, `monocart-report-${your-shard-number}.zip`),
// clean other report files except for zip file, defaults to false
clean: true
}
}
```


## Reporter Options
- Default options: [lib/default/options.js](./lib/default/options.js)
Expand Down Expand Up @@ -1050,6 +1062,7 @@ await merge(reportDataList, {
}
});
```
see [Output](#output) for `zip` options

> Note: The coverage reports will be merged automatically if we specify the `raw` report in coverage options:
```js
Expand Down

0 comments on commit 0704fbc

Please sign in to comment.