vitest 0.0.72 → 0.0.76

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_LONG_DASH, g as F_DOWN_RIGHT, h as F_DOT, i as F_CHECK, j as F_CROSS, k as cliTruncate, l as F_RIGHT, p as printError } from './error-1df12c37.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.76";
 
 const ESC = '\u001B[';
 const OSC = '\u001B]';
@@ -1451,6 +1451,24 @@ const spinnerMap = new WeakMap();
 const outputMap = new WeakMap();
 const pointer = c.yellow(F_POINTER);
 const skipped = c.yellow(F_DOWN);
+function divider(text, left, right) {
+  let length = process.stdout.columns;
+  if (!length || isNaN(length))
+    length = 10;
+  if (text) {
+    const textLength = stripAnsi(text).length;
+    if (left == null && right != null) {
+      left = length - textLength - right;
+    } else {
+      left = left ?? Math.floor((length - textLength) / 2);
+      right = length - textLength - left;
+    }
+    left = Math.max(0, left);
+    right = Math.max(0, right);
+    return `${F_LONG_DASH.repeat(left)}${text}${F_LONG_DASH.repeat(right)}`;
+  }
+  return F_LONG_DASH.repeat(length);
+}
 function formatTestPath(root, path) {
   var _a;
   if (isAbsolute(path))
@@ -1573,7 +1591,8 @@ function renderTree(tasks, level = 0) {
 const createRenderer = (_tasks) => {
   let tasks = _tasks;
   let timer;
-  const log = createLogUpdate(process.stdout);
+  const stdout = process.stdout;
+  const log = createLogUpdate(stdout);
   function update() {
     log(renderTree(tasks));
   }
@@ -1595,13 +1614,17 @@ const createRenderer = (_tasks) => {
         timer = void 0;
       }
       log.clear();
-      console.log(renderTree(tasks));
+      stdout.write(`${renderTree(tasks)}
+`);
       return this;
+    },
+    clear() {
+      log.clear();
     }
   };
 };
 function getFullName(task) {
-  return getNames(task).join(c.gray(" > "));
+  return getNames(task).join(c.dim(" > "));
 }
 const spinnerFrames = process.platform === "win32" ? ["-", "\\", "|", "/"] : ["\u280B", "\u2819", "\u2839", "\u2838", "\u283C", "\u2834", "\u2826", "\u2827", "\u2807", "\u280F"];
 function elegantSpinner() {
@@ -1618,11 +1641,23 @@ class DefaultReporter {
     this.ctx = ctx;
     this.start = 0;
     this.end = 0;
+    this.console = globalThis.console;
+    this.isFirstWatchRun = true;
     const mode = ctx.config.watch ? c.yellow(" DEV ") : c.cyan(" RUN ");
-    console.log(`${c.inverse(c.bold(mode))} ${c.gray(this.ctx.config.root)}
+    this.log(`${c.inverse(c.bold(mode))} ${c.gray(this.ctx.config.root)}
 `);
     this.start = performance.now();
   }
+  log(...args) {
+    if (this.ctx.config.silent)
+      return;
+    this.console.log(...args);
+  }
+  error(...args) {
+    if (this.ctx.config.silent)
+      return;
+    this.console.error(...args);
+  }
   relative(path) {
     return relative(this.ctx.config.root, path);
   }
@@ -1641,16 +1676,16 @@ class DefaultReporter {
       return;
     const task = this.ctx.state.idMap[pack[0]];
     if (task.type === "test" && ((_a = task.result) == null ? void 0 : _a.state) && ((_b = task.result) == null ? void 0 : _b.state) !== "run") {
-      console.log(` ${getStateSymbol(task)} ${getFullName(task)}`);
+      this.log(` ${getStateSymbol(task)} ${getFullName(task)}`);
       if (task.result.state === "fail")
-        console.log(c.red(`   ${F_RIGHT} ${(_c = task.result.error) == null ? void 0 : _c.message}`));
+        this.log(c.red(`   ${F_RIGHT} ${(_c = task.result.error) == null ? void 0 : _c.message}`));
     }
   }
   async onFinished(files = this.ctx.state.getFiles()) {
     var _a, _b;
     this.end = performance.now();
     await this.stopListRender();
-    console.log();
+    this.log();
     const suites = getSuites(files);
     const tests = getTests(files);
     const failedSuites = suites.filter((i) => {
@@ -1661,24 +1696,27 @@ class DefaultReporter {
       var _a2;
       return ((_a2 = i.result) == null ? void 0 : _a2.state) === "fail";
     });
+    const failedTotal = failedSuites.length + failedTests.length;
+    let current = 1;
+    const errorDivider = () => this.error(`${c.red(c.dim(divider(`[${current++}/${failedTotal}]`, void 0, 1)))}
+`);
     if (failedSuites.length) {
-      console.error(c.bold(c.red(`
-Failed to run ${failedSuites.length} suites:`)));
+      this.error(c.red(divider(c.bold(c.inverse(` Failed Suites ${failedSuites.length} `)))));
+      this.error();
       for (const suite of failedSuites) {
-        console.error(c.red(`
+        this.error(c.red(`
 - ${getFullName(suite)}`));
         await printError((_a = suite.result) == null ? void 0 : _a.error);
-        console.log();
+        errorDivider();
       }
     }
     if (failedTests.length) {
-      console.error(c.bold(c.red(`
-Failed Tests (${failedTests.length})`)));
+      this.error(c.red(divider(c.bold(c.inverse(` Failed Tests ${failedTests.length} `)))));
+      this.error();
       for (const test of failedTests) {
-        console.error(`${c.red(`
-${c.inverse(" FAIL ")}`)} ${getFullName(test)}`);
+        this.error(`${c.red(c.bold(c.inverse(" FAIL ")))} ${getFullName(test)}`);
         await printError((_b = test.result) == null ? void 0 : _b.error);
-        console.log();
+        errorDivider();
       }
     }
     const executionTime = this.end - this.start;
@@ -1694,17 +1732,17 @@ ${c.inverse(" FAIL ")}`)} ${getFullName(test)}`);
     };
     const snapshotOutput = renderSnapshotSummary(this.ctx.config.root, this.ctx.snapshot.summary);
     if (snapshotOutput.length) {
-      console.log(snapshotOutput.map((t, i) => i === 0 ? `${padTitle("Snapshots")} ${t}` : `${padTitle("")} ${t}`).join("\n"));
+      this.log(snapshotOutput.map((t, i) => i === 0 ? `${padTitle("Snapshots")} ${t}` : `${padTitle("")} ${t}`).join("\n"));
       if (snapshotOutput.length > 1)
-        console.log();
+        this.log();
     }
-    console.log(padTitle("Test Files"), getStateString(files));
-    console.log(padTitle("Tests"), getStateString(tests));
+    this.log(padTitle("Test Files"), getStateString(files));
+    this.log(padTitle("Tests"), getStateString(tests));
     if (this.watchFilters)
-      console.log(padTitle("Time"), time(threadTime));
+      this.log(padTitle("Time"), time(threadTime));
     else
-      console.log(padTitle("Time"), time(executionTime) + c.gray(` (in thread ${time(threadTime)}, ${(executionTime / threadTime * 100).toFixed(2)}%)`));
-    console.log();
+      this.log(padTitle("Time"), time(executionTime) + c.gray(` (in thread ${time(threadTime)}, ${(executionTime / threadTime * 100).toFixed(2)}%)`));
+    this.log();
   }
   async onWatcherStart() {
     await this.stopListRender();
@@ -1713,24 +1751,36 @@ ${c.inverse(" FAIL ")}`)} ${getFullName(test)}`);
       return ((_a = i.result) == null ? void 0 : _a.state) === "fail";
     });
     if (failed.length)
-      console.log(`
+      this.log(`
 ${c.bold(c.inverse(c.red(" FAIL ")))}${c.red(` ${failed.length} tests failed. Watching for file changes...`)}`);
     else
-      console.log(`
+      this.log(`
 ${c.bold(c.inverse(c.green(" PASS ")))}${c.green(" Waiting for file changes...")}`);
+    if (this.isFirstWatchRun) {
+      this.isFirstWatchRun = false;
+      this.log(c.gray("press any key to exit..."));
+    }
   }
   async onWatcherRerun(files, trigger) {
     await this.stopListRender();
     this.watchFilters = files;
-    console.clear();
-    console.log(c.blue("Re-running tests...") + c.dim(` [ ${this.relative(trigger)} ]
+    this.console.clear();
+    this.log(c.blue("Re-running tests...") + c.dim(` [ ${this.relative(trigger)} ]
 `));
   }
   async stopListRender() {
     var _a;
     (_a = this.renderer) == null ? void 0 : _a.stop();
     this.renderer = void 0;
-    await new Promise((resolve) => setTimeout(resolve, 100));
+    await new Promise((resolve) => setTimeout(resolve, 10));
+  }
+  onUserConsoleLog(log) {
+    var _a;
+    (_a = this.renderer) == null ? void 0 : _a.clear();
+    const task = log.taskId ? this.ctx.state.idMap[log.taskId] : void 0;
+    this.log(c.gray(log.type + c.dim(` | ${task ? getFullName(task) : "unknown test"}`)));
+    process[log.type].write(`${log.content}
+`);
   }
 }
 
@@ -2126,6 +2176,7 @@ async function initViteServer(options = {}) {
     resolved.maxThreads = parseInt(process.env.VITEST_MAX_THREADS);
   if (process.env.VITEST_MIN_THREADS)
     resolved.minThreads = parseInt(process.env.VITEST_MIN_THREADS);
+  resolved.setupFiles = Array.from(resolved.setupFiles || []).map((i) => resolve(root, i));
   return {
     server,
     config: resolved
@@ -2172,7 +2223,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 +2255,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 +2276,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);
   });
@@ -2255,6 +2310,7 @@ async function startWatcher(ctx, pool) {
   let timer;
   const changedTests = new Set();
   const seen = new Set();
+  let isFirstRun = true;
   let promise;
   server.watcher.on("change", (id) => {
     id = slash(id);
@@ -2286,6 +2342,7 @@ async function startWatcher(ctx, pool) {
         seen.clear();
         return;
       }
+      isFirstRun = false;
       ctx.state.getFiles().forEach((file) => {
         var _a2;
         if (((_a2 = file.result) == null ? void 0 : _a2.state) === "fail")
@@ -2295,7 +2352,9 @@ async function startWatcher(ctx, pool) {
       const tests = Array.from(changedTests);
       changedTests.clear();
       seen.clear();
-      promise = start(tests, id, invalidates);
+      promise = start(tests, id, invalidates).then(() => {
+        promise = void 0;
+      });
       await promise;
     }, WATCHER_DEBOUNCE);
   }
@@ -2306,8 +2365,18 @@ async function startWatcher(ctx, pool) {
     await ((_b = reporter.onFinished) == null ? void 0 : _b.call(reporter, ctx.state.getFiles(tests)));
     await ((_c = reporter.onWatcherStart) == null ? void 0 : _c.call(reporter));
   }
-  if (process.stdin.isTTY)
-    listenToKeybard();
+  if (process.stdin.isTTY) {
+    readline.emitKeypressEvents(process.stdin);
+    process.stdin.setRawMode(true);
+    process.stdin.on("keypress", (str) => {
+      if (str === "" || str === "")
+        process.exit();
+      if (promise)
+        return;
+      if (isFirstRun)
+        process.exit();
+    });
+  }
   await new Promise(() => {
   });
 }
@@ -2328,16 +2397,6 @@ function getAffectedTests(ctx, id, set = new Set(), seen = new Set()) {
   }
   return set;
 }
-function listenToKeybard() {
-  readline.emitKeypressEvents(process.stdin);
-  process.stdin.setRawMode(true);
-  process.stdin.on("keypress", (str, key) => {
-    if (str === "" || str === "")
-      process.exit();
-    if (str === "\r")
-      process.exit();
-  });
-}
 
 async function start(ctx) {
   var _a, _b;
@@ -2414,7 +2473,7 @@ var __spreadValues = (a, b) => {
 };
 var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
 const cli = cac("vitest");
-cli.version(version).option("-r, --root <path>", "root path").option("-c, --config <path>", "path to config file").option("-u, --update", "update snapshot").option("--global", "inject apis globally").option("--dom", "mock browser api with happy-dom").option("--environment <env>", "runner environment", {
+cli.version(version).option("-r, --root <path>", "root path").option("-c, --config <path>", "path to config file").option("-u, --update", "update snapshot").option("-w, --watch", "watch mode").option("--threads", "enabled threads", { default: true }).option("--silent", "silent").option("--global", "inject apis globally").option("--dom", "mock browser api with happy-dom").option("--environment <env>", "runner environment", {
   default: "node"
 }).help();
 cli.command("run [...filters]").action(run);
@@ -2423,20 +2482,25 @@ cli.command("dev [...filters]").action(dev);
 cli.command("[...filters]").action(dev);
 cli.parse();
 async function dev(cliFilters, argv) {
-  argv.watch = !process.env.CI && !process.env.NODE_V8_COVERAGE;
+  if (argv.watch == null)
+    argv.watch = !process.env.CI && !process.env.NODE_V8_COVERAGE;
   await run(cliFilters, argv);
 }
 async function run(cliFilters, argv) {
   process.env.VITEST = "true";
-  console.log(c.magenta(c.bold("\nVitest is in closed beta exclusively for Sponsors")));
-  console.log(c.yellow("Learn more at https://vitest.dev\n"));
+  process.env.NODE_ENV = "test";
+  if (!argv.silent) {
+    console.log(c.magenta(c.bold("\nVitest is in closed beta exclusively for Sponsors")));
+    console.log(c.yellow("Learn more at https://vitest.dev\n"));
+  }
   const { config, server } = await initViteServer(__spreadProps(__spreadValues({}, argv), { cliFilters }));
   const ctx = process.__vitest__ = {
     server,
     config,
     state: new StateManager(),
     snapshot: new SnapshotManager(config),
-    reporter: config.reporter
+    reporter: config.reporter,
+    console: globalThis.console
   };
   ctx.reporter = ctx.reporter || new DefaultReporter(ctx);
   try {