chore: standardize packages README (#9776)

sheremet-va · web-flow · commit aaf775896af2 · 2026-03-04T11:09:28.000+01:00
diff --git a/packages/browser/package.json b/packages/browser/package.json
@@ -5,7 +5,7 @@
   "description": "Browser running for Vitest",
   "license": "MIT",
   "funding": "https://opencollective.com/vitest",
-  "homepage": "https://github.com/vitest-dev/vitest/tree/main/packages/browser#readme",
+  "homepage": "https://vitest.dev/guide/browser/",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/vitest-dev/vitest.git",
@@ -14,6 +14,12 @@
   "bugs": {
     "url": "https://github.com/vitest-dev/vitest/issues"
   },
+  "keywords": [
+    "vitest",
+    "test",
+    "browser",
+    "component"
+  ],
   "sideEffects": false,
   "exports": {
     ".": {
diff --git a/packages/coverage-istanbul/README.md b/packages/coverage-istanbul/README.md
@@ -0,0 +1,30 @@
+# @vitest/coverage-istanbul
+
+[![NPM version](https://img.shields.io/npm/v/@vitest/coverage-istanbul?color=a1b858&label=)](https://www.npmjs.com/package/@vitest/coverage-istanbul)
+
+Vitest coverage provider that instruments code coverage via [istanbul](https://istanbul.js.org/).
+
+## Installation
+
+After installing the package, specify `istanbul` in the `coverage.provider` field of your Vitest configuration:
+
+```ts
+// vitest.config.ts
+import { defineConfig } from 'vitest/config'
+
+export default defineConfig({
+  test: {
+    coverage: {
+      provider: 'istanbul',
+    },
+  },
+})
+```
+
+Then run Vitest with coverage:
+
+```sh
+npx vitest --coverage
+```
+
+[GitHub](https://github.com/vitest-dev/vitest/tree/main/packages/coverage-istanbul) | [Documentation](https://vitest.dev/guide/coverage)
diff --git a/packages/coverage-istanbul/package.json b/packages/coverage-istanbul/package.json
@@ -6,7 +6,7 @@
   "author": "Anthony Fu <anthonyfu117@hotmail.com>",
   "license": "MIT",
   "funding": "https://opencollective.com/vitest",
-  "homepage": "https://github.com/vitest-dev/vitest/tree/main/packages/coverage-istanbul#readme",
+  "homepage": "https://vitest.dev/guide/coverage",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/vitest-dev/vitest.git",
diff --git a/packages/coverage-v8/README.md b/packages/coverage-v8/README.md
@@ -0,0 +1,30 @@
+# @vitest/coverage-v8
+
+[![NPM version](https://img.shields.io/npm/v/@vitest/coverage-v8?color=a1b858&label=)](https://www.npmjs.com/package/@vitest/coverage-v8)
+
+Vitest coverage provider that supports native code coverage via [v8](https://v8.dev/blog/javascript-code-coverage).
+
+## Installation
+
+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):
+
+```ts
+// vitest.config.ts
+import { defineConfig } from 'vitest/config'
+
+export default defineConfig({
+  test: {
+    coverage: {
+      provider: 'v8',
+    },
+  },
+})
+```
+
+Then run Vitest with coverage:
+
+```sh
+npx vitest --coverage
+```
+
+[GitHub](https://github.com/vitest-dev/vitest/tree/main/packages/coverage-v8) | [Documentation](https://vitest.dev/guide/coverage)
diff --git a/packages/coverage-v8/package.json b/packages/coverage-v8/package.json
@@ -6,7 +6,7 @@
   "author": "Anthony Fu <anthonyfu117@hotmail.com>",
   "license": "MIT",
   "funding": "https://opencollective.com/vitest",
-  "homepage": "https://github.com/vitest-dev/vitest/tree/main/packages/coverage-v8#readme",
+  "homepage": "https://vitest.dev/guide/coverage",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/vitest-dev/vitest.git",
diff --git a/packages/expect/README.md b/packages/expect/README.md
@@ -1,5 +1,7 @@
 # @vitest/expect
 
+[![NPM version](https://img.shields.io/npm/v/@vitest/runner?color=a1b858&label=)](https://www.npmjs.com/package/@vitest/runner)
+
 Jest's expect matchers as a Chai plugin.
 
 ## Usage
@@ -19,3 +21,5 @@ chai.use(JestChaiExpect)
 // adds asymmetric matchers like stringContaining, objectContaining
 chai.use(JestAsymmetricMatchers)
 ```
+
+[GitHub](https://github.com/vitest-dev/vitest/tree/main/packages/expect) | [Documentation](https://vitest.dev/api/expect)
diff --git a/packages/expect/package.json b/packages/expect/package.json
@@ -5,7 +5,7 @@
   "description": "Jest's expect matchers as a Chai plugin",
   "license": "MIT",
   "funding": "https://opencollective.com/vitest",
-  "homepage": "https://github.com/vitest-dev/vitest/tree/main/packages/expect#readme",
+  "homepage": "https://vitest.dev/api/expect",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/vitest-dev/vitest.git",
@@ -14,6 +14,12 @@
   "bugs": {
     "url": "https://github.com/vitest-dev/vitest/issues"
   },
+  "keywords": [
+    "vitest",
+    "test",
+    "chai",
+    "assertion"
+  ],
   "sideEffects": false,
   "exports": {
     ".": {
diff --git a/packages/mocker/README.md b/packages/mocker/README.md
@@ -1,5 +1,7 @@
 # @vitest/mocker
 
+[![NPM version](https://img.shields.io/npm/v/@vitest/mocker?color=a1b858&label=)](https://www.npmjs.com/package/@vitest/mocker)
+
 Vitest's module mocker implementation.
 
 [GitHub](https://github.com/vitest-dev/vitest/blob/main/packages/mocker/) | [Documentation](https://github.com/vitest-dev/vitest/blob/main/packages/mocker/EXPORTS.md)
diff --git a/packages/mocker/package.json b/packages/mocker/package.json
@@ -5,7 +5,7 @@
   "description": "Vitest module mocker implementation",
   "license": "MIT",
   "funding": "https://opencollective.com/vitest",
-  "homepage": "https://github.com/vitest-dev/vitest/tree/main/packages/mocker#readme",
+  "homepage": "https://github.com/vitest-dev/vitest/tree/main/packages/mocker",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/vitest-dev/vitest.git",
@@ -14,6 +14,11 @@
   "bugs": {
     "url": "https://github.com/vitest-dev/vitest/issues"
   },
+  "keywords": [
+    "vitest",
+    "test",
+    "mock"
+  ],
   "sideEffects": false,
   "exports": {
     ".": {
diff --git a/packages/pretty-format/README.md b/packages/pretty-format/README.md
@@ -0,0 +1,7 @@
+# @vitest/pretty-format
+
+[![NPM version](https://img.shields.io/npm/v/@vitest/pretty-format?color=a1b858&label=)](https://www.npmjs.com/package/@vitest/pretty-format)
+
+Jest's `pretty-format` implementation that only supports ESM.
+
+[GitHub](https://github.com/vitest-dev/vitest/tree/main/packages/pretty-format) | [Documentation](https://vitest.dev/)
diff --git a/packages/pretty-format/package.json b/packages/pretty-format/package.json
@@ -5,7 +5,7 @@
   "description": "Fork of pretty-format with support for ESM",
   "license": "MIT",
   "funding": "https://opencollective.com/vitest",
-  "homepage": "https://github.com/vitest-dev/vitest/tree/main/packages/utils#readme",
+  "homepage": "https://github.com/vitest-dev/vitest/tree/main/packages/pretty-format",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/vitest-dev/vitest.git",
@@ -14,6 +14,12 @@
   "bugs": {
     "url": "https://github.com/vitest-dev/vitest/issues"
   },
+  "keywords": [
+    "vitest",
+    "test",
+    "pretty",
+    "pretty-format"
+  ],
   "sideEffects": false,
   "exports": {
     ".": {
diff --git a/packages/runner/README.md b/packages/runner/README.md
@@ -1,5 +1,7 @@
 # @vitest/runner
 
-Vitest mechanism to collect and run tasks.
+[![NPM version](https://img.shields.io/npm/v/@vitest/runner?color=a1b858&label=)](https://www.npmjs.com/package/@vitest/runner)
 
-[GitHub](https://github.com/vitest-dev/vitest) | [Documentation](https://vitest.dev/advanced/runner)
+Vitest mechanism to collect and run tests.
+
+[GitHub](https://github.com/vitest-dev/vitest/tree/main/packages/runner) | [Documentation](https://vitest.dev/api/advanced/runner)
diff --git a/packages/runner/package.json b/packages/runner/package.json
@@ -5,7 +5,7 @@
   "description": "Vitest test runner",
   "license": "MIT",
   "funding": "https://opencollective.com/vitest",
-  "homepage": "https://github.com/vitest-dev/vitest/tree/main/packages/runner#readme",
+  "homepage": "https://vitest.dev/api/advanced/runner",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/vitest-dev/vitest.git",
@@ -14,6 +14,11 @@
   "bugs": {
     "url": "https://github.com/vitest-dev/vitest/issues"
   },
+  "keywords": [
+    "vitest",
+    "test",
+    "test-runner"
+  ],
   "sideEffects": true,
   "exports": {
     ".": {
diff --git a/packages/snapshot/README.md b/packages/snapshot/README.md
@@ -1,5 +1,7 @@
 # @vitest/snapshot
 
+[![NPM version](https://img.shields.io/npm/v/@vitest/snapshot?color=a1b858&label=)](https://www.npmjs.com/package/@vitest/snapshot)
+
 Lightweight implementation of Jest's snapshots.
 
 ## Usage
@@ -82,3 +84,5 @@ manager.add(result)
 
 console.log(manager.summary)
 ```
+
+[GitHub](https://github.com/vitest-dev/vitest/tree/main/packages/snapshot) | [Documentation](https://vitest.dev/guide/snapshot)
diff --git a/packages/snapshot/package.json b/packages/snapshot/package.json
@@ -5,7 +5,7 @@
   "description": "Vitest snapshot manager",
   "license": "MIT",
   "funding": "https://opencollective.com/vitest",
-  "homepage": "https://github.com/vitest-dev/vitest/tree/main/packages/snapshot#readme",
+  "homepage": "https://vitest.dev/guide/snapshot",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/vitest-dev/vitest.git",
@@ -14,6 +14,11 @@
   "bugs": {
     "url": "https://github.com/vitest-dev/vitest/issues"
   },
+  "keywords": [
+    "vitest",
+    "test",
+    "snapshot"
+  ],
   "sideEffects": false,
   "exports": {
     ".": {
diff --git a/packages/spy/README.md b/packages/spy/README.md
@@ -1,3 +1,7 @@
 # @vitest/spy
 
-Lightweight Jest compatible spy implementation.
+[![NPM version](https://img.shields.io/npm/v/@vitest/spy?color=a1b858&label=)](https://www.npmjs.com/package/@vitest/spy)
+
+Lightweight Jest-compatible mocking implementation.
+
+[GitHub](https://github.com/vitest-dev/vitest/tree/main/packages/spy) | [Documentation](https://vitest.dev/api/mock)
diff --git a/packages/spy/package.json b/packages/spy/package.json
@@ -5,7 +5,7 @@
   "description": "Lightweight Jest compatible spy implementation",
   "license": "MIT",
   "funding": "https://opencollective.com/vitest",
-  "homepage": "https://github.com/vitest-dev/vitest/tree/main/packages/spy#readme",
+  "homepage": "https://vitest.dev/api/mock",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/vitest-dev/vitest.git",
@@ -14,6 +14,13 @@
   "bugs": {
     "url": "https://github.com/vitest-dev/vitest/issues"
   },
+  "keywords": [
+    "vitest",
+    "test",
+    "mock",
+    "spy",
+    "intercept"
+  ],
   "sideEffects": false,
   "exports": {
     ".": {
diff --git a/packages/ui/CONTRIBUTING.md b/packages/ui/CONTRIBUTING.md
@@ -0,0 +1,25 @@
+At project root, create terminals with each of the following commands:
+
+```bash
+nr ui:dev
+```
+
+```bash
+nr test --api
+```
+
+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,
+
+```bash
+VITE_PORT=3200 nr ui:dev
+```
+
+```bash
+nr test --api=3200
+```
+
+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.
+
+To preview the browser tab, uncomment the "browser-dev-preview" plugin in `vite.config.ts`.
+
+To configure the browser state, update the `__vitest_browser_runner__` object in `browser.dev.js`.
diff --git a/packages/ui/README.md b/packages/ui/README.md
@@ -1,31 +1,7 @@
 # @vitest/ui
 
-This package is for UI interface of Vitest.
+[![NPM version](https://img.shields.io/npm/v/@vitest/ui?color=a1b858&label=)](https://www.npmjs.com/package/@vitest/ui)
 
-## Development Setup
+See your test results in the browser.
 
-At project root, create terminals with each of the following commands:
-
-```bash
-nr ui:dev
-```
-
-```bash
-nr test --api
-```
-
-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,
-
-```bash
-VITE_PORT=3200 nr ui:dev
-```
-
-```bash
-nr test --api=3200
-```
-
-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.
-
-To preview the browser tab, uncomment the "browser-dev-preview" plugin in `vite.config.ts`.
-
-To configure the browser state, update the `__vitest_browser_runner__` object in `browser.dev.js`.
+[GitHub](https://github.com/vitest-dev/vitest/tree/main/packages/ui) | [Documentation](https://vitest.dev/guide/ui)
diff --git a/packages/ui/package.json b/packages/ui/package.json
@@ -5,7 +5,7 @@
   "description": "UI for Vitest",
   "license": "MIT",
   "funding": "https://opencollective.com/vitest",
-  "homepage": "https://github.com/vitest-dev/vitest/tree/main/packages/ui#readme",
+  "homepage": "https://vitest.dev/guide/ui",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/vitest-dev/vitest.git",
@@ -14,6 +14,11 @@
   "bugs": {
     "url": "https://github.com/vitest-dev/vitest/issues"
   },
+  "keywords": [
+    "vitest",
+    "html",
+    "reporter"
+  ],
   "sideEffects": false,
   "exports": {
     ".": {
diff --git a/packages/utils/README.md b/packages/utils/README.md
@@ -0,0 +1,7 @@
+# @vitest/utils
+
+[![NPM version](https://img.shields.io/npm/v/@vitest/utils?color=a1b858&label=)](https://www.npmjs.com/package/@vitest/utils)
+
+Internal shared utilities used by other Vitest packages.
+
+[GitHub](https://github.com/vitest-dev/vitest/tree/main/packages/utils) | [Documentation](https://vitest.dev/)
diff --git a/packages/utils/package.json b/packages/utils/package.json
@@ -5,7 +5,7 @@
   "description": "Shared Vitest utility functions",
   "license": "MIT",
   "funding": "https://opencollective.com/vitest",
-  "homepage": "https://github.com/vitest-dev/vitest/tree/main/packages/utils#readme",
+  "homepage": "https://github.com/vitest-dev/vitest/tree/main/packages/utils",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/vitest-dev/vitest.git",
diff --git a/packages/web-worker/README.md b/packages/web-worker/README.md
