fix(coverage): clean up empty coverage reports directory (#5731)

packages/coverage-istanbul/src/provider.ts

@@ -1,4 +1,4 @@
-import { existsSync, promises as fs, writeFileSync } from 'node:fs'
+import { existsSync, promises as fs, readdirSync, writeFileSync } from 'node:fs'
 import { resolve } from 'pathe'
 import type { AfterSuiteRunMeta, CoverageIstanbulOptions, CoverageProvider, ReportContext, ResolvedCoverageOptions, Vitest } from 'vitest'
 import { coverageConfigDefaults, defaultExclude, defaultInclude } from 'vitest/config'
@@ -255,6 +255,10 @@ export class IstanbulCoverageProvider extends BaseCoverageProvider implements Co
  if (!keepResults) {
  this.coverageFiles = new Map()
  await fs.rm(this.coverageFilesDirectory, { recursive: true })
+
+ // Remove empty reports directory, e.g. when only text-reporter is used
+ if (readdirSync(this.options.reportsDirectory).length === 0)
+ await fs.rm(this.options.reportsDirectory, { recursive: true })
  }
  }
 

packages/coverage-v8/src/provider.ts

@@ -1,4 +1,4 @@
-import { existsSync, promises as fs, writeFileSync } from 'node:fs'
+import { existsSync, promises as fs, readdirSync, writeFileSync } from 'node:fs'
 import type { Profiler } from 'node:inspector'
 import { fileURLToPath, pathToFileURL } from 'node:url'
 import v8ToIstanbul from 'v8-to-istanbul'
@@ -246,6 +246,10 @@ export class V8CoverageProvider extends BaseCoverageProvider implements Coverage
  if (!keepResults) {
  this.coverageFiles = new Map()
  await fs.rm(this.coverageFilesDirectory, { recursive: true })
+
+ // Remove empty reports directory, e.g. when only text-reporter is used
+ if (readdirSync(this.options.reportsDirectory).length === 0)
+ await fs.rm(this.options.reportsDirectory, { recursive: true })
  }
  }
 

test/coverage-test/option-tests/fixture.test.ts

@@ -0,0 +1,8 @@
+// Generic test fixture to generate some coverage
+
+import { test } from 'vitest'
+import { add } from '../src/utils'
+
+test('cover some lines', () => {
+ add(1, 2)
+})

test/coverage-test/testing-options.mjs

@@ -1,4 +1,4 @@
-import { readFileSync, rmSync, writeFileSync } from 'node:fs'
+import { existsSync, readFileSync, readdirSync, rmSync, writeFileSync } from 'node:fs'
 import { startVitest } from 'vitest/node'
 
 /**
@@ -147,6 +147,25 @@ const testCases = [
  process.exitCode = 0
  },
  },
+ {
+ testConfig: {
+ name: 'remove empty coverages directory',
+ include: ['option-tests/fixture.test.ts'],
+ coverage: {
+ reporter: 'text',
+ all: false,
+ include: ['src/utils.ts'],
+ },
+ },
+ after() {
+ if (existsSync('./coverage')) {
+ if (readdirSync('./coverage').length !== 0)
+ throw new Error('Test case expected coverage directory to be empty')
+
+ throw new Error('Empty coverage directory was not cleaned')
+ }
+ },
+ },
 ]
 
 for (const provider of ['v8', 'istanbul']) {