[READ-ONLY] Mirror of https://github.com/vitest-dev/vitest. Next generation testing framework powered by Vite.
vitest.dev
test
testing-tools
vite
chore: standardize packages README (#9776)
+181
-41
+7
-1
packages/browser/package.json
+7
-1
packages/browser/package.json
···
5
5
"description": "Browser running for Vitest",
6
6
"license": "MIT",
7
7
"funding": "https://opencollective.com/vitest",
8
-
"homepage": "https://github.com/vitest-dev/vitest/tree/main/packages/browser#readme",
8
+
"homepage": "https://vitest.dev/guide/browser/",
9
9
"repository": {
10
10
"type": "git",
11
11
"url": "git+https://github.com/vitest-dev/vitest.git",
···
14
14
"bugs": {
15
15
"url": "https://github.com/vitest-dev/vitest/issues"
16
16
},
17
+
"keywords": [
18
+
"vitest",
19
+
"test",
20
+
"browser",
21
+
"component"
22
+
],
17
23
"sideEffects": false,
18
24
"exports": {
19
25
".": {
+30
packages/coverage-istanbul/README.md
+30
packages/coverage-istanbul/README.md
···
1
+
# @vitest/coverage-istanbul
2
+
3
+
[](https://www.npmjs.com/package/@vitest/coverage-istanbul)
4
+
5
+
Vitest coverage provider that instruments code coverage via [istanbul](https://istanbul.js.org/).
6
+
7
+
## Installation
8
+
9
+
After installing the package, specify `istanbul` in the `coverage.provider` field of your Vitest configuration:
10
+
11
+
```ts
12
+
// vitest.config.ts
13
+
import { defineConfig } from 'vitest/config'
14
+
15
+
export default defineConfig({
16
+
test: {
17
+
coverage: {
18
+
provider: 'istanbul',
19
+
},
20
+
},
21
+
})
22
+
```
23
+
24
+
Then run Vitest with coverage:
25
+
26
+
```sh
27
+
npx vitest --coverage
28
+
```
29
+
30
+
[GitHub](https://github.com/vitest-dev/vitest/tree/main/packages/coverage-istanbul) | [Documentation](https://vitest.dev/guide/coverage)
+1
-1
packages/coverage-istanbul/package.json
+1
-1
packages/coverage-istanbul/package.json
···
6
6
"author": "Anthony Fu <anthonyfu117@hotmail.com>",
7
7
"license": "MIT",
8
8
"funding": "https://opencollective.com/vitest",
9
-
"homepage": "https://github.com/vitest-dev/vitest/tree/main/packages/coverage-istanbul#readme",
9
+
"homepage": "https://vitest.dev/guide/coverage",
10
10
"repository": {
11
11
"type": "git",
12
12
"url": "git+https://github.com/vitest-dev/vitest.git",
+30
packages/coverage-v8/README.md
+30
packages/coverage-v8/README.md
···
1
+
# @vitest/coverage-v8
2
+
3
+
[](https://www.npmjs.com/package/@vitest/coverage-v8)
4
+
5
+
Vitest coverage provider that supports native code coverage via [v8](https://v8.dev/blog/javascript-code-coverage).
6
+
7
+
## Installation
8
+
9
+
After installing the package, specify `v8` in the `coverage.provider` field of your Vitest configuration (or leave it empty as it is the default provider):
10
+
11
+
```ts
12
+
// vitest.config.ts
13
+
import { defineConfig } from 'vitest/config'
14
+
15
+
export default defineConfig({
16
+
test: {
17
+
coverage: {
18
+
provider: 'v8',
19
+
},
20
+
},
21
+
})
22
+
```
23
+
24
+
Then run Vitest with coverage:
25
+
26
+
```sh
27
+
npx vitest --coverage
28
+
```
29
+
30
+
[GitHub](https://github.com/vitest-dev/vitest/tree/main/packages/coverage-v8) | [Documentation](https://vitest.dev/guide/coverage)
+1
-1
packages/coverage-v8/package.json
+1
-1
packages/coverage-v8/package.json
···
6
6
"author": "Anthony Fu <anthonyfu117@hotmail.com>",
7
7
"license": "MIT",
8
8
"funding": "https://opencollective.com/vitest",
9
-
"homepage": "https://github.com/vitest-dev/vitest/tree/main/packages/coverage-v8#readme",
9
+
"homepage": "https://vitest.dev/guide/coverage",
10
10
"repository": {
11
11
"type": "git",
12
12
"url": "git+https://github.com/vitest-dev/vitest.git",
+4
packages/expect/README.md
+4
packages/expect/README.md
···
1
1
# @vitest/expect
2
2
3
+
[](https://www.npmjs.com/package/@vitest/runner)
4
+
3
5
Jest's expect matchers as a Chai plugin.
4
6
5
7
## Usage
···
19
21
// adds asymmetric matchers like stringContaining, objectContaining
20
22
chai.use(JestAsymmetricMatchers)
21
23
```
24
+
25
+
[GitHub](https://github.com/vitest-dev/vitest/tree/main/packages/expect) | [Documentation](https://vitest.dev/api/expect)
+7
-1
packages/expect/package.json
+7
-1
packages/expect/package.json
···
5
5
"description": "Jest's expect matchers as a Chai plugin",
6
6
"license": "MIT",
7
7
"funding": "https://opencollective.com/vitest",
8
-
"homepage": "https://github.com/vitest-dev/vitest/tree/main/packages/expect#readme",
8
+
"homepage": "https://vitest.dev/api/expect",
9
9
"repository": {
10
10
"type": "git",
11
11
"url": "git+https://github.com/vitest-dev/vitest.git",
···
14
14
"bugs": {
15
15
"url": "https://github.com/vitest-dev/vitest/issues"
16
16
},
17
+
"keywords": [
18
+
"vitest",
19
+
"test",
20
+
"chai",
21
+
"assertion"
22
+
],
17
23
"sideEffects": false,
18
24
"exports": {
19
25
".": {
+2
packages/mocker/README.md
+2
packages/mocker/README.md
···
1
1
# @vitest/mocker
2
2
3
+
[](https://www.npmjs.com/package/@vitest/mocker)
4
+
3
5
Vitest's module mocker implementation.
4
6
5
7
[GitHub](https://github.com/vitest-dev/vitest/blob/main/packages/mocker/) | [Documentation](https://github.com/vitest-dev/vitest/blob/main/packages/mocker/EXPORTS.md)
+6
-1
packages/mocker/package.json
+6
-1
packages/mocker/package.json
···
5
5
"description": "Vitest module mocker implementation",
6
6
"license": "MIT",
7
7
"funding": "https://opencollective.com/vitest",
8
-
"homepage": "https://github.com/vitest-dev/vitest/tree/main/packages/mocker#readme",
8
+
"homepage": "https://github.com/vitest-dev/vitest/tree/main/packages/mocker",
9
9
"repository": {
10
10
"type": "git",
11
11
"url": "git+https://github.com/vitest-dev/vitest.git",
···
14
14
"bugs": {
15
15
"url": "https://github.com/vitest-dev/vitest/issues"
16
16
},
17
+
"keywords": [
18
+
"vitest",
19
+
"test",
20
+
"mock"
21
+
],
17
22
"sideEffects": false,
18
23
"exports": {
19
24
".": {
+7
packages/pretty-format/README.md
+7
packages/pretty-format/README.md
···
1
+
# @vitest/pretty-format
2
+
3
+
[](https://www.npmjs.com/package/@vitest/pretty-format)
4
+
5
+
Jest's `pretty-format` implementation that only supports ESM.
6
+
7
+
[GitHub](https://github.com/vitest-dev/vitest/tree/main/packages/pretty-format) | [Documentation](https://vitest.dev/)
+7
-1
packages/pretty-format/package.json
+7
-1
packages/pretty-format/package.json
···
5
5
"description": "Fork of pretty-format with support for ESM",
6
6
"license": "MIT",
7
7
"funding": "https://opencollective.com/vitest",
8
-
"homepage": "https://github.com/vitest-dev/vitest/tree/main/packages/utils#readme",
8
+
"homepage": "https://github.com/vitest-dev/vitest/tree/main/packages/pretty-format",
9
9
"repository": {
10
10
"type": "git",
11
11
"url": "git+https://github.com/vitest-dev/vitest.git",
···
14
14
"bugs": {
15
15
"url": "https://github.com/vitest-dev/vitest/issues"
16
16
},
17
+
"keywords": [
18
+
"vitest",
19
+
"test",
20
+
"pretty",
21
+
"pretty-format"
22
+
],
17
23
"sideEffects": false,
18
24
"exports": {
19
25
".": {
+4
-2
packages/runner/README.md
+4
-2
packages/runner/README.md
···
1
1
# @vitest/runner
2
2
3
-
Vitest mechanism to collect and run tasks.
3
+
[](https://www.npmjs.com/package/@vitest/runner)
4
4
5
-
[GitHub](https://github.com/vitest-dev/vitest) | [Documentation](https://vitest.dev/advanced/runner)
5
+
Vitest mechanism to collect and run tests.
6
+
7
+
[GitHub](https://github.com/vitest-dev/vitest/tree/main/packages/runner) | [Documentation](https://vitest.dev/api/advanced/runner)
+6
-1
packages/runner/package.json
+6
-1
packages/runner/package.json
···
5
5
"description": "Vitest test runner",
6
6
"license": "MIT",
7
7
"funding": "https://opencollective.com/vitest",
8
-
"homepage": "https://github.com/vitest-dev/vitest/tree/main/packages/runner#readme",
8
+
"homepage": "https://vitest.dev/api/advanced/runner",
9
9
"repository": {
10
10
"type": "git",
11
11
"url": "git+https://github.com/vitest-dev/vitest.git",
···
14
14
"bugs": {
15
15
"url": "https://github.com/vitest-dev/vitest/issues"
16
16
},
17
+
"keywords": [
18
+
"vitest",
19
+
"test",
20
+
"test-runner"
21
+
],
17
22
"sideEffects": true,
18
23
"exports": {
19
24
".": {
+4
packages/snapshot/README.md
+4
packages/snapshot/README.md
···
1
1
# @vitest/snapshot
2
2
3
+
[](https://www.npmjs.com/package/@vitest/snapshot)
4
+
3
5
Lightweight implementation of Jest's snapshots.
4
6
5
7
## Usage
···
82
84
83
85
console.log(manager.summary)
84
86
```
87
+
88
+
[GitHub](https://github.com/vitest-dev/vitest/tree/main/packages/snapshot) | [Documentation](https://vitest.dev/guide/snapshot)
+6
-1
packages/snapshot/package.json
+6
-1
packages/snapshot/package.json
···
5
5
"description": "Vitest snapshot manager",
6
6
"license": "MIT",
7
7
"funding": "https://opencollective.com/vitest",
8
-
"homepage": "https://github.com/vitest-dev/vitest/tree/main/packages/snapshot#readme",
8
+
"homepage": "https://vitest.dev/guide/snapshot",
9
9
"repository": {
10
10
"type": "git",
11
11
"url": "git+https://github.com/vitest-dev/vitest.git",
···
14
14
"bugs": {
15
15
"url": "https://github.com/vitest-dev/vitest/issues"
16
16
},
17
+
"keywords": [
18
+
"vitest",
19
+
"test",
20
+
"snapshot"
21
+
],
17
22
"sideEffects": false,
18
23
"exports": {
19
24
".": {
+5
-1
packages/spy/README.md
+5
-1
packages/spy/README.md
···
1
1
# @vitest/spy
2
2
3
-
Lightweight Jest compatible spy implementation.
3
+
[](https://www.npmjs.com/package/@vitest/spy)
4
+
5
+
Lightweight Jest-compatible mocking implementation.
6
+
7
+
[GitHub](https://github.com/vitest-dev/vitest/tree/main/packages/spy) | [Documentation](https://vitest.dev/api/mock)
+8
-1
packages/spy/package.json
+8
-1
packages/spy/package.json
···
5
5
"description": "Lightweight Jest compatible spy implementation",
6
6
"license": "MIT",
7
7
"funding": "https://opencollective.com/vitest",
8
-
"homepage": "https://github.com/vitest-dev/vitest/tree/main/packages/spy#readme",
8
+
"homepage": "https://vitest.dev/api/mock",
9
9
"repository": {
10
10
"type": "git",
11
11
"url": "git+https://github.com/vitest-dev/vitest.git",
···
14
14
"bugs": {
15
15
"url": "https://github.com/vitest-dev/vitest/issues"
16
16
},
17
+
"keywords": [
18
+
"vitest",
19
+
"test",
20
+
"mock",
21
+
"spy",
22
+
"intercept"
23
+
],
17
24
"sideEffects": false,
18
25
"exports": {
19
26
".": {
+25
packages/ui/CONTRIBUTING.md
+25
packages/ui/CONTRIBUTING.md
···
1
+
At project root, create terminals with each of the following commands:
2
+
3
+
```bash
4
+
nr ui:dev
5
+
```
6
+
7
+
```bash
8
+
nr test --api
9
+
```
10
+
11
+
As the last command, you can use any of the available tests suites instead. Make sure that they run at 51204 port or specify a custom port with `VITE_PORT` environmental variable when running the first command. For example,
12
+
13
+
```bash
14
+
VITE_PORT=3200 nr ui:dev
15
+
```
16
+
17
+
```bash
18
+
nr test --api=3200
19
+
```
20
+
21
+
Open the browser at the URL printed by the first command. For example, `http://localhost:5173/`. If you see a connection error, it means the port is specified incorrectly.
22
+
23
+
To preview the browser tab, uncomment the "browser-dev-preview" plugin in `vite.config.ts`.
24
+
25
+
To configure the browser state, update the `__vitest_browser_runner__` object in `browser.dev.js`.
+3
-27
packages/ui/README.md
+3
-27
packages/ui/README.md
···
1
1
# @vitest/ui
2
2
3
-
This package is for UI interface of Vitest.
3
+
[](https://www.npmjs.com/package/@vitest/ui)
4
4
5
-
## Development Setup
5
+
See your test results in the browser.
6
6
7
-
At project root, create terminals with each of the following commands:
8
-
9
-
```bash
10
-
nr ui:dev
11
-
```
12
-
13
-
```bash
14
-
nr test --api
15
-
```
16
-
17
-
As the last command, you can use any of the available tests suites instead. Make sure that they run at 51204 port or specify a custom port with `VITE_PORT` environmental variable when running the first command. For example,
18
-
19
-
```bash
20
-
VITE_PORT=3200 nr ui:dev
21
-
```
22
-
23
-
```bash
24
-
nr test --api=3200
25
-
```
26
-
27
-
Open the browser at the URL printed by the first command. For example, `http://localhost:5173/`. If you see a connection error, it means the port is specified incorrectly.
28
-
29
-
To preview the browser tab, uncomment the "browser-dev-preview" plugin in `vite.config.ts`.
30
-
31
-
To configure the browser state, update the `__vitest_browser_runner__` object in `browser.dev.js`.
7
+
[GitHub](https://github.com/vitest-dev/vitest/tree/main/packages/ui) | [Documentation](https://vitest.dev/guide/ui)
+6
-1
packages/ui/package.json
+6
-1
packages/ui/package.json
···
5
5
"description": "UI for Vitest",
6
6
"license": "MIT",
7
7
"funding": "https://opencollective.com/vitest",
8
-
"homepage": "https://github.com/vitest-dev/vitest/tree/main/packages/ui#readme",
8
+
"homepage": "https://vitest.dev/guide/ui",
9
9
"repository": {
10
10
"type": "git",
11
11
"url": "git+https://github.com/vitest-dev/vitest.git",
···
14
14
"bugs": {
15
15
"url": "https://github.com/vitest-dev/vitest/issues"
16
16
},
17
+
"keywords": [
18
+
"vitest",
19
+
"html",
20
+
"reporter"
21
+
],
17
22
"sideEffects": false,
18
23
"exports": {
19
24
".": {
+7
packages/utils/README.md
+7
packages/utils/README.md
···
1
+
# @vitest/utils
2
+
3
+
[](https://www.npmjs.com/package/@vitest/utils)
4
+
5
+
Internal shared utilities used by other Vitest packages.
6
+
7
+
[GitHub](https://github.com/vitest-dev/vitest/tree/main/packages/utils) | [Documentation](https://vitest.dev/)
+1
-1
packages/utils/package.json
+1
-1
packages/utils/package.json
···
5
5
"description": "Shared Vitest utility functions",
6
6
"license": "MIT",
7
7
"funding": "https://opencollective.com/vitest",
8
-
"homepage": "https://github.com/vitest-dev/vitest/tree/main/packages/utils#readme",
8
+
"homepage": "https://github.com/vitest-dev/vitest/tree/main/packages/utils",
9
9
"repository": {
10
10
"type": "git",
11
11
"url": "git+https://github.com/vitest-dev/vitest.git",
+4
packages/web-worker/README.md
+4
packages/web-worker/README.md
···
1
1
# @vitest/web-worker
2
2
3
+
[](https://www.npmjs.com/package/@vitest/web-worker)
4
+
3
5
> Web Worker support for Vitest testing. Doesn't require JSDom.
4
6
5
7
Simulates Web Worker, but in the same thread.
···
88
90
- Transferring Buffer will not change its `byteLength`.
89
91
- You have access to shared global space as your tests.
90
92
- You can debug your worker, using `DEBUG=vitest:web-worker` environmental variable.
93
+
94
+
[GitHub](https://github.com/vitest-dev/vitest/tree/main/packages/web-worker) | [Documentation](https://vitest.dev/)