feat!: remove @vitest/coverage-c8 package (#3614)

Author: AriPerkkio

bench/pnpm-lock.yaml

@@ -37,7 +37,7 @@ export default withPwa(defineConfig({
     ['link', { rel: 'icon', href: '/favicon.ico', sizes: 'any' }],
     ['link', { rel: 'icon', href: '/logo.svg', type: 'image/svg+xml' }],
     ['meta', { name: 'author', content: `${teamMembers.map(c => c.name).join(', ')} and ${vitestName} contributors` }],
-    ['meta', { name: 'keywords', content: 'vitest, vite, test, coverage, snapshot, react, vue, preact, svelte, solid, lit, ruby, cypress, puppeteer, jsdom, happy-dom, test-runner, jest, typescript, esm, tinypool, tinyspy, c8, node' }],
+    ['meta', { name: 'keywords', content: 'vitest, vite, test, coverage, snapshot, react, vue, preact, svelte, solid, lit, ruby, cypress, puppeteer, jsdom, happy-dom, test-runner, jest, typescript, esm, tinypool, tinyspy, node' }],
     ['meta', { property: 'og:title', content: vitestName }],
     ['meta', { property: 'og:description', content: vitestDescription }],
     ['meta', { property: 'og:url', content: ogUrl }],

docs/.vitepress/config.ts

@@ -667,10 +667,6 @@ Isolate environment for each test file. Does not work if you disable [`--threads
 
 You can use [`v8`](https://v8.dev/blog/javascript-code-coverage), [`istanbul`](https://istanbul.js.org/) or [a custom coverage solution](/guide/coverage#custom-coverage-provider) for coverage collection.
 
-::: info
-The `c8` provider is being replaced by the `v8` provider. It will be deprecated in the next major version.
-:::
-
 You can provide coverage options to CLI with dot notation:
 
 ```sh
@@ -683,7 +679,7 @@ If you are using coverage options with dot notation, don't forget to specify `--
 
 #### coverage.provider
 
-- **Type:** `'c8' | 'v8' | 'istanbul' | 'custom'`
+- **Type:** `'v8' | 'istanbul' | 'custom'`
 - **Default:** `'v8'`
 - **CLI:** `--coverage.provider=<provider>`
 
@@ -693,7 +689,7 @@ Use `provider` to select the tool for coverage collection.
 
 - **Type:** `boolean`
 - **Default:** `false`
-- **Available for providers:** `'c8' | 'v8' | 'istanbul'`
+- **Available for providers:** `'v8' | 'istanbul'`
 - **CLI:** `--coverage.enabled`, `--coverage.enabled=false`
 
 Enables coverage collection. Can be overridden using `--coverage` CLI option.
@@ -702,7 +698,7 @@ Enables coverage collection. Can be overridden using `--coverage` CLI option.
 
 - **Type:** `string[]`
 - **Default:** `['**']`
-- **Available for providers:** `'c8' | 'v8' | 'istanbul'`
+- **Available for providers:** `'v8' | 'istanbul'`
 - **CLI:** `--coverage.include=<path>`, `--coverage.include=<path1> --coverage.include=<path2>`
 
 List of files included in coverage as glob patterns
@@ -711,7 +707,7 @@ List of files included in coverage as glob patterns
 
 - **Type:** `string | string[]`
 - **Default:** `['.js', '.cjs', '.mjs', '.ts', '.mts', '.cts', '.tsx', '.jsx', '.vue', '.svelte']`
-- **Available for providers:** `'c8' | 'v8' | 'istanbul'`
+- **Available for providers:** `'v8' | 'istanbul'`
 - **CLI:** `--coverage.extension=<extension>`, `--coverage.extension=<extension1> --coverage.extension=<extension2>`
 
 #### coverage.exclude
@@ -733,7 +729,7 @@ List of files included in coverage as glob patterns
   '**/.{eslint,mocha,prettier}rc.{?(c|m)js,yml}',
 ]
 ```
-- **Available for providers:** `'c8' | 'v8' | 'istanbul'`
+- **Available for providers:** `'v8' | 'istanbul'`
 - **CLI:** `--coverage.exclude=<path>`, `--coverage.exclude=<path1> --coverage.exclude=<path2>`
 
 List of files excluded from coverage as glob patterns.
@@ -742,7 +738,7 @@ List of files excluded from coverage as glob patterns.
 
 - **Type:** `boolean`
 - **Default:** `false`
-- **Available for providers:** `'c8' | 'v8' | 'istanbul'`
+- **Available for providers:** `'v8' | 'istanbul'`
 - **CLI:** `--coverage.all`, `--coverage.all=false`
 
 Whether to include all files, including the untested ones into report.
@@ -751,7 +747,7 @@ Whether to include all files, including the untested ones into report.
 
 - **Type:** `boolean`
 - **Default:** `true`
-- **Available for providers:** `'c8' | 'v8' | 'istanbul'`
+- **Available for providers:** `'v8' | 'istanbul'`
 - **CLI:** `--coverage.clean`, `--coverage.clean=false`
 
 Clean coverage results before running tests
@@ -760,7 +756,7 @@ Clean coverage results before running tests
 
 - **Type:** `boolean`
 - **Default:** `true`
-- **Available for providers:** `'c8' | 'v8' | 'istanbul'`
+- **Available for providers:** `'v8' | 'istanbul'`
 - **CLI:** `--coverage.cleanOnRerun`, `--coverage.cleanOnRerun=false`
 
 Clean coverage report on watch rerun
@@ -769,7 +765,7 @@ Clean coverage report on watch rerun
 
 - **Type:** `string`
 - **Default:** `'./coverage'`
-- **Available for providers:** `'c8' | 'v8' | 'istanbul'`
+- **Available for providers:** `'v8' | 'istanbul'`
 - **CLI:** `--coverage.reportsDirectory=<path>`
 
 Directory to write coverage report to.
@@ -778,7 +774,7 @@ Directory to write coverage report to.
 
 - **Type:** `string | string[] | [string, {}][]`
 - **Default:** `['text', 'html', 'clover', 'json']`
-- **Available for providers:** `'c8' | 'v8' | 'istanbul'`
+- **Available for providers:** `'v8' | 'istanbul'`
 - **CLI:** `--coverage.reporter=<reporter>`, `--coverage.reporter=<reporter1> --coverage.reporter=<reporter2>`
 
 Coverage reporters to use. See [istanbul documentation](https://istanbul.js.org/docs/advanced/alternative-reporters/) for detailed list of all reporters. See [`@types/istanbul-reporter`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/276d95e4304b3670eaf6e8e5a7ea9e265a14e338/types/istanbul-reports/index.d.ts) for details about reporter specific options.
@@ -805,7 +801,7 @@ Since Vitest 0.31.0, you can check your coverage report in Vitest UI: check [Vit
 
 - **Type:** `boolean`
 - **Default:** `false` (since Vitest `0.34.0`)
-- **Available for providers:** `'c8' | 'v8' | 'istanbul'`
+- **Available for providers:** `'v8' | 'istanbul'`
 - **CLI:** `--coverage.reportOnFailure`, `--coverage.reportOnFailure=false`
 - **Version:** Since Vitest 0.31.2
 
@@ -815,7 +811,7 @@ Generate coverage report even when tests fail.
 
 - **Type:** `boolean`
 - **Default:** `false`
-- **Available for providers:** `'c8' | 'v8' | 'istanbul'`
+- **Available for providers:** `'v8' | 'istanbul'`
 - **CLI:** `--coverage.skipFull`, `--coverage.skipFull=false`
 
 Do not show files with 100% statement, branch, and function coverage.
@@ -824,7 +820,7 @@ Do not show files with 100% statement, branch, and function coverage.
 
 - **Type:** `boolean`
 - **Default:** `false`
-- **Available for providers:** `'c8' | 'v8' | 'istanbul'`
+- **Available for providers:** `'v8' | 'istanbul'`
 - **CLI:** `--coverage.perFile`, `--coverage.perFile=false`
 
 Check thresholds per file.
@@ -834,7 +830,7 @@ See `lines`, `functions`, `branches` and `statements` for the actual thresholds.
 
 - **Type:** `boolean`
 - **Default:** `false`
-- **Available for providers:** `'c8' | 'v8' | 'istanbul'`
+- **Available for providers:** `'v8' | 'istanbul'`
 - **CLI:** `--coverage.thresholdAutoUpdate=<boolean>`
 
 Update threshold values `lines`, `functions`, `branches` and `statements` to configuration file when current coverage is above the configured thresholds.
@@ -843,7 +839,7 @@ This option helps to maintain thresholds when coverage is improved.
 #### coverage.lines
 
 - **Type:** `number`
-- **Available for providers:** `'c8' | 'v8' | 'istanbul'`
+- **Available for providers:** `'v8' | 'istanbul'`
 - **CLI:** `--coverage.lines=<number>`
 
 Threshold for lines.
@@ -852,7 +848,7 @@ See [istanbul documentation](https://github.com/istanbuljs/nyc#coverage-threshol
 #### coverage.functions
 
 - **Type:** `number`
-- **Available for providers:** `'c8' | 'v8' | 'istanbul'`
+- **Available for providers:** `'v8' | 'istanbul'`
 - **CLI:** `--coverage.functions=<number>`
 
 Threshold for functions.
@@ -861,7 +857,7 @@ See [istanbul documentation](https://github.com/istanbuljs/nyc#coverage-threshol
 #### coverage.branches
 
 - **Type:** `number`
-- **Available for providers:** `'c8' | 'v8' | 'istanbul'`
+- **Available for providers:** `'v8' | 'istanbul'`
 - **CLI:** `--coverage.branches=<number>`
 
 Threshold for branches.
@@ -870,44 +866,17 @@ See [istanbul documentation](https://github.com/istanbuljs/nyc#coverage-threshol
 #### coverage.statements
 
 - **Type:** `number`
-- **Available for providers:** `'c8' | 'v8' | 'istanbul'`
+- **Available for providers:** `'v8' | 'istanbul'`
 - **CLI:** `--coverage.statements=<number>`
 
 Threshold for statements.
 See [istanbul documentation](https://github.com/istanbuljs/nyc#coverage-thresholds) for more information.
 
-#### coverage.allowExternal
-
-- **Type:** `boolean`
-- **Default:** `false`
-- **Available for providers:** `'c8'`
-- **CLI:** `--coverage.allowExternal`, `--coverage.allowExternal=false`
-
-Allow files from outside of your cwd.
-
-#### coverage.excludeNodeModules
-
-- **Type:** `boolean`
-- **Default:** `true`
-- **Available for providers:** `'c8'`
-- **CLI:** `--coverage.excludeNodeModules`, `--coverage.excludeNodeModules=false`
-
-Exclude coverage under `/node_modules/`.
-
-#### coverage.src
-
-- **Type:** `string[]`
-- **Default:** `process.cwd()`
-- **Available for providers:** `'c8'`
-- **CLI:** `--coverage.src=<path>`
-
-Specifies the directories that are used when `--all` is enabled.
-
 #### coverage.100
 
 - **Type:** `boolean`
 - **Default:** `false`
-- **Available for providers:** `'c8' | 'v8'`
+- **Available for providers:** `'v8'`
 - **CLI:** `--coverage.100`, `--coverage.100=false`
 
 Shortcut for `--check-coverage --lines 100 --functions 100 --branches 100 --statements 100`.
@@ -946,7 +915,7 @@ See [istanbul documentation](https://github.com/istanbuljs/nyc#ignoring-methods)
 }
 ```
 
-- **Available for providers:** `'c8' | 'v8' | 'istanbul'`
+- **Available for providers:** `'v8' | 'istanbul'`
 
 Watermarks for statements, lines, branches and functions. See [istanbul documentation](https://github.com/istanbuljs/nyc#high-and-low-watermarks) for more information.
 

docs/config/index.md

@@ -6,10 +6,6 @@ title: Coverage | Guide
 
 Vitest supports Native code coverage via [`v8`](https://v8.dev/blog/javascript-code-coverage) and instrumented code coverage via [`istanbul`](https://istanbul.js.org/).
 
-:::info
-The `c8` provider is being replaced by the [`v8`](https://v8.dev/blog/javascript-code-coverage) provider. It will be deprecated in the next major version.
-:::
-
 ## Coverage Providers
 
 :::tip

docs/guide/coverage.md

@@ -20,7 +20,7 @@
     "@types/react": "^18.0.24",
     "@types/react-dom": "^18.0.8",
     "@vitejs/plugin-react": "latest",
-    "@vitest/coverage-c8": "^0.24.5",
+    "@vitest/coverage-v8": "latest",
     "@vitest/ui": "latest",
     "jsdom": "latest",
     "typescript": "^4.8.4",

examples/react-testing-lib/package.json

@@ -44,7 +44,6 @@
     "@types/node": "^18.16.19",
     "@types/ws": "^8.5.5",
     "@vitest/browser": "workspace:*",
-    "@vitest/coverage-c8": "workspace:*",
     "@vitest/coverage-istanbul": "workspace:*",
     "@vitest/coverage-v8": "workspace:*",
     "@vitest/ui": "workspace:*",

package.json

@@ -384,7 +384,7 @@ export class ViteNodeRunner {
     // Be careful when changing this
     // changing context will change amount of code added on line :114 (vm.runInThisContext)
     // this messes up sourcemaps for coverage
-    // adjust `offset` variable in packages/coverage-c8/src/provider.ts#86 if you do change this
+    // adjust `WRAPPER_LENGTH` variable in packages/coverage-v8/src/provider.ts if you do change this
     const context = this.prepareContext({
       // esm transformed by Vite
       __vite_ssr_import__: request,

packages/coverage-c8/package.json

@@ -34,8 +34,6 @@ export const coverageConfigDefaults: ResolvedCoverageOptions = {
   exclude: defaultCoverageExcludes,
   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
   extension: ['.js', '.cjs', '.mjs', '.ts', '.mts', '.cts', '.tsx', '.jsx', '.vue', '.svelte'],
 }
 

packages/coverage-c8/rollup.config.js

@@ -5,7 +5,6 @@ interface Loader {
 }
 
 export const CoverageProviderMap: Record<string, string> = {
-  c8: '@vitest/coverage-c8',
   v8: '@vitest/coverage-v8',
   istanbul: '@vitest/coverage-istanbul',
 }
@@ -16,7 +15,7 @@ async function resolveCoverageProviderModule(options: CoverageOptions | undefine
 
   const provider = options.provider
 
-  if (provider === 'c8' || provider === 'v8' || provider === 'istanbul') {
+  if (provider === 'v8' || provider === 'istanbul') {
     const { default: coverageModule } = await loader.executeId(CoverageProviderMap[provider])
 
     if (!coverageModule)

packages/coverage-c8/src/index.ts

@@ -63,17 +63,7 @@ export async function startVitest(
     const requiredPackages = CoverageProviderMap[provider]
 
     if (requiredPackages) {
-      // Remove this message once support for @vitest/coverage-c8 has been removed completely
-      const defaultProviderInfo = 'Default coverage provider has changed from "c8" to "v8". '
-        + 'New package is required to be installed. '
-        + 'To use the old deprecated coverage provider use "--coverage.provider c8" option.\n'
-        + 'See https://github.com/vitest-dev/vitest/pull/3339 for more information.\n\n'
-
-      const isUsingDefaultProvider
-        = ctx.server.config.test?.coverage?.provider === undefined
-        && options.coverage?.provider === undefined
-
-      if (!await ensurePackageInstalled(requiredPackages, root, isUsingDefaultProvider ? defaultProviderInfo : undefined)) {
+      if (!await ensurePackageInstalled(requiredPackages, root)) {
         process.exitCode = 1
         return ctx
       }

packages/coverage-c8/src/provider.ts

@@ -3,7 +3,7 @@ import cac from 'cac'
 import c from 'picocolors'
 import { version } from '../../package.json'
 import { toArray } from '../utils'
-import type { BaseCoverageOptions, CoverageC8Options, CoverageIstanbulOptions, Vitest, VitestRunMode } from '../types'
+import type { BaseCoverageOptions, CoverageIstanbulOptions, Vitest, VitestRunMode } from '../types'
 import type { CliOptions } from './cli-api'
 import { startVitest } from './cli-api'
 import { divider } from './reporters/renderers/utils'
@@ -159,9 +159,6 @@ function normalizeCliOptions(argv: CliOptions): CliOptions {
 
     if ((coverage as CoverageIstanbulOptions).ignoreClassMethods)
       (coverage as CoverageIstanbulOptions).ignoreClassMethods = toArray((coverage as CoverageIstanbulOptions).ignoreClassMethods)
-
-    if ((coverage as CoverageC8Options).src)
-      (coverage as CoverageC8Options).src = toArray((coverage as CoverageC8Options).src)
   }
   return argv
 }

packages/coverage-c8/src/takeCoverage.ts

@@ -117,8 +117,9 @@ export function resolveConfig(
     }
   }
 
-  if (resolved.coverage.provider === 'c8' && resolved.coverage.enabled && isBrowserEnabled(resolved))
-    throw new Error('@vitest/coverage-c8 does not work with --browser. Use @vitest/coverage-istanbul instead')
+  // @ts-expect-error -- check for removed API option
+  if (resolved.coverage.provider === 'c8')
+    throw new Error('"coverage.provider: c8" is not supported anymore. Use "coverage.provider: v8" instead')
 
   if (resolved.coverage.provider === 'v8' && resolved.coverage.enabled && isBrowserEnabled(resolved))
     throw new Error('@vitest/coverage-v8 does not work with --browser. Use @vitest/coverage-istanbul instead')

packages/vite-node/src/client.ts

@@ -9,16 +9,12 @@ const __dirname = url.fileURLToPath(new URL('.', import.meta.url))
 export async function ensurePackageInstalled(
   dependency: string,
   root: string,
-  errorMessage?: string,
 ) {
   if (isPackageExists(dependency, { paths: [root, __dirname] }))
     return true
 
   const promptInstall = !isCI && process.stdout.isTTY
 
-  if (errorMessage)
-    process.stderr.write(c.red(errorMessage))
-
   process.stderr.write(c.red(`${c.inverse(c.red(' MISSING DEP '))} Can not find dependency '${dependency}'\n\n`))
 
   if (!promptInstall)

packages/vitest/src/defaults.ts

@@ -61,14 +61,13 @@ type CoverageReporterWithOptions<ReporterName extends CoverageReporter = Coverag
        : [ReporterName, Partial<ReportOptions[ReporterName]>]
      : never
 
-type Provider = 'c8' | 'v8' | 'istanbul' | 'custom' | undefined
+type Provider = 'v8' | 'istanbul' | 'custom' | undefined
 
 export type CoverageOptions<T extends Provider = Provider> =
   T extends 'istanbul' ? ({ provider: T } & CoverageIstanbulOptions) :
-    T extends 'c8' ? ({ provider: T } & CoverageC8Options) :
-      T extends 'v8' ? ({ provider: T } & CoverageV8Options) :
-        T extends 'custom' ? ({ provider: T } & CustomProviderOptions) :
-            ({ provider?: T } & (CoverageC8Options))
+    T extends '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 =
@@ -228,36 +227,6 @@ export interface CoverageIstanbulOptions extends BaseCoverageOptions {
   ignoreClassMethods?: string[]
 }
 
-export interface CoverageC8Options extends BaseCoverageOptions {
-  /**
-   * Allow files from outside of your cwd.
-   *
-   * @default false
-   */
-  allowExternal?: boolean
-
-  /**
-   * Exclude coverage under `/node_modules/`
-   *
-   * @default true
-   */
-  excludeNodeModules?: boolean
-
-  /**
-   * Specifies the directories that are used when `--all` is enabled.
-   *
-   * @default cwd
-  */
-  src?: string[]
-
-  /**
-   * Shortcut for `--check-coverage --lines 100 --functions 100 --branches 100 --statements 100`
-   *
-   * @default false
-   */
-  100?: boolean
-}
-
 export interface CoverageV8Options extends BaseCoverageOptions {
   /**
    * Shortcut for `--check-coverage --lines 100 --functions 100 --branches 100 --statements 100`

packages/vitest/src/integrations/coverage.ts

@@ -48,10 +48,11 @@ test('inspect-brk cannot be used with threads', async () => {
   expect(stderr).toMatch('Error: You cannot use --inspect-brk without "threads: false" or "singleThread: true"')
 })
 
-test('c8 coverage provider cannot be used with browser', async () => {
-  const { stderr } = await runVitest({ coverage: { enabled: true, provider: 'c8' }, browser: { enabled: true, name: 'chrome' } })
+test('c8 coverage provider is not supported', async () => {
+  // @ts-expect-error -- check for removed API option
+  const { stderr } = await runVitest({ coverage: { enabled: true, provider: 'c8' } })
 
-  expect(stderr).toMatch('Error: @vitest/coverage-c8 does not work with --browser. Use @vitest/coverage-istanbul instead')
+  expect(stderr).toMatch('Error: "coverage.provider: c8" is not supported anymore. Use "coverage.provider: v8" instead')
 })
 
 test('v8 coverage provider cannot be used with browser', async () => {

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

@@ -2,8 +2,7 @@
   "name": "@vitest/test-coverage",
   "private": true,
   "scripts": {
-    "test": "pnpm test:c8 && pnpm test:v8 && pnpm test:istanbul && pnpm test:custom && pnpm test:browser && pnpm test:types",
-    "test:c8": "node ./testing.mjs --provider c8",
+    "test": "pnpm test:v8 && pnpm test:istanbul && pnpm test:custom && pnpm test:browser && pnpm test:types",
     "test:v8": "node ./testing.mjs --provider v8",
     "test:custom": "node ./testing.mjs --provider custom",
     "test:istanbul": "node ./testing.mjs --provider istanbul",
@@ -14,7 +13,6 @@
     "@types/istanbul-lib-coverage": "^2.0.4",
     "@vitejs/plugin-vue": "latest",
     "@vitest/browser": "workspace:*",
-    "@vitest/coverage-c8": "workspace:*",
     "@vitest/coverage-istanbul": "workspace:*",
     "@vitest/coverage-v8": "workspace:*",
     "@vue/test-utils": "latest",

packages/vitest/src/node/cli.ts

@@ -7,7 +7,6 @@ type Configuration = NarrowToTestConfig<(Parameters<typeof defineConfig>[0])>
 type Coverage = NonNullable<Configuration['coverage']>
 
 test('providers, built-in', () => {
-  assertType<Coverage>({ provider: 'c8' })
   assertType<Coverage>({ provider: 'v8' })
   assertType<Coverage>({ provider: 'istanbul' })
 
@@ -23,16 +22,6 @@ test('providers, custom', () => {
 })
 
 test('provider options, generic', () => {
-  assertType<Coverage>({
-    provider: 'c8',
-    enabled: true,
-    include: ['string'],
-    watermarks: {
-      functions: [80, 95],
-      lines: [80, 95],
-    },
-  })
-
   assertType<Coverage>({
     provider: 'v8',
     enabled: true,
@@ -53,22 +42,6 @@ test('provider options, generic', () => {
   })
 })
 
-test('provider specific options, c8', () => {
-  assertType<Coverage>({
-    provider: 'c8',
-    src: ['string'],
-    100: true,
-    excludeNodeModules: false,
-    allowExternal: true,
-  })
-
-  assertType<Coverage>({
-    provider: 'c8',
-    // @ts-expect-error -- Istanbul-only option is not allowed
-    ignoreClassMethods: ['string'],
-  })
-})
-
 test('provider specific options, v8', () => {
   assertType<Coverage>({
     provider: 'v8',

packages/vitest/src/node/config.ts

@@ -33,7 +33,7 @@ const configs = [
   // Run tests for checking coverage report contents.
   ['coverage-report-tests', {
     include: [
-      ['c8', 'v8', 'istanbul'].includes(provider) && './coverage-report-tests/generic.report.test.ts',
+      ['v8', 'istanbul'].includes(provider) && './coverage-report-tests/generic.report.test.ts',
       `./coverage-report-tests/${provider}.report.test.ts`,
     ].filter(Boolean),
     coverage: { enabled: false, clean: false },