Merge branch 'main' of github.com:vitest-dev/vitest into feat/new-reporter-api

sheremet-va · sheremet-va · commit 3e93fb38cdd4 · 2025-01-14T14:07:52.000+01:00
diff --git a/docs/advanced/reporters.md b/docs/advanced/reporters.md
@@ -36,7 +36,7 @@ export default class CustomReporter extends BaseReporter {
 Or implement the `Reporter` interface:
 
 ```ts [custom-reporter.js]
-import { Reporter } from 'vitest/reporters'
+import type { Reporter } from 'vitest/node'
 
 export default class CustomReporter implements Reporter {
   onCollected() {
@@ -65,9 +65,7 @@ Instead of using the tasks that reporters receive, it is recommended to use the
 You can get access to this API by calling `vitest.state.getReportedEntity(runnerTask)`:
 
 ```ts twoslash
-import type { Vitest } from 'vitest/node'
-import type { RunnerTestFile } from 'vitest'
-import type { Reporter, TestModule } from 'vitest/reporters'
+import type { Reporter, RunnerTestFile, TestModule, Vitest } from 'vitest/node'
 
 class MyReporter implements Reporter {
   private vitest!: Vitest
diff --git a/docs/guide/migration.md b/docs/guide/migration.md
@@ -81,6 +81,10 @@ The [`resolveConfig`](/advanced/api/#resolveconfig) is now more useful. Instead
 
 This function is not used internally and exposed exclusively as a public API.
 
+### Cleaned up `vitest/reporters` types <Badge type="danger">API</Badge> {#cleaned-up-vitest-reporters-types}
+
+The `vitest/reporters` entrypoint now only exports reporters implementations and options types. If you need access to `TestCase`/`TestSuite` and other task related types, import them additionally from `vitest/node`.
+
 ## Migrating to Vitest 2.0 {#vitest-2}
 
 ### Default Pool is `forks`
diff --git a/docs/guide/ui.md b/docs/guide/ui.md
@@ -18,6 +18,10 @@ vitest --ui
 
 Then you can visit the Vitest UI at <a href="http://localhost:51204/__vitest__/">`http://localhost:51204/__vitest__/`</a>
 
+::: warning
+The UI is interactive and requires a running Vite server, so make sure to run Vitest in `watch` mode (the default). Alternatively, you can generate a static HTML report that looks identical to the Vitest UI by specifying `html` in config's `reporters` option.
+:::
+
 <img alt="Vitest UI" img-light src="/ui-1-light.png">
 <img alt="Vitest UI" img-dark src="/ui-1-dark.png">
 
diff --git a/docs/guide/workspace.md b/docs/guide/workspace.md
@@ -44,7 +44,7 @@ export default defineConfig({
 Vitest will treat every folder in `packages` as a separate project even if it doesn't have a config file inside. If this glob pattern matches any file it will be considered a Vitest config even if it doesn't have a `vitest` in its name.
 
 ::: warning
-Vitest does not treat the root `vitest.config` file as a workspace project unless it is explicitly specified in the workspace configuration. Consequently, the root configuration will only influence global options such as `reporters` and `coverage`.
+Vitest does not treat the root `vitest.config` file as a workspace project unless it is explicitly specified in the workspace configuration. Consequently, the root configuration will only influence global options such as `reporters` and `coverage`. Note that Vitest will always run certain plugin hooks, like `apply`, `config`, `configResolved` or `configureServer`, specified in the root config file. Vitest also uses the same plugins to execute global setups, workspace files and custom coverage provider.
 :::
 
 You can also reference projects with their config files:
@@ -233,7 +233,7 @@ bun test --project e2e --project unit
 
 ## Configuration
 
-None of the configuration options are inherited from the root-level config file. You can create a shared config file and merge it with the project config yourself:
+None of the configuration options are inherited from the root-level config file, even if the workspace is defined inside that config and not in a separate `vitest.workspace` file. You can create a shared config file and merge it with the project config yourself:
 
 ```ts [packages/a/vitest.config.ts]
 import { defineProject, mergeConfig } from 'vitest/config'
diff --git a/package.json b/package.json
@@ -37,7 +37,7 @@
   },
   "devDependencies": {
     "@antfu/eslint-config": "^3.11.2",
-    "@antfu/ni": "^0.23.2",
+    "@antfu/ni": "^23.2.0",
     "@playwright/test": "^1.49.1",
     "@rollup/plugin-commonjs": "^28.0.2",
     "@rollup/plugin-json": "^6.1.0",
diff --git a/packages/browser/package.json b/packages/browser/package.json
@@ -94,7 +94,7 @@
     "magic-string": "^0.30.17",
     "msw": "^2.7.0",
     "sirv": "^3.0.0",
-    "tinyrainbow": "^1.2.0",
+    "tinyrainbow": "^2.0.0",
     "ws": "^8.18.0"
   },
   "devDependencies": {
diff --git a/packages/browser/src/client/tester/logger.ts b/packages/browser/src/client/tester/logger.ts
@@ -2,7 +2,7 @@ import { format, stringify } from 'vitest/utils'
 import { getConfig } from '../utils'
 import { rpc } from './rpc'
 
-const { Date, console } = globalThis
+const { Date, console, performance } = globalThis
 
 export function setupConsoleLogSpy() {
   const {
@@ -71,7 +71,7 @@ export function setupConsoleLogSpy() {
     if (!(label in timeLabels)) {
       sendLog('stderr', `Timer "${label}" does not exist`)
     }
-    else if (start) {
+    else if (typeof start !== 'undefined') {
       const duration = end - start
       sendLog('stdout', `${label}: ${duration} ms`)
     }
diff --git a/packages/browser/src/node/plugin.ts b/packages/browser/src/node/plugin.ts
@@ -245,7 +245,15 @@ export default (parentServer: ParentBrowserProject, base = '/'): Plugin[] => {
         }
 
         // since we override the resolution in the esbuild plugin, Vite can no longer optimizer it
-        // have ?. until Vitest 3.0 for backwards compatibility
+        const vue = isPackageExists('vitest-browser-vue', fileRoot)
+        if (vue) {
+          // we override them in the esbuild plugin so optimizer can no longer intercept it
+          include.push(
+            'vitest-browser-vue',
+            'vitest-browser-vue > @vue/test-utils',
+            'vitest-browser-vue > @vue/test-utils > @vue/compiler-core',
+          )
+        }
         const vueTestUtils = isPackageExists('@vue/test-utils', fileRoot)
         if (vueTestUtils) {
           include.push('@vue/test-utils')
@@ -522,10 +530,10 @@ body {
                 {
                   name: 'test-utils-rewrite',
                   setup(build) {
-                    build.onResolve({ filter: /^@vue\/test-utils$/ }, (args) => {
-                      const _require = getRequire()
-                      // resolve to CJS instead of the browser because the browser version expects a global Vue object
-                      const resolved = _require.resolve(args.path, {
+                    // test-utils: resolve to CJS instead of the browser because the browser version expects a global Vue object
+                    // compiler-core: only CJS version allows slots as strings
+                    build.onResolve({ filter: /^@vue\/(test-utils|compiler-core)$/ }, (args) => {
+                      const resolved = getRequire().resolve(args.path, {
                         paths: [args.importer],
                       })
                       return { path: resolved }
diff --git a/packages/coverage-istanbul/package.json b/packages/coverage-istanbul/package.json
@@ -53,7 +53,7 @@
     "istanbul-reports": "^3.1.7",
     "magicast": "^0.3.5",
     "test-exclude": "^7.0.1",
-    "tinyrainbow": "^1.2.0"
+    "tinyrainbow": "^2.0.0"
   },
   "devDependencies": {
     "@types/debug": "^4.1.12",
diff --git a/packages/coverage-v8/package.json b/packages/coverage-v8/package.json
@@ -65,7 +65,7 @@
     "magicast": "^0.3.5",
     "std-env": "^3.8.0",
     "test-exclude": "^7.0.1",
-    "tinyrainbow": "^1.2.0"
+    "tinyrainbow": "^2.0.0"
   },
   "devDependencies": {
     "@types/debug": "^4.1.12",
diff --git a/packages/expect/package.json b/packages/expect/package.json
@@ -37,7 +37,7 @@
     "@vitest/spy": "workspace:*",
     "@vitest/utils": "workspace:*",
     "chai": "^5.1.2",
-    "tinyrainbow": "^1.2.0"
+    "tinyrainbow": "^2.0.0"
   },
   "devDependencies": {
     "@types/chai": "4.3.6",
diff --git a/packages/pretty-format/package.json b/packages/pretty-format/package.json
@@ -34,7 +34,7 @@
     "dev": "rollup -c --watch"
   },
   "dependencies": {
-    "tinyrainbow": "^1.2.0"
+    "tinyrainbow": "^2.0.0"
   },
   "devDependencies": {
     "@types/react-is": "^19.0.0",
diff --git a/packages/ui/package.json b/packages/ui/package.json
@@ -53,7 +53,7 @@
     "pathe": "^2.0.0",
     "sirv": "^3.0.0",
     "tinyglobby": "^0.2.10",
-    "tinyrainbow": "^1.2.0"
+    "tinyrainbow": "^2.0.0"
   },
   "devDependencies": {
     "@faker-js/faker": "^9.3.0",
diff --git a/packages/utils/package.json b/packages/utils/package.json
@@ -66,7 +66,7 @@
   "dependencies": {
     "@vitest/pretty-format": "workspace:*",
     "loupe": "^3.1.2",
-    "tinyrainbow": "^1.2.0"
+    "tinyrainbow": "^2.0.0"
   },
   "devDependencies": {
     "@jridgewell/trace-mapping": "^0.3.25",
diff --git a/packages/vite-node/package.json b/packages/vite-node/package.json
@@ -91,6 +91,6 @@
   "devDependencies": {
     "@jridgewell/trace-mapping": "^0.3.25",
     "@types/debug": "^4.1.12",
-    "tinyrainbow": "^1.2.0"
+    "tinyrainbow": "^2.0.0"
   }
 }
diff --git a/packages/vitest/package.json b/packages/vitest/package.json
@@ -166,14 +166,14 @@
     "tinybench": "^2.9.0",
     "tinyexec": "^0.3.2",
     "tinypool": "^1.0.2",
-    "tinyrainbow": "^1.2.0",
+    "tinyrainbow": "^2.0.0",
     "vite": "^5.0.0 || ^6.0.0",
     "vite-node": "workspace:*",
     "why-is-node-running": "^2.3.0"
   },
   "devDependencies": {
     "@ampproject/remapping": "^2.3.0",
-    "@antfu/install-pkg": "^0.5.0",
+    "@antfu/install-pkg": "^1.0.0",
     "@edge-runtime/vm": "^5.0.0",
     "@sinonjs/fake-timers": "14.0.0",
     "@types/debug": "^4.1.12",
diff --git a/packages/vitest/src/node/cli/cli-api.ts b/packages/vitest/src/node/cli/cli-api.ts
@@ -1,7 +1,7 @@
 import type { UserConfig as ViteUserConfig } from 'vite'
 import type { environments } from '../../integrations/env'
 import type { Vitest, VitestOptions } from '../core'
-import type { TestModule, TestSuite } from '../reporters'
+import type { TestModule, TestSuite } from '../reporters/reported-tasks'
 import type { TestSpecification } from '../spec'
 import type { UserConfig, VitestEnvironment, VitestRunMode } from '../types/config'
 import { mkdirSync, writeFileSync } from 'node:fs'
diff --git a/packages/vitest/src/node/core.ts b/packages/vitest/src/node/core.ts
@@ -205,6 +205,7 @@ export class Vitest {
     this._workspaceConfigPath = undefined
     this.coverageProvider = undefined
     this.runningPromise = undefined
+    this.coreWorkspaceProject = undefined
     this.specifications.clearCache()
     this._onUserTestsRerun = []
 
diff --git a/packages/vitest/src/node/pool.ts b/packages/vitest/src/node/pool.ts
@@ -3,6 +3,7 @@ import type { Vitest } from './core'
 import type { TestProject } from './project'
 import type { TestSpecification } from './spec'
 import type { BuiltinPool, Pool } from './types/pool-options'
+import { isatty } from 'node:tty'
 import mm from 'micromatch'
 import { isWindows } from '../utils/env'
 import { createForksPool } from './pools/forks'
@@ -124,6 +125,7 @@ export function createPool(ctx: Vitest): ProcessPool {
         VITEST: 'true',
         NODE_ENV: process.env.NODE_ENV || 'test',
         VITEST_MODE: ctx.config.watch ? 'WATCH' : 'RUN',
+        FORCE_TTY: isatty(1) ? 'true' : '',
         ...process.env,
         ...ctx.config.env,
       },
diff --git a/packages/vitest/src/node/project.ts b/packages/vitest/src/node/project.ts
@@ -491,10 +491,8 @@ export class TestProject {
     return testFiles
   }
 
-  /** @internal */
-  _parentBrowser?: ParentProjectBrowser
-  /** @internal */
-  _parent?: TestProject
+  private _parentBrowser?: ParentProjectBrowser
+  private _parent?: TestProject
   /** @internal */
   _initParentBrowser = deduped(async () => {
     if (!this.isBrowserEnabled() || this._parentBrowser) {
@@ -719,7 +717,6 @@ export interface SerializedTestProject {
 
 interface InitializeProjectOptions extends UserWorkspaceConfig {
   configFile: string | false
-  extends?: string
 }
 
 export async function initializeProject(
@@ -729,7 +726,7 @@ export async function initializeProject(
 ) {
   const project = new TestProject(workspacePath, ctx, options)
 
-  const { extends: extendsConfig, configFile, ...restOptions } = options
+  const { configFile, ...restOptions } = options
 
   const config: ViteInlineConfig = {
     ...restOptions,
diff --git a/packages/vitest/src/node/reporters/benchmark/index.ts b/packages/vitest/src/node/reporters/benchmark/index.ts
@@ -1,6 +1,11 @@
 import { BenchmarkReporter } from './reporter'
 import { VerboseBenchmarkReporter } from './verbose'
 
+export {
+  BenchmarkReporter,
+  VerboseBenchmarkReporter,
+}
+
 export const BenchmarkReportsMap = {
   default: BenchmarkReporter,
   verbose: VerboseBenchmarkReporter,
diff --git a/packages/vitest/src/node/reporters/index.ts b/packages/vitest/src/node/reporters/index.ts
@@ -3,7 +3,6 @@ import type { BaseOptions, BaseReporter } from './base'
 import type { BlobOptions } from './blob'
 import type { DefaultReporterOptions } from './default'
 import type { HTMLOptions } from './html'
-import type { ModuleDiagnostic as _FileDiagnostic } from './reported-tasks'
 import { BasicReporter } from './basic'
 import { BlobReporter } from './blob'
 import { DefaultReporter } from './default'
@@ -12,7 +11,6 @@ import { GithubActionsReporter } from './github-actions'
 import { HangingProcessReporter } from './hanging-process'
 import { type JsonOptions, JsonReporter } from './json'
 import { type JUnitOptions, JUnitReporter } from './junit'
-import { TestModule as _TestFile } from './reported-tasks'
 import { TapReporter } from './tap'
 import { TapFlatReporter } from './tap-flat'
 import { VerboseReporter } from './verbose'
@@ -31,24 +29,17 @@ export {
 }
 export type { BaseReporter, Reporter }
 
-export type { TestProject } from '../project'
-/**
- * @deprecated Use `TestModule` instead
- */
-export const TestFile = _TestFile
-export type { TestSpecification } from '../spec'
-export * from './benchmark'
+export {
+  BenchmarkBuiltinReporters,
+  BenchmarkReporter,
+  BenchmarkReportsMap,
+  VerboseBenchmarkReporter,
+} from './benchmark'
 export type {
   JsonAssertionResult,
   JsonTestResult,
   JsonTestResults,
 } from './json'
-/**
- * @deprecated Use `ModuleDiagnostic` instead
- */
-export type FileDiagnostic = _FileDiagnostic
-
-export type { TestCase, TestModule, TestSuite } from './reported-tasks'
 
 export const ReportersMap = {
   'default': DefaultReporter,
@@ -79,18 +70,3 @@ export interface BuiltinReporterOptions {
   'hanging-process': never
   'html': HTMLOptions
 }
-
-export type {
-  ReportedHookContext,
-  TaskOptions,
-
-  TestCollection,
-  TestDiagnostic,
-
-  TestResult,
-  TestResultFailed,
-  TestResultPassed,
-  TestResultSkipped,
-} from './reported-tasks'
-export type { SerializedError } from '@vitest/utils'
-export type TestRunEndReason = 'passed' | 'interrupted' | 'failed'
diff --git a/packages/vitest/src/node/specifications.ts b/packages/vitest/src/node/specifications.ts
@@ -1,5 +1,5 @@
 import type { Vitest } from './core'
-import type { TestProject } from './reporters'
+import type { TestProject } from './project'
 import type { TestSpecification } from './spec'
 import { existsSync } from 'node:fs'
 import mm from 'micromatch'
diff --git a/packages/vitest/src/node/types/tests.ts b/packages/vitest/src/node/types/tests.ts
@@ -1,4 +1,4 @@
-import type { TestModule } from '../reporters'
+import type { TestModule } from '../reporters/reported-tasks'
 
 export interface TestRunResult {
   testModules: TestModule[]
diff --git a/packages/vitest/src/node/watcher.ts b/packages/vitest/src/node/watcher.ts
@@ -1,5 +1,5 @@
 import type { Vitest } from './core'
-import type { TestProject } from './reporters'
+import type { TestProject } from './project'
 import { readFileSync } from 'node:fs'
 import { noop, slash } from '@vitest/utils'
 import mm from 'micromatch'
diff --git a/packages/vitest/src/node/workspace/resolveWorkspace.ts b/packages/vitest/src/node/workspace/resolveWorkspace.ts
@@ -62,11 +62,9 @@ export async function resolveWorkspace(
     // if extends a config file, resolve the file path
     const configFile = typeof options.extends === 'string'
       ? resolve(configRoot, options.extends)
-      : false
-    // if extends a root config, use the users root options
-    const rootOptions = options.extends === true
-      ? vitest._options
-      : {}
+      : options.extends === true
+        ? (vitest.vite.config.configFile || false)
+        : false
     // if `root` is configured, resolve it relative to the workspace file or vite root (like other options)
     // if `root` is not specified, inline configs use the same root as the root project
     const root = options.root
@@ -75,7 +73,7 @@ export async function resolveWorkspace(
     projectPromises.push(concurrent(() => initializeProject(
       index,
       vitest,
-      mergeConfig(rootOptions, { ...options, root, configFile }) as any,
+      { ...options, root, configFile },
     )))
   })
 
diff --git a/packages/vitest/src/public/node.ts b/packages/vitest/src/public/node.ts
diff --git a/packages/vitest/src/public/reporters.ts b/packages/vitest/src/public/reporters.ts
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/test/browser/specs/runner.test.ts b/test/browser/specs/runner.test.ts
diff --git a/test/browser/test/timers.test.ts b/test/browser/test/timers.test.ts
diff --git a/test/config/fixtures/workspace/browser/workspace-with-browser.ts b/test/config/fixtures/workspace/browser/workspace-with-browser.ts
diff --git a/test/config/fixtures/workspace/config-extends/repro.test.js b/test/config/fixtures/workspace/config-extends/repro.test.js
diff --git a/test/config/fixtures/workspace/config-extends/vitest.config.ts b/test/config/fixtures/workspace/config-extends/vitest.config.ts
diff --git a/test/config/test/console-color.test.ts b/test/config/test/console-color.test.ts
diff --git a/test/config/test/workspace.test.ts b/test/config/test/workspace.test.ts
diff --git a/test/core/package.json b/test/core/package.json
diff --git a/test/test-utils/package.json b/test/test-utils/package.json
