refactor: proposal for the public Vitest API

[sheremet-va]

sneaky draft proposal, look away

related #6147

// The main Vitest class
export interface Vitest {
  // the main config from the root of the project
  readonly config: ResolvedConfig
  // instances of projects defined in the workspace config
  // always has at least one project
  readonly projects: Map<string, TestProject>
  // global Vite server instance
  readonly vite: ViteDevServer
  // class that runs tests and stores results
  readonly runner: VitestRunner
  // global inject/provide context
  readonly context: VitestContext
  // snapshot state
  readonly snapshot: VitestSnapshot
  readonly logger: Logger

  onClose(cb: () => void): void

  close(): Promise<void>
  exit(): Promise<void>
}

interface TestProject {
  readonly config: ResolvedProjectConfig
  readonly globalConfig: ResolvedConfig // same as vitest.config
  readonly name: string
  // local project context
  readonly context: VitestContext
  readonly vite: ViteDevServer
  // config that can be sent as a json
  readonly serializedConfig: SerializedConfig
  // browser server instance if tests are running in the browser
  readonly browser: BrowserServer | null
  // an easy way to create a spec
  createSpecification(moduleId: string): TestSpecification
}

export interface VitestRunner {
  // Vitest starts a standalone runner, will react on watch changes, it doesn't run tests
  start: () => void
  stop: () => void

  // Map<filepath, spec[]>
  // unique by project+pool, creating a new spec overrides the old one
  readonly specifications: Map<string, Array<TestSpecification>>

  run: () => Promise<TestRunResult>
  collect: () => Promise<TestRunResult>
  // run module in every project
  runModules: (moduleNames: string[]) => Promise<TestRunResult>
  // run specific tests
  runTests: (specifications: Array<TestSpecification>) => Promise<TestRunResult>
  mergeReports: () => Promise<TestRunResult>
}

interface TestRunResult {
  testModules: TestModule[]
  errors: TestError[]
}

[netlify]

✅ Deploy Preview for vitest-dev ready!

Name	Link
🔨 Latest commit	273affe
🔍 Latest deploy log	https://app.netlify.com/sites/vitest-dev/deploys/66ccba73513a09000875268f
😎 Deploy Preview	https://deploy-preview-6405--vitest-dev.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.