-
-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Define convention for test reporter output directory #9952
Copy link
Copy link
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationfeat: reportersIssues and PRs related to Vitest reportersIssues and PRs related to Vitest reportersp2-nice-to-haveNot breaking anything but nice to have (priority)Not breaking anything but nice to have (priority)
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationfeat: reportersIssues and PRs related to Vitest reportersIssues and PRs related to Vitest reportersp2-nice-to-haveNot breaking anything but nice to have (priority)Not breaking anything but nice to have (priority)
Clear and concise description of the problem
Currently there is no convention defining where test reporters should place files on file system. For example in Playwright there is
test-results.This becomes tricky on third party reporters, as they need to instruct users to update their
.gitignorewith their own directory.Suggested solution
Decide what directory reporters should use by default. Document this in Vitest reporter documentation.
Instruct that reporters should never remove this directory. Instead they should add their own directory there, and clear that during re-runs.
If any built-in reporters would use this by default, introduce that in Vitest 5 as breaking change.
Alternative
Wait longer and see how badly the ecosystem around test reporters drifts.
Additional context
Validations