diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index dd59a3622350..c3b365e26a47 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -138,7 +138,8 @@ export default ({ mode }: { mode: string }) => { }, nav: [ - { text: 'Guide & API', link: '/guide/', activeMatch: '^/(guide|api|config)/(?!browser)' }, + { text: 'Guide & API', link: '/guide/', activeMatch: '^/(guide|api)/(?!browser)' }, + { text: 'Config', link: '/config/', activeMatch: '^/config/' }, { text: 'Browser Mode', link: '/guide/browser', activeMatch: '^/guide/browser/' }, { text: 'Resources', diff --git a/docs/config/index.md b/docs/config/index.md index 25c871f97c2b..ffff54277ada 100644 --- a/docs/config/index.md +++ b/docs/config/index.md @@ -1800,7 +1800,7 @@ export default { ``` ::: tip -To have a better type safety when using built-in providers, you should reference one of these types (for provider that you are using) in your [config file](/config/file): +To have a better type safety when using built-in providers, you should reference one of these types (for provider that you are using) in your [config file](/config/): ```ts /// diff --git a/docs/guide/browser/assertion-api.md b/docs/guide/browser/assertion-api.md index c768cc10c1d8..2126fe110e22 100644 --- a/docs/guide/browser/assertion-api.md +++ b/docs/guide/browser/assertion-api.md @@ -32,7 +32,7 @@ Vitest bundles the [`@testing-library/jest-dom`](https://github.com/testing-libr - [`toHaveRole`](https://github.com/testing-library/jest-dom#toHaveRole) - [`toHaveErrorMessage`](https://github.com/testing-library/jest-dom#toHaveErrorMessage) -If you are using [TypeScript](/guide/browser/#typescript) or want to have correct type hints in `expect`, make sure you have either `@vitest/browser/providers/playwright` or `@vitest/browser/providers/webdriverio` referenced in your [setup file](/config/#setupfile) or a [config file](/config/file) depending on the provider you use. If you use the default `preview` provider, you can specify `@vitest/browser/matchers` instead. +If you are using [TypeScript](/guide/browser/#typescript) or want to have correct type hints in `expect`, make sure you have either `@vitest/browser/providers/playwright` or `@vitest/browser/providers/webdriverio` referenced in your [setup file](/config/#setupfile) or a [config file](/config/) depending on the provider you use. If you use the default `preview` provider, you can specify `@vitest/browser/matchers` instead. ::: code-group ```ts [preview] diff --git a/docs/guide/browser/commands.md b/docs/guide/browser/commands.md index 064ec47f418d..419cd0b04e4a 100644 --- a/docs/guide/browser/commands.md +++ b/docs/guide/browser/commands.md @@ -149,7 +149,7 @@ export const myCommand: BrowserCommand<[string, number]> = async ( ``` ::: tip -If you are using TypeScript, don't forget to reference `@vitest/browser/providers/playwright` in your [setup file](/config/#setupfile) or a [config file](/config/file) to get autocompletion in the config and in `userEvent` and `page` options: +If you are using TypeScript, don't forget to reference `@vitest/browser/providers/playwright` in your [setup file](/config/#setupfile) or a [config file](/config/) to get autocompletion in the config and in `userEvent` and `page` options: ```ts /// @@ -165,7 +165,7 @@ Vitest exposes some `webdriverio` specific properties on the context object. Vitest automatically switches the `webdriver` context to the test iframe by calling `browser.switchToFrame` before the command is called, so `$` and `$$` methods refer to the elements inside the iframe, not in the orchestrator, but non-webdriver APIs will still refer to the parent frame context. ::: tip -If you are using TypeScript, don't forget to reference `@vitest/browser/providers/webdriverio` in your [setup file](/config/#setupfile) or a [config file](/config/file) to get autocompletion: +If you are using TypeScript, don't forget to reference `@vitest/browser/providers/webdriverio` in your [setup file](/config/#setupfile) or a [config file](/config/) to get autocompletion: ```ts /// diff --git a/docs/guide/browser/index.md b/docs/guide/browser/index.md index 835b15c6845c..ff525f786844 100644 --- a/docs/guide/browser/index.md +++ b/docs/guide/browser/index.md @@ -297,7 +297,7 @@ The browser option in Vitest depends on the provider. Vitest will fail, if you p ## TypeScript -By default, TypeScript doesn't recognize providers options and extra `expect` properties. If you don't use any providers, make sure the `@vitest/browser/matchers` is referenced somewhere in your tests, [setup file](/config/#setupfile) or a [config file](/config/file) to pick up the extra `expect` definitions. If you are using custom providers, make sure to add `@vitest/browser/providers/playwright` or `@vitest/browser/providers/webdriverio` to the same file so TypeScript can pick up definitions for custom options: +By default, TypeScript doesn't recognize providers options and extra `expect` properties. If you don't use any providers, make sure the `@vitest/browser/matchers` is referenced somewhere in your tests, [setup file](/config/#setupfile) or a [config file](/config/) to pick up the extra `expect` definitions. If you are using custom providers, make sure to add `@vitest/browser/providers/playwright` or `@vitest/browser/providers/webdriverio` to the same file so TypeScript can pick up definitions for custom options: ::: code-group ```ts [default] diff --git a/docs/guide/browser/interactivity-api.md b/docs/guide/browser/interactivity-api.md index db7576d788a5..c41610c26dbc 100644 --- a/docs/guide/browser/interactivity-api.md +++ b/docs/guide/browser/interactivity-api.md @@ -12,7 +12,7 @@ import { userEvent } from '@vitest/browser/context' await userEvent.click(document.querySelector('.button')) ``` -Almost every `userEvent` method inherits its provider options. To see all available options in your IDE, add `webdriver` or `playwright` types (depending on your provider) to your [setup file](/config/#setupfile) or a [config file](/config/file) (depending on what is in `included` in your `tsconfig.json`): +Almost every `userEvent` method inherits its provider options. To see all available options in your IDE, add `webdriver` or `playwright` types (depending on your provider) to your [setup file](/config/#setupfile) or a [config file](/config/) (depending on what is in `included` in your `tsconfig.json`): ::: code-group ```ts [playwright]