feat!(coverage): glob based coverage thresholds

[AriPerkkio]

Description

Closes #3709.

Refactors coverage thresholds API into new shape and adds support for specifying thresholds for specific files using glob patterns. Introducing breaking changes for the configuration options made sense here and final results looks clean and simple.

import { defineConfig } from "vitest/config";

export default defineConfig({
  test: {
    coverage: {
      thresholds: {
        100: false,
        perFile: true,
        autoUpdate: true,

        // Thresholds for all files
        lines: 100,
        functions: 100,
        branches: 80,
        statements: 90,

        // Thresholds for utilities
        "**/utils/**": {
          lines: 80,
          statements: 50,
        },
      },
    },
  },
});

BREAKING CHANGES

• coverage.perFile is now coverage.thresholds.perFile
• coverage.thresholdAutoUpdate is now coverage.thresholds.autoUpdate
• coverage.100 is now coverage.thresholds.100
• coverage.lines is now coverage.thresholds.lines
• coverage.functions is now coverage.thresholds.functions
• coverage.branches is now coverage.thresholds.branches
• coverage.statements is now coverage.thresholds.statements

Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

• It's really useful if your PR references an issue where it is discussed ahead of time. If the feature is substantial or introduces breaking changes without a discussion, PR might be closed.
• Ideally, include a test that fails without this PR but passes with it.
• Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Tests

• Run the tests with pnpm test:ci.

Documentation

• If you introduce new functionality, document it. You can run documentation with pnpm run docs command.

Changesets

• Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.

[stackblitz]

Run & review this pull request in StackBlitz Codeflow.

[netlify]

✅ Deploy Preview for fastidious-cascaron-4ded94 canceled.

Name	Link
🔨 Latest commit	8dd1640
🔍 Latest deploy log	https://app.netlify.com/sites/fastidious-cascaron-4ded94/deploys/655630028b12f3000816be58

[arian921017]

@AriPerkkio
Can you make a patched version? We really need this feature

[AriPerkkio]

@arianshirepublik this feature is not yet finished but should make it to v1 release. I'm introducing some breaking changes to coverage option structure at the same time.

[AriPerkkio]

Adding support to thresholdAutoUpdate now that there are multiple different coverage thresholds in configuration file is a bit tricky. Earlier we've used just search-and-replace with regexp but now we may need to parse the configuration file's AST.

[sheremet-va]

Adding support to thresholdAutoUpdate now that there are multiple different coverage thresholds in configuration file is a bit tricky. Earlier we've used just search-and-replace with regexp but now we may need to parse the configuration file's AST.

Maybe you can try https://github.com/unjs/magicast ?

[arian921017]

@arianshirepublik this feature is not yet finished but should make it to v1 release. I'm introducing some breaking changes to coverage option structure at the same time.

Hi @AriPerkkio
Can we use this feature in v1.0.0-beta.4?

[AriPerkkio]

No, this feature is not yet finished. Please wait patiently 😄
I'm planning to finalize this during this week.

[arian921017]

Hi @AriPerkkio
I tested v1.0.0-beta.5
The report will not be generated. Can you check it?

[arian921017]

Hi @AriPerkkio

When I run the command: yarn run test --coverage,

The desired test case has been executed but no test report or coverage table has been generated, and then the program stops here.

My config:

test: {
      setupFiles: './src/test/setup.ts',
      globals: true,
      environment: 'jsdom',
      coverage: {
        reporter: ['text', 'json-summary', 'json'],
        thresholds: {
          100: true,
          perFile: true,
          autoUpdate: true,

          // Thresholds for all files
          lines: 100,
          functions: 100,
          branches: 100,
          statements: 100,
        },
      },
    }

I can't see this table:

[AriPerkkio]

@arianshirepublik please open new issue with reproducible setup.