Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cenfun/jest-monocart-coverage
A Jest custom reporter for monocart coverage reports
https://github.com/cenfun/jest-monocart-coverage
coverage istanbul jest monocart reporter v8
Last synced: 3 months ago
JSON representation
A Jest custom reporter for monocart coverage reports
- Host: GitHub
- URL: https://github.com/cenfun/jest-monocart-coverage
- Owner: cenfun
- License: mit
- Created: 2024-01-21T13:09:29.000Z (almost 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-19T15:14:40.000Z (5 months ago)
- Last Synced: 2024-10-07T15:22:50.800Z (4 months ago)
- Topics: coverage, istanbul, jest, monocart, reporter, v8
- Language: JavaScript
- Homepage:
- Size: 41 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# jest-monocart-coverage
[](https://www.npmjs.com/package/jest-monocart-coverage)
[](https://www.npmjs.com/package/jest-monocart-coverage)
> A [Jest](https://github.com/jestjs/jest/) custom reporter for [monocart coverage reports](https://github.com/cenfun/monocart-coverage-reports)
## Install
```sh
npm i jest-monocart-coverage
```
## Usage
```js
// jest.config.js
const config = {
// Enable coverage
collectCoverage: true,
// Recommended to use `v8` to support the generation of native v8 coverage reports.
coverageProvider: 'v8',
// Monocart can also support all coverage reports, so there is no need to set up reports here.
coverageReporters: ['none'],
reporters: [
// If custom reporters are specified, the default Jest reporter will be overridden. If you wish to keep it, 'default' must be passed as a reporters name:
'default',
// Monocart custom reporter to generate coverage reports.
['jest-monocart-coverage', {
name: 'My Unit Coverage Report',
reports: [
['v8'],
['console-summary'],
['lcovonly']
],
outputDir: './coverage-reports/unit'
}]
]
};
export default config;
```
Check [monocart coverage reports](https://github.com/cenfun/monocart-coverage-reports) for more coverage options.
## The Execution Order of Hooks
- For Jest: custom reporter `onEnd` -> `globalTeardown`
- For Playwright: `globalTeardown` -> coverage `onEnd` -> custom reporter `onEnd`
## Common issues
- Resolve full path of the file with option `sourcePath` (issue [#5](https://github.com/cenfun/jest-monocart-coverage/issues/5))
```js
const path = require("path")
// MCR coverage options
{
sourcePath: (filePath, info)=> {
if (!filePath.includes('/') && info.distFile) {
return `${path.dirname(info.distFile)}/${filePath}`;
}
return filePath;
}
}
```
- Failed to load Sourcemap (issue [#6](https://github.com/cenfun/jest-monocart-coverage/issues/6))
Using `sourceMap` instead of `inlineSourceMap` in `tsconfig.json`
```json
{
"compilerOptions": {
"sourceMap": true,
"inlineSourceMap": false
}
}
```