feat: new environmentMatchGlobs option to auto infer env based on glob (#2714)

Author: antfu

packages/vitest/src/node/config.ts

@@ -239,6 +239,8 @@ export function resolveConfig(
     ...resolved.typecheck,
   }
 
+  resolved.environmentMatchGlobs = (resolved.environmentMatchGlobs || []).map(i => [resolve(resolved.root, i[0]), i[1]])
+
   if (mode === 'typecheck') {
     resolved.include = resolved.typecheck.include
     resolved.exclude = resolved.typecheck.exclude

packages/vitest/src/runtime/entry.ts

@@ -1,4 +1,5 @@
 import { promises as fs } from 'node:fs'
+import mm from 'micromatch'
 import type { EnvironmentOptions, ResolvedConfig, VitestEnvironment } from '../types'
 import { getWorkerState, resetModules } from '../utils'
 import { vi } from '../integrations/vi'
@@ -31,7 +32,21 @@ export async function run(files: string[], config: ResolvedConfig): Promise<void
   // if calling with no-threads, this will be the whole suite
   const filesWithEnv = await Promise.all(files.map(async (file) => {
     const code = await fs.readFile(file, 'utf-8')
-    const env = code.match(/@(?:vitest|jest)-environment\s+?([\w-]+)\b/)?.[1] || config.environment || 'node'
+
+    // 1. Check for control comments in the file
+    let env = code.match(/@(?:vitest|jest)-environment\s+?([\w-]+)\b/)?.[1]
+    // 2. Check for globals
+    if (!env) {
+      for (const [glob, target] of config.environmentMatchGlobs || []) {
+        if (mm.isMatch(file, glob)) {
+          env = target
+          break
+        }
+      }
+    }
+    // 3. Fallback to global env
+    env ||= config.environment || 'node'
+
     const envOptions = JSON.parse(code.match(/@(?:vitest|jest)-environment-options\s+?(.+)/)?.[1] || 'null')
     return {
       file,

packages/vitest/src/runtime/setup.ts

@@ -7,6 +7,7 @@ import { clearTimeout, getWorkerState, isNode, setTimeout, toArray } from '../ut
 import * as VitestIndex from '../index'
 import { resetRunOnceCounter } from '../integrations/run-once'
 import { RealDate } from '../integrations/mock/date'
+import { expect } from '../integrations/chai'
 import { rpc } from './rpc'
 
 let globalSetup = false
@@ -180,6 +181,11 @@ export async function withEnv(
   fn: () => Promise<void>,
 ) {
   const config: Environment = (environments as any)[name] || await loadEnvironment(name)
+  // @ts-expect-error untyped global
+  globalThis.__vitest_environment__ = config.name || name
+  expect.setState({
+    environment: config.name || name || 'node',
+  })
   const env = await config.setup(globalThis, options)
   try {
     await fn()

packages/vitest/src/types/config.ts

@@ -138,6 +138,22 @@ export interface InlineConfig {
    */
   environmentOptions?: EnvironmentOptions
 
+  /**
+   * Automatically assign environment based on globs. The first match will be used.
+   *
+   * Format: [glob, environment-name]
+   *
+   * @default []
+   * @example [
+   *   // all tests in tests/dom will run in jsdom
+   *   ['tests/dom/**', 'jsdom'],
+   *   // all tests in tests/ with .edge.test.ts will run in edge-runtime
+   *   ['**\/*.edge.test.ts', 'edge-runtime'],
+   *   // ...
+   * ]
+   */
+  environmentMatchGlobs?: [string, VitestEnvironment][]
+
   /**
    * Update snapshot
    *

pnpm-lock.yaml

@@ -0,0 +1,11 @@
+{
+  "name": "@vitest/test-env-glob",
+  "private": true,
+  "scripts": {
+    "test": "vitest",
+    "coverage": "vitest run --coverage"
+  },
+  "devDependencies": {
+    "vitest": "workspace:*"
+  }
+}

test/env-glob/package.json

@@ -0,0 +1,6 @@
+import { expect, test } from 'vitest'
+
+test('glob on extension', () => {
+  expect(typeof window).not.toBe('undefined')
+  expect(expect.getState().environment).toBe('happy-dom')
+})

test/env-glob/test/base.dom.test.ts

@@ -0,0 +1,6 @@
+import { expect, test } from 'vitest'
+
+test('default', () => {
+  expect(typeof window).toBe('undefined')
+  expect(expect.getState().environment).toBe('node')
+})

test/env-glob/test/base.test.ts

@@ -0,0 +1,6 @@
+import { expect, test } from 'vitest'
+
+test('glob on folder', () => {
+  expect(typeof window).not.toBe('undefined')
+  expect(expect.getState().environment).toBe('jsdom')
+})

test/env-glob/test/dom/base.spec.ts

@@ -0,0 +1,9 @@
+import { expect, test } from 'vitest'
+
+/**
+ * @vitest-environment edge-runtime
+ */
+
+test('glob on folder overrides', () => {
+  expect(expect.getState().environment).toBe('edge-runtime')
+})

test/env-glob/test/dom/overrides.spec.ts

@@ -0,0 +1,10 @@
+import { defineConfig } from 'vitest/config'
+
+export default defineConfig({
+  test: {
+    environmentMatchGlobs: [
+      ['**/*.dom.test.ts', 'happy-dom'],
+      ['test/dom/**', 'jsdom'],
+    ],
+  },
+})