fix(coverage): simplify provider types

Author: AriPerkkio

docs/guide/cli-generated.md

@@ -285,6 +285,20 @@ High and low watermarks for functions in the format of `<high>,<low>`
 
 Collect coverage only for files changed since a specified commit or branch (e.g., `origin/main` or `HEAD~1`). Inherits value from `--changed` by default.
 
+### coverage.excludeAfterRemap
+
+- **CLI:** `--coverage.excludeAfterRemap`
+- **Config:** [coverage.excludeAfterRemap](/config/coverage#coverage-excludeafterremap)
+
+Apply exclusions again after coverage has been remapped to original sources. (default: false)
+
+### coverage.htmlDir
+
+- **CLI:** `--coverage.htmlDir <path>`
+- **Config:** [coverage.htmlDir](/config/coverage#coverage-htmldir)
+
+Directory of HTML coverage output to be served in UI mode and HTML reporter.
+
 ### mode
 
 - **CLI:** `--mode <name>`

packages/coverage-istanbul/src/provider.ts

@@ -1,7 +1,7 @@
 import type { CoverageMap } from 'istanbul-lib-coverage'
 import type { Instrumenter } from 'istanbul-lib-instrument'
 import type { ProxifiedModule } from 'magicast'
-import type { CoverageProvider, ReportContext, ResolvedCoverageOptions, Vite, Vitest } from 'vitest/node'
+import type { CoverageProvider, ReportContext, Vite, Vitest } from 'vitest/node'
 import { existsSync, promises as fs } from 'node:fs'
 // @ts-expect-error missing types
 import { defaults as istanbulDefaults } from '@istanbuljs/schema'
@@ -21,7 +21,7 @@ import { COVERAGE_STORE_KEY } from './constants'
 
 const debug = createDebug('vitest:coverage')
 
-export class IstanbulCoverageProvider extends BaseCoverageProvider<ResolvedCoverageOptions<'istanbul'>> implements CoverageProvider {
+export class IstanbulCoverageProvider extends BaseCoverageProvider implements CoverageProvider {
   name = 'istanbul' as const
   version: string = version
   instrumenter!: Instrumenter

packages/coverage-v8/src/provider.ts

@@ -1,7 +1,7 @@
 import type { CoverageMap } from 'istanbul-lib-coverage'
 import type { ProxifiedModule } from 'magicast'
 import type { Profiler } from 'node:inspector'
-import type { CoverageProvider, ReportContext, ResolvedCoverageOptions, TestProject, Vite, Vitest } from 'vitest/node'
+import type { CoverageProvider, ReportContext, TestProject, Vite, Vitest } from 'vitest/node'
 import { existsSync, promises as fs } from 'node:fs'
 import { fileURLToPath } from 'node:url'
 // @ts-expect-error -- untyped
@@ -28,7 +28,7 @@ const FILE_PROTOCOL = 'file://'
 
 const debug = createDebug('vitest:coverage')
 
-export class V8CoverageProvider extends BaseCoverageProvider<ResolvedCoverageOptions<'v8'>> implements CoverageProvider {
+export class V8CoverageProvider extends BaseCoverageProvider implements CoverageProvider {
   name = 'v8' as const
   version: string = version
 

packages/vitest/src/node/cli/cli-config.ts

@@ -320,6 +320,13 @@ export const cliOptionsConfig: VitestCLIOptions = {
           return value
         },
       },
+      excludeAfterRemap: {
+        description: 'Apply exclusions again after coverage has been remapped to original sources. (default: false)',
+      },
+      htmlDir: {
+        description: 'Directory of HTML coverage output to be served in UI mode and HTML reporter.',
+        argument: '<path>',
+      },
     },
   },
   mode: {

packages/vitest/src/node/coverage.ts

@@ -74,11 +74,11 @@ export async function getCoverageProvider(
   return null
 }
 
-export class BaseCoverageProvider<Options extends ResolvedCoverageOptions<'istanbul' | 'v8'>> {
+export class BaseCoverageProvider {
   ctx!: Vitest
   readonly name!: 'v8' | 'istanbul'
   version!: string
-  options!: Options
+  options!: ResolvedCoverageOptions
   globCache: Map<string, boolean> = new Map()
   autoUpdateMarker = '\n// __VITEST_COVERAGE_MARKER__'
 
@@ -101,7 +101,7 @@ export class BaseCoverageProvider<Options extends ResolvedCoverageOptions<'istan
       )
     }
 
-    const config = ctx._coverageOptions as Options
+    const config = ctx._coverageOptions
 
     this.options = {
       ...coverageConfigDefaults,
@@ -228,7 +228,7 @@ export class BaseCoverageProvider<Options extends ResolvedCoverageOptions<'istan
     throw new Error('BaseReporter\'s parseConfigModule was not overwritten')
   }
 
-  resolveOptions(): Options {
+  resolveOptions(): ResolvedCoverageOptions {
     return this.options
   }
 

packages/vitest/src/node/types/coverage.ts

@@ -95,24 +95,10 @@ export type CoverageReporterWithOptions<
 
 export type CoverageProviderName = 'v8' | 'istanbul' | 'custom' | undefined
 
-export type CoverageOptions<T extends CoverageProviderName = CoverageProviderName>
-  = T extends 'istanbul'
-    ? { provider: T } & CoverageIstanbulOptions
-    : T extends 'v8' ? {
-      /**
-       * Provider to use for coverage collection.
-       *
-       * @default 'v8'
-       */
-      provider: T
-    } & CoverageV8Options
-      : T extends 'custom'
-        ? { provider: T } & CustomProviderOptions
-        : { provider?: T } & CoverageV8Options
-
 /** Fields that have default values. Internally these will always be defined. */
 type FieldsWithDefaultValues
-  = | 'enabled'
+  = | 'provider'
+    | 'enabled'
     | 'clean'
     | 'cleanOnRerun'
     | 'reportsDirectory'
@@ -121,14 +107,23 @@ type FieldsWithDefaultValues
     | 'allowExternal'
     | 'processingConcurrency'
 
-export type ResolvedCoverageOptions<T extends CoverageProviderName = CoverageProviderName>
-  = CoverageOptions<T>
-    & Required<Pick<CoverageOptions<T>, FieldsWithDefaultValues>> & { // Resolved fields which may have different typings as public configuration API has
+export type ResolvedCoverageOptions
+  = CoverageOptions
+    & Required<Pick<CoverageOptions, FieldsWithDefaultValues>>
+    & {
+    // Resolved fields which may have different typings as public configuration API has
       reporter: CoverageReporterWithOptions[]
       htmlDir?: string
     }
 
-export interface BaseCoverageOptions {
+export interface CoverageOptions {
+  /**
+   * Coverage provider to use.
+   *
+   * @default 'v8'
+   */
+  provider?: 'v8' | 'istanbul' | 'custom'
+
   /**
    * Enables coverage collection. Can be overridden using `--coverage` CLI option.
    *
@@ -285,16 +280,11 @@ export interface BaseCoverageOptions {
    * @default false
    */
   changed?: boolean | string
-}
-
-export interface CoverageIstanbulOptions extends BaseCoverageOptions {}
 
-export interface CoverageV8Options extends BaseCoverageOptions {}
-
-export interface CustomProviderOptions
-  extends Pick<BaseCoverageOptions, FieldsWithDefaultValues | 'changed'> {
-  /** Name of the module or path to a file to load the custom provider from */
-  customProviderModule: string
+  /**
+   * Name of the module or path to a file to load the custom provider from
+   */
+  customProviderModule?: string
 }
 
 interface Thresholds {
@@ -324,3 +314,15 @@ interface Thresholds {
   /** Thresholds for lines */
   lines?: number
 }
+
+/** @deprecated Use `CoverageOptions` instead */
+export interface CoverageV8Options extends CoverageOptions {}
+
+/** @deprecated Use `CoverageOptions` instead */
+export interface CoverageIstanbulOptions extends CoverageOptions {}
+
+/** @deprecated Use `CoverageOptions` instead */
+export interface BaseCoverageOptions extends CoverageOptions {}
+
+/** @deprecated Use `CoverageOptions` instead */
+export interface CustomProviderOptions extends CoverageOptions {}

test/coverage-test/test/configuration-options.test-d.ts

@@ -72,25 +72,6 @@ test('provider options, generic', () => {
   })
 })
 
-test('provider specific options, custom', () => {
-  assertType<Coverage>({
-    provider: 'custom',
-    customProviderModule: 'custom-provider-module.ts',
-    enabled: true,
-  })
-
-  // @ts-expect-error --  customProviderModule is required
-  assertType<Coverage>({ provider: 'custom' })
-
-  assertType<Coverage>({
-    provider: 'custom',
-    customProviderModule: 'some-module',
-
-    // @ts-expect-error --  typings of BaseCoverageOptions still apply
-    enabled: 'not boolean',
-  })
-})
-
 test('provider module', () => {
   assertType<CoverageProviderModule>({
     getProvider() {
@@ -100,6 +81,7 @@ test('provider module', () => {
         generateCoverage() {},
         resolveOptions(): ResolvedCoverageOptions {
           return {
+            provider: 'v8',
             clean: true,
             cleanOnRerun: true,
             enabled: true,