vitest 0.0.69 → 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">