feat: add `createReport` and `.vitest` report directory convention by AriPerkkio · Pull Request #9993 · vitest-dev/vitest

AriPerkkio · 2026-03-27T13:59:40Z

Description

Resolves #9952

Once merged, I'll create follow-up issue for using .vitest in Vitest's built-in reporters (at least html?) and for other artifacts. Changing default values will be breaking change.

Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

It's really useful if your PR references an issue where it is discussed ahead of time. If the feature is substantial or introduces breaking changes without a discussion, PR might be closed.
Ideally, include a test that fails without this PR but passes with it.
Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.
Please check Allow edits by maintainers to make review process faster. Note that this option is not available for repositories that are owned by Github organizations.

Tests

Run the tests with pnpm test:ci.

Documentation

If you introduce new functionality, document it. You can run documentation with pnpm run docs command.

Changesets

Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.

netlify · 2026-03-27T14:00:56Z

✅ Deploy Preview for vitest-dev ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`4e83815`
🔍 Latest deploy log	https://app.netlify.com/projects/vitest-dev/deploys/69e84ec3db706700081039e3
😎 Deploy Preview	https://deploy-preview-9993--vitest-dev.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

hi-ogawa · 2026-03-29T05:48:29Z

Looks good to me. For the follow-up, would we also add .vitest for various default ignore/exclude like test, coverage, etc? (also watch ignore?)

sheremet-va · 2026-04-13T07:26:22Z

Maybe adding readdir would also be helpful

AriPerkkio

Team meeting notes:

Lets' mark this as experimental and release in next patch too. Stabilize in 5.0.0

…ention

sheremet-va · 2026-04-21T11:30:45Z

Oops, I forgot about this one for 4.1.5 👀 We can either release a 4.1.6 or keep it in 5.0.0.

sheremet-va · 2026-04-21T11:32:18Z

+function delete(filename: string): Promise<void>
+```
+
+Delete a file from the report directory for this scope.


Doesn't it also deletes a folder?

Co-authored-by: Ari Perkkiö <ari.perkkio@gmail.com>

AriPerkkio commented Mar 27, 2026

View reviewed changes

Comment thread docs/guide/index.md

AriPerkkio commented Mar 27, 2026

View reviewed changes

Comment thread docs/guide/advanced/reporters.md

AriPerkkio requested review from hi-ogawa and sheremet-va March 27, 2026 14:04

sheremet-va reviewed Mar 27, 2026

View reviewed changes

Comment thread docs/guide/advanced/reporters.md

This comment was marked as spam.

Sign in to view

Srasti527 mentioned this pull request Mar 31, 2026

Define convention for test reporter output directory #9952

Closed

4 tasks

AriPerkkio marked this pull request as draft April 9, 2026 15:54

AriPerkkio changed the title ~~docs(reporters): .vitest results directory convention~~ feat(reporters): add createResultsWriter and .vitest results directory convention Apr 9, 2026

AriPerkkio changed the title ~~feat(reporters): add createResultsWriter and .vitest results directory convention~~ feat(reporters): add createResultWriter and .vitest results directory convention Apr 9, 2026

AriPerkkio changed the title ~~feat(reporters): add createResultWriter and .vitest results directory convention~~ feat: add createResultWriter and .vitest results directory convention Apr 9, 2026

AriPerkkio commented Apr 10, 2026

View reviewed changes

Comment thread docs/api/advanced/vitest.md Outdated

AriPerkkio force-pushed the docs/reporter-directory-convention branch from 54c6d60 to 06187af Compare April 10, 2026 06:57

AriPerkkio marked this pull request as ready for review April 10, 2026 06:57

AriPerkkio requested a review from sheremet-va April 10, 2026 06:57

AriPerkkio force-pushed the docs/reporter-directory-convention branch from 06187af to bafc69b Compare April 10, 2026 07:23

hi-ogawa previously approved these changes Apr 11, 2026

View reviewed changes

Comment thread docs/api/advanced/vitest.md Outdated

Comment thread packages/vitest/src/node/reporters/result-writer.ts Outdated

AriPerkkio dismissed hi-ogawa’s stale review via b5e8c66 April 12, 2026 10:02

AriPerkkio force-pushed the docs/reporter-directory-convention branch 2 times, most recently from b5e8c66 to 22a357e Compare April 12, 2026 10:15

hi-ogawa previously approved these changes Apr 13, 2026

View reviewed changes

sheremet-va reviewed Apr 13, 2026

View reviewed changes

Comment thread docs/api/advanced/vitest.md Outdated

sheremet-va requested changes Apr 13, 2026

View reviewed changes

AriPerkkio dismissed hi-ogawa’s stale review via e759e97 April 13, 2026 08:09

AriPerkkio requested review from hi-ogawa and sheremet-va April 13, 2026 08:10

AriPerkkio changed the title ~~feat: add createResultWriter and .vitest results directory convention~~ feat: add createReport and .vitest report directory convention Apr 13, 2026

AriPerkkio added this to the 5.0.0 milestone Apr 13, 2026

hi-ogawa previously approved these changes Apr 14, 2026

View reviewed changes

AriPerkkio commented Apr 14, 2026

View reviewed changes

Comment thread packages/vitest/src/node/reporters/report.ts Outdated

AriPerkkio commented Apr 17, 2026

View reviewed changes

AriPerkkio dismissed hi-ogawa’s stale review via 3cba920 April 18, 2026 10:09

feat: add vitest.createReport() and .vitest report directory conv…

38f9b1c

…ention

AriPerkkio force-pushed the docs/reporter-directory-convention branch from 68b12bf to 38f9b1c Compare April 18, 2026 10:15

AriPerkkio removed this from the 5.0.0 milestone Apr 18, 2026

sheremet-va previously approved these changes Apr 21, 2026

View reviewed changes

AriPerkkio commented Apr 22, 2026

View reviewed changes

Comment thread docs/api/advanced/vitest.md Outdated

Comment thread packages/vitest/src/node/reporters/report.ts Outdated

Comment thread packages/vitest/src/node/core.ts Outdated

docs: remove experimental status, move to 5.0

4e83815

Co-authored-by: Ari Perkkiö <ari.perkkio@gmail.com>

AriPerkkio dismissed sheremet-va’s stale review via 4e83815 April 22, 2026 04:29

sheremet-va approved these changes Apr 22, 2026

View reviewed changes

sheremet-va merged commit 72a6dc2 into vitest-dev:main Apr 22, 2026
13 of 16 checks passed

AriPerkkio deleted the docs/reporter-directory-convention branch April 22, 2026 04:52

Uh oh!

Conversation

AriPerkkio commented Mar 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

Tests

Documentation

Changesets

Uh oh!

netlify Bot commented Mar 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for vitest-dev ready!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

hi-ogawa commented Mar 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment was marked as spam.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sheremet-va commented Apr 13, 2026

Uh oh!

Uh oh!

AriPerkkio left a comment

Choose a reason for hiding this comment

Uh oh!

sheremet-va commented Apr 21, 2026

Uh oh!

sheremet-va Apr 21, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

AriPerkkio commented Mar 27, 2026 •

edited

Loading

netlify Bot commented Mar 27, 2026 •

edited

Loading

hi-ogawa commented Mar 29, 2026 •

edited

Loading