feat(coverage): add reportOnFailure option

vitest-dev · May 26, 2023 · f9c29d1 · f9c29d1
1 parent 56b9927
commit f9c29d1
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 0 deletions.
diff --git a/docs/config/index.md b/docs/config/index.md
@@ -778,6 +778,15 @@ The reporter has three different types:
 
 Since Vitest 0.31.0, you can check your coverage report in Vitest UI: check [Vitest UI Coverage](/guide/coverage#vitest-ui) for more details.
 
+#### coverage.reportOnFailure
+
+- **Type:** `boolean`
+- **Default:** `true`
+- **Available for providers:** `'c8' | 'istanbul'`
+- **CLI:** `--coverage.reportOnFailure`, `--coverage.reportOnFailure=false`
+
+Generate coverage report even when tests fail.
+
 #### coverage.skipFull
 
 - **Type:** `boolean`

diff --git a/packages/vitest/src/defaults.ts b/packages/vitest/src/defaults.ts
@@ -33,6 +33,7 @@ export const coverageConfigDefaults: ResolvedCoverageOptions = {
   cleanOnRerun: true,
   reportsDirectory: './coverage',
   exclude: defaultCoverageExcludes,
+  reportOnFailure: true,
   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

diff --git a/packages/vitest/src/node/core.ts b/packages/vitest/src/node/core.ts
@@ -692,6 +692,9 @@ export class Vitest {
   }
 
   private async reportCoverage(allTestsRun: boolean) {
+    if (!this.config.coverage.reportOnFailure && this.state.getCountOfFailedTests() > 0)
+      return
+
     if (this.coverageProvider) {
       this.logger.log(c.blue(' % ') + c.dim('Coverage report from ') + c.yellow(this.coverageProvider.name))
       await this.coverageProvider.reportCoverage({ allTestsRun })

diff --git a/packages/vitest/src/types/coverage.ts b/packages/vitest/src/types/coverage.ts
@@ -77,6 +77,7 @@ type FieldsWithDefaultValues =
   | 'reportsDirectory'
   | 'exclude'
   | 'extension'
+  | 'reportOnFailure'
 
 export type ResolvedCoverageOptions<T extends Provider = Provider> =
   & CoverageOptions<T>
@@ -208,6 +209,13 @@ export interface BaseCoverageOptions {
    * @default false
    */
   thresholdAutoUpdate?: boolean
+
+  /**
+   * Generate coverage report even when tests fail.
+   *
+   * @default true
+   */
+  reportOnFailure?: boolean
 }
 
 export interface CoverageIstanbulOptions extends BaseCoverageOptions {

diff --git a/test/coverage-test/test/configuration-options.test-d.ts b/test/coverage-test/test/configuration-options.test-d.ts
@@ -105,6 +105,7 @@ test('provider module', () => {
             extension: ['string'],
             reporter: [['html', {}], ['json', { file: 'string' }]],
             reportsDirectory: 'string',
+            reportOnFailure: true,
           }
         },
         clean(_: boolean) {},