vitest 0.0.72 → 0.0.73

package/README.gh.md

@@ -11,6 +11,14 @@ A blazing fast unit test framework powered by Vite.
 <p align="center">
   <a href="https://www.npmjs.com/package/vitest"><img src="https://img.shields.io/npm/v/vitest?color=a1b858&label="></a>
 <p>
+<h2 align="center">
+<a href="https://preview.vitest.dev">Open the Docs</a>
+</h2>
+<h3 align="center">
+<a href=https://discord.com/invite/2zYZNngd7y"><i>Get involved!</i></a>
+</h3>
+<br>
+<br>
 
 > 💖 **This project is currently in closed beta exclusively for Sponsors.**<br>
 > Become a Sponsor of [@patak-dev](https://github.com/sponsors/patak-dev) or [@antfu](https://github.com/sponsors/antfu) to access the source code and issues tracker.
@@ -19,7 +27,8 @@ A blazing fast unit test framework powered by Vite.
 
 > Vitest requires Vite v2.7 and Node v16
 
-[**Join the Discord!**](https://discord.com/invite/2zYZNngd7y)
+
+Switch to Vitest by following the [Getting Started Guide](https://preview.vitest.dev/guide) or learn [why we are building a new test runner](https://preview.vitest.dev/guide).
 
 ## Features
 
@@ -74,281 +83,6 @@ $ npx vitest
 - [unplugin-vue-components](https://github.com/antfu/unplugin-vue-components)
 - [vitesse-lite](https://github.com/antfu/vitesse-lite)
 
-## Configuration
-
-`vitest` will read your root `vite.config.ts` when it present to match with the plugins and setup as your Vite app. If you want to it to have a different configuration for testing, you could either:
-
-- Create `vitest.config.ts`, which will have the higher priority
-- Pass `--config` option to CLI, e.g. `vitest --config ./path/to/vitest.config.ts`
-- Use `process.env.VITEST` to conditionally apply different configuration in `vite.config.ts`
-
-To configure `vitest` itself, add `test` property in your Vite config
-
-```ts
-// vite.config.ts
-import { defineConfig } from 'vite'
-
-export default defineConfig({
-  test: {
-    // ...
-  }
-})
-```
-
-## Global APIs
-
-By default, `vitest` does not provide global APIs for explicitness. If you prefer to use the APIs globally like Jest, you can pass the `--global` option to CLI or add `global: true` in the config.
-
-```ts
-// vite.config.ts
-import { defineConfig } from 'vite'
-
-export default defineConfig({
-  test: {
-    global: true
-  }
-})
-```
-
-To get TypeScript working with the global APIs, add `vitest/global` to the `types` filed in your `tsconfig.json`
-
-```jsonc
-// tsconfig.json
-{
-  "compilerOptions": {
-    "types": [
-      "vitest/global"
-    ]
-  }
-}
-```
-
-If you are already using [`unplugin-auto-import`](https://github.com/antfu/unplugin-vue-components) in your project, you can also use it directly for auto importing those APIs.
-
-```ts
-// vite.config.ts
-import { defineConfig } from 'vite'
-import AutoImport from 'unplugin-auto-import/vite'
-
-export default defineConfig({
-  plugins: [
-    AutoImport({
-      imports: ['vitest'],
-      dts: true // generate TypeScript declaration
-    })
-  ]
-})
-```
-
-## Browser Mocking
-
-Vitest supports both [happy-dom](https://github.com/capricorn86/happy-dom) or [jsdom](https://github.com/jsdom/jsdom) for mocking DOM and browser APIs. They don't come with Vitest, you might need to install them:
-
-```bash
-$ npm i -D happy-dom
-# or
-$ npm i -D jsdom
-```
-
-After that, change the `environment` option in your config file:
-
-```ts
-// vite.config.ts
-import { defineConfig } from 'vite'
-
-export default defineConfig({
-  test: {
-    environment: 'happy-dom' // or 'jsdom', 'node'
-  }
-})
-```
-
-## Watch Mode
-
-```bash
-$ vitest -w
-```
-
-Vitest smartly searches the module graph and only rerun the related tests (just like how HMR works in Vite!).
-
-## Coverage
-
-Vitest works perfectly with [c8](https://github.com/bcoe/c8)
-
-```bash
-$ npm i -D c8
-$ c8 vitest
-```
-
-```json
-{
-  "scripts": {
-    "test": "vitest",
-    "coverage": "c8 vitest"
-  }
-}
-```
-
-For convenience, we also provide a shorthand for passing `--coverage` option to CLI, which will wrap the process with `c8` for you. Note when using the shorthand, you will lose the ability to pass additional options to `c8`.
-
-```bash
-$ vitest --coverage
-```
-
-For more configuration available, please refer to [c8](https://github.com/bcoe/c8)'s documentation.
-
-## Filtering
-
-### CLI
-
-You can use CLI to filter test files my name:
-
-```bash
-$ vitest basic
-```
-
-Will only execute test files that contain `basic`, e.g.
-
-```
-basic.test.ts
-basic-foo.test.ts
-```
-
-### Specifying a Timeout
-
-You can optionally pass a timeout in milliseconds as third argument to tests. The default is 5 seconds.
-
-```ts
-test('name', async() => { ... }, 1000)
-```
-
-Hooks also can receive a timeout, with the same 5 seconds default.
-
-```ts
-beforeAll( async() => { ... }, 1000)
-```
-
-### Skipping suites and tests
-
-Use `.skip` to avoid running certain suites or tests 
-
-```ts
-describe.skip('skipped suite', () => {
-  it('test', () => {
-    // Suite skipped, no error
-    assert.equal(Math.sqrt(4), 3)
-  })
-})
-
-describe('suite', () => {
-  it.skip('skipped test', () => {
-    // Test skipped, no error
-    assert.equal(Math.sqrt(4), 3)
-  })
-})
-```
-
-### Selecting suites and tests to run
-
-Use `.only` to only run certain suites or tests 
-
-```ts
-// Only this suite (and others marked with only) are run
-describe.only('suite', () => {
-  it('test', () => {
-    assert.equal(Math.sqrt(4), 3) 
-  })
-})
-
-describe('another suite', () => {
-  it('skipped test', () => {
-     // Test skipped, as tests are running in Only mode
-    assert.equal(Math.sqrt(4), 3)
-  })
-
-  it.only('test', () => {
-     // Only this test (and others marked with only) are run
-    assert.equal(Math.sqrt(4), 2)
-  })
-})
-```
-
-### Unimplemented suites and tests
-
-Use `.todo` to stub suites and tests that should be implemented
-
-```ts
- // An entry will be shown in the report for this suite
-describe.todo('unimplemented suite')
-
-// An entry will be shown in the report for this test
-describe('suite', () => {
-  it.todo('unimplemented test')
-})
-```
-
-### Running tests concurrently
-
-Use `.concurrent` in consecutive tests to run them in parallel
-
-```ts
-// The two tests marked with concurrent will be run in parallel
-describe('suite', () => {
-  it('serial test', () => {
-    assert.equal(Math.sqrt(4), 3)
-  })
-  it.concurrent('concurrent test 1', () => {
-    assert.equal(Math.sqrt(4), 3)
-  })
-  it.concurrent('concurrent test 2', () => {
-    assert.equal(Math.sqrt(4), 3)
-  })
-})
-```
-
-If you use `.concurrent` in a suite, every tests in it will be run in parallel
-```ts
-// The two tests marked with concurrent will be run in parallel
-describe.concurrent('suite', () => {
-  it('concurrent test 1', () => {
-    assert.equal(Math.sqrt(4), 3)
-  })
-  it('concurrent test 2', () => {
-    assert.equal(Math.sqrt(4), 3)
-  })
-  // No effect, same as not using .concurrent
-  it.concurrent('concurrent test 3', () => {
-    assert.equal(Math.sqrt(4), 3)
-  })
-})
-```
-
-You can also use `.skip`, `.only`, and `.todo` with concurrent suite and tests. All the following combinations are valid:
-```js
-describe.concurrent(...)
-
-describe.skip.concurrent(...)
-describe.concurrent.skip(...)
-
-describe.only.concurrent(...)
-describe.concurrent.only(...)
-
-describe.todo.concurrent(...)
-describe.concurrent.todo(...)
-
-it.concurrent(...)
-
-it.skip.concurrent(...)
-it.concurrent.skip(...)
-
-it.only.concurrent(...)
-it.concurrent.only(...)
-
-it.todo.concurrent(...)
-it.concurrent.todo(...)
-```
-
-
 ## Sponsors
 
 <p align="center">

package/dist/cli.js

@@ -1,5 +1,5 @@
 import require$$2, { EventEmitter } from 'events';
-import { s as stringWidth, a as ansiStyles, b as stripAnsi, c as sliceAnsi, d as c, F as F_POINTER, e as F_DOWN, f as F_DOWN_RIGHT, g as F_DOT, h as F_CHECK, i as F_CROSS, j as cliTruncate, k as F_RIGHT, p as printError } from './error-fb6ff2e6.js';
+import { s as stringWidth, a as ansiStyles, b as stripAnsi, c as sliceAnsi, d as c, F as F_POINTER, e as F_DOWN, f as F_DOWN_RIGHT, g as F_DOT, h as F_CHECK, i as F_CROSS, j as cliTruncate, k as F_RIGHT, p as printError } from './error-5a04e54b.js';
 import { performance } from 'perf_hooks';
 import path, { isAbsolute, relative, dirname, basename, resolve } from 'path';
 import { g as getNames, s as slash, a as getTests, b as getSuites, t as toArray, h as hasFailed } from './utils-9dcc4050.js';
@@ -632,7 +632,7 @@ const cac = (name = "") => new CAC(name);
 
 var commonjsGlobal = typeof globalThis !== 'undefined' ? globalThis : typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {};
 
-var version = "0.0.72";
+var version = "0.0.73";
 
 const ESC = '\u001B[';
 const OSC = '\u001B]';
@@ -1441,7 +1441,7 @@ function createLogUpdate(stream, {showCursor = false} = {}) {
 	return render;
 }
 
-createLogUpdate(process$2.stdout);
+const logUpdate = createLogUpdate(process$2.stdout);
 
 createLogUpdate(process$2.stderr);
 
@@ -1573,9 +1573,8 @@ function renderTree(tasks, level = 0) {
 const createRenderer = (_tasks) => {
   let tasks = _tasks;
   let timer;
-  const log = createLogUpdate(process.stdout);
   function update() {
-    log(renderTree(tasks));
+    logUpdate(renderTree(tasks));
   }
   return {
     start() {
@@ -1594,9 +1593,12 @@ const createRenderer = (_tasks) => {
         clearInterval(timer);
         timer = void 0;
       }
-      log.clear();
+      logUpdate.clear();
       console.log(renderTree(tasks));
       return this;
+    },
+    clear() {
+      logUpdate.clear();
     }
   };
 };
@@ -1732,6 +1734,14 @@ ${c.bold(c.inverse(c.green(" PASS ")))}${c.green(" Waiting for file changes...")
     this.renderer = void 0;
     await new Promise((resolve) => setTimeout(resolve, 100));
   }
+  onUserConsoleLog(log) {
+    var _a;
+    (_a = this.renderer) == null ? void 0 : _a.clear();
+    const task = log.taskId ? this.ctx.state.idMap[log.taskId] : void 0;
+    console.log(c.gray(`${log.type} | ${task ? c.dim(getFullName(task)) : "unknown test"}`));
+    process[log.type].write(`${log.content}
+`);
+  }
 }
 
 class SnapshotManager {
@@ -2172,7 +2182,8 @@ function createFakePool(ctx) {
 }
 function createWorkerPool(ctx) {
   const options = {
-    filename: workerPath
+    filename: workerPath,
+    useAtomics: false
   };
   if (ctx.config.maxThreads != null)
     options.maxThreads = ctx.config.maxThreads;
@@ -2203,7 +2214,7 @@ function createChannel(ctx) {
   const port = channel.port2;
   const workerPort = channel.port1;
   port.on("message", async ({ id, method, args = [] }) => {
-    var _a, _b, _c, _d;
+    var _a, _b, _c, _d, _e, _f;
     async function send(fn) {
       try {
         port.postMessage({ id, result: await fn() });
@@ -2224,6 +2235,9 @@ function createChannel(ctx) {
         ctx.state.updateTasks([args[0]]);
         (_d = (_c = ctx.reporter).onTaskUpdate) == null ? void 0 : _d.call(_c, args[0]);
         return;
+      case "log":
+        (_f = (_e = ctx.reporter).onUserConsoleLog) == null ? void 0 : _f.call(_e, args[0]);
+        return;
     }
     console.error("Unhandled message", method, args);
   });

package/dist/entry.js

@@ -1,3 +1,5 @@
+import { Console } from 'console';
+import { Writable } from 'stream';
 import { importModule } from 'local-pkg';
 import chai, { expect, util } from 'chai';
 import SinonChai from 'sinon-chai';
@@ -5,7 +7,7 @@ import Subset from 'chai-subset';
 import path, { basename } from 'path';
 import { g as getNames, i as interpretOnlyMode, p as partitionSuiteChildren, c as hasTests, h as hasFailed } from './utils-9dcc4050.js';
 import fs from 'fs';
-import { d as c$1, l as generateDiff } from './error-fb6ff2e6.js';
+import { d as c$1, l as generateDiff } from './error-5a04e54b.js';
 import { performance } from 'perf_hooks';
 import { j as setHooks, c as createSuiteHooks, h as clearContext, d as defaultSuite, k as context, l as getHooks, m as getFn } from './suite-819c135e.js';
 import { n as nanoid } from './index-6427e0f2.js';
@@ -3473,6 +3475,9 @@ function JestChaiExpect() {
     def("toHaveLength", function(length) {
       return this.have.length(length);
     });
+    def("toHaveProperty", function(...args) {
+      return this.have.deep.nested.property(...args);
+    });
     def("toBeCloseTo", function(number, numDigits = 2) {
       utils.expectTypes(this, ["number"]);
       return this.closeTo(number, numDigits);
@@ -3581,11 +3586,47 @@ async function setupChai() {
   installed = true;
 }
 
+let globalSetup = false;
 async function setupGlobalEnv(config) {
+  if (globalSetup)
+    return;
+  globalSetup = true;
+  setupConsoleLogSpy();
   await setupChai();
   if (config.global)
     (await import('./global-e40b54d6.js')).registerApiGlobally();
 }
+function setupConsoleLogSpy() {
+  const stdout = new Writable({
+    write(data, encoding, callback) {
+      var _a;
+      send("log", {
+        type: "stdout",
+        content: String(data),
+        taskId: (_a = process.__vitest_worker__.current) == null ? void 0 : _a.id
+      });
+      callback();
+    }
+  });
+  const stderr = new Writable({
+    write(data, encoding, callback) {
+      var _a;
+      send("log", {
+        type: "stderr",
+        content: String(data),
+        taskId: (_a = process.__vitest_worker__.current) == null ? void 0 : _a.id
+      });
+      callback();
+    }
+  });
+  const newConsole = new Console({
+    stdout,
+    stderr,
+    colorMode: true,
+    groupIndentation: 2
+  });
+  globalThis.console = newConsole;
+}
 async function withEnv(name, fn) {
   const env = await environments[name].setup(globalThis);
   try {
@@ -3668,6 +3709,7 @@ async function runTest(test) {
   };
   updateTask(test);
   getSnapshotClient().setTest(test);
+  process.__vitest_worker__.current = test;
   try {
     await callHook(test.suite, "beforeEach", [test, test.suite]);
     await getFn(test)();
@@ -3684,6 +3726,7 @@ async function runTest(test) {
   }
   getSnapshotClient().clearTest();
   test.result.end = performance.now();
+  process.__vitest_worker__.current = void 0;
   updateTask(test);
 }
 async function runSuite(suite) {

package/dist/{error-fb6ff2e6.js → error-5a04e54b.js}

@@ -1264,7 +1264,7 @@ async function printError(error) {
   }
   let codeFramePrinted = false;
   const stacks = parseStack(e.stack || e.stackStr || "");
-  const nearest = stacks.find((stack) => server.moduleGraph.getModuleById(stack.file));
+  const nearest = stacks.find((stack) => !stack.file.includes("vitest/dist") && server.moduleGraph.getModuleById(stack.file));
   if (nearest) {
     const mod = server.moduleGraph.getModuleById(nearest.file);
     const transformResult = mod == null ? void 0 : mod.ssrTransformResult;

package/dist/index.d.ts

@@ -150,6 +150,11 @@ interface VitestContext {
     snapshot: SnapshotManager;
     reporter: Reporter;
 }
+interface UserConsoleLog {
+    content: string;
+    type: 'stdout' | 'stderr';
+    taskId?: string;
+}
 
 declare type RunMode = 'run' | 'skip' | 'only' | 'todo';
 declare type TaskState = RunMode | 'pass' | 'fail';
@@ -239,6 +244,7 @@ interface Reporter {
     onTaskUpdate?: (pack: TaskResultPack) => Awaitable<void>;
     onWatcherStart?: () => Awaitable<void>;
     onWatcherRerun?: (files: string[], trigger: string) => Awaitable<void>;
+    onUserConsoleLog?: (log: UserConsoleLog) => Awaitable<void>;
 }
 
 declare type SnapshotData = Record<string, string>;
@@ -407,8 +413,8 @@ interface WorkerContext {
     invalidates?: string[];
 }
 interface RpcMap {
-    workerReady: [[], void];
     fetch: [[id: string], TransformResult | null | undefined];
+    log: [[UserConsoleLog], void];
     onCollected: [[files: File[]], void];
     onFinished: [[], void];
     onTaskUpdate: [[pack: TaskResultPack], void];
@@ -527,6 +533,7 @@ declare global {
                 config: ResolvedConfig;
                 rpc: RpcCall;
                 send: RpcSend;
+                current?: Test;
             };
         }
     }
@@ -572,6 +579,7 @@ declare global {
             toBeInstanceOf(c: any): void;
             toBeCalledTimes(n: number): void;
             toHaveLength(l: number): void;
+            toHaveProperty(p: string, value?: any): void;
             toBeCloseTo(number: number, numDigits?: number): void;
             toHaveBeenCalledTimes(n: number): void;
             toHaveBeenCalledOnce(): void;
@@ -599,4 +607,4 @@ declare global {
     }
 }
 
-export { Arrayable, Awaitable, CliOptions, ComputeMode, Environment, EnvironmentReturn, File, GlobalContext, HookListener, ModuleCache, Nullable, Reporter, ResolvedConfig, RpcCall, RpcMap, RpcPayload, RpcSend, RunMode, SnapshotData, SnapshotMatchOptions, SnapshotResult, SnapshotStateOptions, SnapshotSummary, SnapshotUpdateState, Suite, SuiteCollector, SuiteHooks, Task, TaskBase, TaskResult, TaskResultPack, TaskState, Test, TestCollector, TestFactory, TestFunction, UncheckedSnapshot, UserOptions, VitestContext, WorkerContext, afterAll, afterEach, beforeAll, beforeEach, clearContext, createSuiteHooks, defaultSuite, describe, it, mock, spy, stub, suite, test };
+export { Arrayable, Awaitable, CliOptions, ComputeMode, Environment, EnvironmentReturn, File, GlobalContext, HookListener, ModuleCache, Nullable, Reporter, ResolvedConfig, RpcCall, RpcMap, RpcPayload, RpcSend, RunMode, SnapshotData, SnapshotMatchOptions, SnapshotResult, SnapshotStateOptions, SnapshotSummary, SnapshotUpdateState, Suite, SuiteCollector, SuiteHooks, Task, TaskBase, TaskResult, TaskResultPack, TaskState, Test, TestCollector, TestFactory, TestFunction, UncheckedSnapshot, UserConsoleLog, UserOptions, VitestContext, WorkerContext, afterAll, afterEach, beforeAll, beforeEach, clearContext, createSuiteHooks, defaultSuite, describe, it, mock, spy, stub, suite, test };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vitest",
-  "version": "0.0.72",
+  "version": "0.0.73",
   "description": "A blazing fast unit test framework powered by Vite",
   "keywords": [
     "vite",
@@ -51,7 +51,8 @@
     "test": "node bin/vitest.mjs -r test/core",
     "test:all": "cross-env CI=true pnpm -r --stream --filter !vitest run test --",
     "test:ci": "cross-env CI=true pnpm -r --stream --filter !vitest --filter !@vitest/test-fails run test --",
-    "typecheck": "tsc --noEmit && nr lint"
+    "typecheck": "tsc --noEmit && nr lint",
+    "ci": "ni && nr typecheck && nr lint && nr build && nr test:all"
   },
   "dependencies": {
     "@types/chai": "^4.3.0",