From 9a04899cba636a37f2522409d4744abffd49cc67 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ari=20Perkki=C3=B6?= Date: Tue, 13 Oct 2026 22:46:16 +0300 Subject: [PATCH] docs: fix `test.projects` usage, test descriptions (#11565) --- docs/config/name.md | 12 ++++++++---- test/README.md | 17 ++++++----------- 2 files changed, 14 insertions(+), 15 deletions(-) diff --git a/docs/config/name.md b/docs/config/name.md index f4d3fff29..f6ba29ed3 100644 --- a/docs/config/name.md +++ b/docs/config/name.md @@ -67,12 +67,16 @@ export default defineConfig({ test: { projects: [ { - name: 'unit', - include: ['./test/*.unit.test.js'], + test: { + name: "unit", + include: ["./test/*.unit.test.js"], + }, }, { - name: 'e2e', - include: ['./test/*.e2e.test.js'], + test: { + name: "e2e", + include: ["./test/*.e2e.test.js"], + }, }, ], }, diff --git a/test/README.md b/test/README.md index d957d7404..dcbbe6edb 100644 --- a/test/README.md +++ b/test/README.md @@ -1,19 +1,18 @@ Tests are split by categories. Default categories are: -## core +## unit These tests are running in different pools with a single config file. If you just need to test a function call, you can place your test here. This is the only test category that doesn't start new Vitest instance for every test. -## config - -Place your test here if you are testing a config option. - -## cli +## e2e If you are testing a complex interaction, place your tests here. -Type-focused fixtures live under `test/e2e/dts/`. + +- Config options go to `test/e2e/test/config/`. +- Vitest behaviour when file is created/updated/removed goes to `test/e2e/test/watch/`. +- Type-focused fixtures live under `test/e2e/dts/`. ## browser @@ -23,10 +22,6 @@ If you are testing browser mode, add your tests here. These are e2e tests for UI package. We are using `playwright` to test it. -## watch - -Place your tests here if you are testing Vitest behaviour when file is created/updated/removed. - --- All other categories just group tests by type. -- 2.54.0