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

feat!: disable coverage.reportOnFailure by default #3615

Merged
merged 2 commits into from
Jul 11, 2023
Merged

feat!: disable coverage.reportOnFailure by default #3615

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bec344b
feat!: disable `coverage.reportOnFailure` by default
AriPerkkio Jun 19, 2023
981442b
docs: update version
AriPerkkio Jul 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/config/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -804,7 +804,7 @@ Since Vitest 0.31.0, you can check your coverage report in Vitest UI: check [Vit
#### coverage.reportOnFailure

- **Type:** `boolean`
- **Default:** `true`
AriPerkkio marked this conversation as resolved.
Show resolved Hide resolved
- **Default:** `false` (since Vitest `0.34.0`)
- **Available for providers:** `'c8' | 'v8' | 'istanbul'`
- **CLI:** `--coverage.reportOnFailure`, `--coverage.reportOnFailure=false`
- **Version:** Since Vitest 0.31.2
Expand Down
2 changes: 1 addition & 1 deletion packages/vitest/src/defaults.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ export const coverageConfigDefaults: ResolvedCoverageOptions = {
cleanOnRerun: true,
reportsDirectory: './coverage',
exclude: defaultCoverageExcludes,
reportOnFailure: true,
reportOnFailure: false,
reporter: [['text', {}], ['html', {}], ['clover', {}], ['json', {}]],
// default extensions used by c8, plus '.vue' and '.svelte'
// see https://github.com/istanbuljs/schema/blob/master/default-extension.js
Expand Down
2 changes: 1 addition & 1 deletion packages/vitest/src/types/coverage.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@ export interface BaseCoverageOptions {
/**
* Generate coverage report even when tests fail.
*
* @default true
* @default false
*/
reportOnFailure?: boolean
}
Expand Down
3 changes: 1 addition & 2 deletions test/fails/test/runner.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,12 @@ it('should report coverage when "coverag.reportOnFailure: true" and tests fail',
expect(stdout).toMatch('Coverage report from istanbul')
})

it('should not report coverage when "coverag.reportOnFailure: false" and tests fail', async () => {
it('should not report coverage when "coverag.reportOnFailure" has default value and tests fail', async () => {
const { stdout } = await runVitest({
root,
coverage: {
enabled: true,
provider: 'istanbul',
reportOnFailure: false,
reporter: ['text'],
},
}, [files[0]])
Expand Down