feat(coverage): glob based coverage thresholds

packages/coverage-istanbul/package.json

@@ -50,6 +50,7 @@
     "istanbul-lib-report": "^3.0.1",
     "istanbul-lib-source-maps": "^4.0.1",
     "istanbul-reports": "^3.1.6",
+    "magicast": "^0.3.2",
     "picocolors": "^1.0.0",
     "test-exclude": "^6.0.0"
   },

packages/coverage-istanbul/src/provider.ts

@@ -4,6 +4,7 @@ import type { AfterSuiteRunMeta, CoverageIstanbulOptions, CoverageProvider, Repo
 import { coverageConfigDefaults, defaultExclude, defaultInclude } from 'vitest/config'
 import { BaseCoverageProvider } from 'vitest/coverage'
 import c from 'picocolors'
+import { parseModule } from 'magicast'
 import libReport from 'istanbul-lib-report'
 import reports from 'istanbul-reports'
 import type { CoverageMap, CoverageMapData } from 'istanbul-lib-coverage'
@@ -65,10 +66,6 @@ export class IstanbulCoverageProvider extends BaseCoverageProvider implements Co
       provider: 'istanbul',
       reportsDirectory: resolve(ctx.config.root, config.reportsDirectory || coverageConfigDefaults.reportsDirectory),
       reporter: this.resolveReporters(config.reporter || coverageConfigDefaults.reporter),
-      lines: config['100'] ? 100 : config.lines,
-      functions: config['100'] ? 100 : config.functions,
-      branches: config['100'] ? 100 : config.branches,
-      statements: config['100'] ? 100 : config.statements,
     }
 
     this.instrumenter = createInstrumenter({
@@ -170,34 +167,26 @@ export class IstanbulCoverageProvider extends BaseCoverageProvider implements Co
       }).execute(context)
     }
 
-    if (this.options.branches
-      || this.options.functions
-      || this.options.lines
-      || this.options.statements) {
-      this.checkThresholds({
+    if (this.options.thresholds) {
+      const resolvedThresholds = this.resolveThresholds({
         coverageMap,
-        thresholds: {
-          branches: this.options.branches,
-          functions: this.options.functions,
-          lines: this.options.lines,
-          statements: this.options.statements,
-        },
-        perFile: this.options.perFile,
+        thresholds: this.options.thresholds,
+        createCoverageMap: () => libCoverage.createCoverageMap({}),
       })
-    }
 
-    if (this.options.thresholdAutoUpdate && allTestsRun) {
-      this.updateThresholds({
-        coverageMap,
-        thresholds: {
-          branches: this.options.branches,
-          functions: this.options.functions,
-          lines: this.options.lines,
-          statements: this.options.statements,
-        },
-        perFile: this.options.perFile,
-        configurationFile: this.ctx.server.config.configFile,
+      this.checkThresholds({
+        thresholds: resolvedThresholds,
+        perFile: this.options.thresholds.perFile,
       })
+
+      if (this.options.thresholds.autoUpdate && allTestsRun) {
+        this.updateThresholds({
+          thresholds: resolvedThresholds,
+          perFile: this.options.thresholds.perFile,
+          configurationFile: this.ctx.server.config.configFile,
+          parseModule,
+        })
+      }
     }
   }
 

packages/coverage-v8/package.json

@@ -52,6 +52,7 @@
     "istanbul-lib-source-maps": "^4.0.1",
     "istanbul-reports": "^3.1.6",
     "magic-string": "^0.30.5",
+    "magicast": "^0.3.2",
     "picocolors": "^1.0.0",
     "std-env": "^3.4.3",
     "test-exclude": "^6.0.0",

packages/coverage-v8/src/provider.ts

@@ -9,6 +9,7 @@ import type { CoverageMap, CoverageMapData } from 'istanbul-lib-coverage'
 import libCoverage from 'istanbul-lib-coverage'
 import libSourceMaps from 'istanbul-lib-source-maps'
 import MagicString from 'magic-string'
+import { parseModule } from 'magicast'
 import remapping from '@ampproject/remapping'
 import { normalize, resolve } from 'pathe'
 import c from 'picocolors'
@@ -72,10 +73,6 @@ export class V8CoverageProvider extends BaseCoverageProvider implements Coverage
       provider: 'v8',
       reporter: this.resolveReporters(config.reporter || coverageConfigDefaults.reporter),
       reportsDirectory: resolve(ctx.config.root, config.reportsDirectory || coverageConfigDefaults.reportsDirectory),
-      lines: config['100'] ? 100 : config.lines,
-      functions: config['100'] ? 100 : config.functions,
-      branches: config['100'] ? 100 : config.branches,
-      statements: config['100'] ? 100 : config.statements,
     }
 
     this.testExclude = new _TestExclude({
@@ -156,34 +153,26 @@ export class V8CoverageProvider extends BaseCoverageProvider implements Coverage
       }).execute(context)
     }
 
-    if (this.options.branches
-      || this.options.functions
-      || this.options.lines
-      || this.options.statements) {
-      this.checkThresholds({
+    if (this.options.thresholds) {
+      const resolvedThresholds = this.resolveThresholds({
         coverageMap,
-        thresholds: {
-          branches: this.options.branches,
-          functions: this.options.functions,
-          lines: this.options.lines,
-          statements: this.options.statements,
-        },
-        perFile: this.options.perFile,
+        thresholds: this.options.thresholds,
+        createCoverageMap: () => libCoverage.createCoverageMap({}),
       })
-    }
 
-    if (this.options.thresholdAutoUpdate && allTestsRun) {
-      this.updateThresholds({
-        coverageMap,
-        thresholds: {
-          branches: this.options.branches,
-          functions: this.options.functions,
-          lines: this.options.lines,
-          statements: this.options.statements,
-        },
-        perFile: this.options.perFile,
-        configurationFile: this.ctx.server.config.configFile,
+      this.checkThresholds({
+        thresholds: resolvedThresholds,
+        perFile: this.options.thresholds.perFile,
       })
+
+      if (this.options.thresholds.autoUpdate && allTestsRun) {
+        this.updateThresholds({
+          thresholds: resolvedThresholds,
+          perFile: this.options.thresholds.perFile,
+          configurationFile: this.ctx.server.config.configFile,
+          parseModule,
+        })
+      }
     }
   }
 

packages/vitest/package.json

@@ -179,6 +179,7 @@
     "happy-dom": "^12.10.3",
     "jsdom": "^22.1.0",
     "log-update": "^6.0.0",
+    "magicast": "^0.3.2",
     "micromatch": "^4.0.5",
     "p-limit": "^5.0.0",
     "pretty-format": "^29.7.0",

packages/vitest/src/types/coverage.ts

@@ -157,40 +157,27 @@ export interface BaseCoverageOptions {
   skipFull?: boolean
 
   /**
-   * Check thresholds per file.
-   * See `lines`, `functions`, `branches` and `statements` for the actual thresholds.
+   * Configurations for thresholds
    *
-   * @default false
-   */
-  perFile?: boolean
-
-  /**
-   * Threshold for lines
-   *
-   * @default undefined
-   */
-  lines?: number
-
-  /**
-   * Threshold for functions
-   *
-   * @default undefined
-   */
-  functions?: number
-
-  /**
-   * Threshold for branches
+   * @example
    *
-   * @default undefined
-   */
-  branches?: number
-
-  /**
-   * Threshold for statements
+   * ```ts
+   * {
+   *   // Thresholds for all files
+   *   functions: 95,
+   *   branches: 70,
+   *   perFile: true,
+   *   autoUpdate: true,
    *
-   * @default undefined
+   *   // Thresholds for utilities
+   *   'src/utils/**.ts': {
+   *     lines: 100,
+   *     statements: 95,
+   *   }
+   * }
+   * ```
    */
-  statements?: number
+  thresholds?: Thresholds | ({ [glob: string]: Pick<Thresholds, 'statements' | 'functions' | 'branches' | 'lines'> } & Thresholds)
 
   /**
    * Watermarks for statements, lines, branches and functions.
@@ -204,13 +191,6 @@ export interface BaseCoverageOptions {
     lines?: [number, number]
   }
 
-  /**
-   * Update threshold values automatically when current coverage is higher than earlier thresholds
-   *
-   * @default false
-   */
-  thresholdAutoUpdate?: boolean
-
   /**
    * Generate coverage report even when tests fail.
    *
@@ -224,13 +204,6 @@ export interface BaseCoverageOptions {
    * @default false
    */
   allowExternal?: boolean
-
-  /**
-   * Shortcut for `{ lines: 100, functions: 100, branches: 100, statements: 100 }`
-   *
-   * @default false
-   */
-  100?: boolean
 }
 
 export interface CoverageIstanbulOptions extends BaseCoverageOptions {
@@ -248,3 +221,30 @@ export interface CustomProviderOptions extends Pick<BaseCoverageOptions, FieldsW
   /** Name of the module or path to a file to load the custom provider from */
   customProviderModule: string
 }
+
+interface Thresholds {
+  /** Set global thresholds to `100` */
+  100?: boolean
+
+  /** Check thresholds per file. */
+  perFile?: boolean
+
+  /**
+   * Update threshold values automatically when current coverage is higher than earlier thresholds
+   *
+   * @default false
+   */
+  autoUpdate?: boolean
+
+  /** Thresholds for statements */
+  statements?: number
+
+  /** Thresholds for functions */
+  functions?: number
+
+  /** Thresholds for branches */
+  branches?: number
+
+  /** Thresholds for lines */
+  lines?: number
+}