feat(junit-reporter): add jest-junit-compatible naming options by neumaennl · Pull Request #10189 · vitest-dev/vitest

neumaennl · 2026-04-24T21:18:12Z

Problem

Vitest's built-in JUnit reporter names <testsuite> elements with the relative file path and names <testcase> elements with the full test hierarchy joined by >. This differs substantially from jest-junit, which offers rich template-based naming through suiteNameTemplate, classNameTemplate, titleTemplate, and ancestorSeparator. Migrating from jest to Vitest therefore produces noticeably different CI XML output.

Solution

Four new opt-in options are added to the JUnitOptions interface. Defaults are unchanged so existing reports are not affected.

New options

Option	Type	Default	Description
`suiteNameTemplate`	`string \| function`	–	Template for `<testsuite name>`. Placeholders: `{title}`, `{filename}`, `{filepath}`, `{basename}`, `{displayName}`
`titleTemplate`	`string \| function`	–	Template for `<testcase name>`. Same placeholders as `classnameTemplate`.
`ancestorSeparator`	`string`	`" > "`	Separator for ancestor describe names when building `{classname}` and the default test title.
`noStackTrace`	`boolean`	`false`	Omit stack trace text from `<failure>` bodies (message attribute is still written).

Extended `classnameTemplate`

The existing classnameTemplate option gains five new placeholders: {classname}, {title}, {suitename}, {basename}, {displayName}.

New template variable: `{classname}`

{classname} is the chain of ancestor describe block names joined by ancestorSeparator (e.g. "outer > inner"). Combined with {title} this reproduces jest-junit's default "{classname} {title}" style.

New template variable: `{basename}`

{basename} is the bare file name without any directory component (e.g. foo.test.ts). This corresponds to jest-junit's {filename}. Vitest keeps {filename} as the relative path from the project root for backward compatibility.

Example – jest-junit-compatible output

// vitest.config.ts
reporters: [['junit', {
  suiteNameTemplate: '{title}',   // name suite after first top-level describe
  classnameTemplate: '{classname}', // ancestor path only
  titleTemplate: '{title}',        // leaf test name only
  ancestorSeparator: ' > ',
}]]

Compatibility

All new options are undefined / false by default.
When none of the new options are set the output is identical to previous releases.
{filename} in classnameTemplate continues to resolve to the relative path (not basename), preserving backward compatibility for existing users.

Tests

11 new tests added to test/cli/test/reporters/junit.test.ts. All 24 JUnit reporter tests pass.

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:.

Fixes #10191

netlify · 2026-04-24T21:19:27Z

✅ Deploy Preview for vitest-dev ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`eb41a34`
🔍 Latest deploy log	https://app.netlify.com/projects/vitest-dev/deploys/69f1aafe3543d6000817ffee
😎 Deploy Preview	https://deploy-preview-10189--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.

Copilot

Pull request overview

Adds opt-in, jest-junit-compatible naming controls to Vitest’s built-in JUnit reporter so users can template <testsuite> / <testcase> naming and optionally omit stack traces, while keeping defaults unchanged.

Changes:

Added suiteNameTemplate, titleTemplate, ancestorSeparator, and noStackTrace options to the JUnit reporter.
Extended classnameTemplate to support additional placeholders (e.g. {classname}, {title}, {suitename}, {basename}, {displayName}).
Added new fixtures + tests and updated docs to cover the new templating behavior.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

File	Description
test/cli/test/reporters/junit.test.ts	Adds coverage for suite/testcase templating, separator behavior, basename handling, and stack-trace omission.
test/cli/fixtures/reporters/junit-options/sample.test.ts	New fixture to exercise top-level vs nested `describe` naming behavior.
packages/vitest/src/node/reporters/junit.ts	Implements new templating options, placeholder variables, and `noStackTrace` behavior.
docs/guide/reporters.md	Documents new JUnit reporter options and available placeholders with examples.

neumaennl · 2026-04-25T04:13:37Z

According to copilot, none of the failing changes are caused by my changes: https://github.com/copilot/share/4a06511c-41a4-8cf0-a953-a64a2457605e

sheremet-va · 2026-04-28T06:53:32Z

@@ -0,0 +1,19 @@
+import { describe, expect, it } from 'vitest'


I don't think this file is supposed to be in this directory. cli was renamed to e2e

I'm fixing it right now.

AriPerkkio · 2026-04-28T18:27:59Z

+  /**
+   * Omit stack traces from test failure reports.
+   * @default false
+   */
+  noStackTrace?: boolean


I would actually prefer naming this without negation:

Suggested change

/**

* Omit stack traces from test failure reports.

* @default false

*/

noStackTrace?: boolean

/**

* Include stack traces from test failure reports.

* @default true

*/

stackTrace?: boolean

Sure, I can do that tomorrow.

Agent-Logs-Url: https://github.com/neumaennl/vitest/sessions/e2943b00-8b3b-4733-854d-07b3b2366f66 Co-authored-by: neumaennl <7926739+neumaennl@users.noreply.github.com>

…ocs wording Agent-Logs-Url: https://github.com/neumaennl/vitest/sessions/a7cecfc9-6b7a-4178-9f6b-810d04207d7b Co-authored-by: neumaennl <7926739+neumaennl@users.noreply.github.com>

…n in templates Agent-Logs-Url: https://github.com/neumaennl/vitest/sessions/f01d6aee-fd1d-417f-8a79-fd312a35e48a Co-authored-by: neumaennl <7926739+neumaennl@users.noreply.github.com>

…ar; fix docs grammar Agent-Logs-Url: https://github.com/neumaennl/vitest/sessions/d25e62ee-1d1e-45fd-8dc0-c7daf255346b Co-authored-by: neumaennl <7926739+neumaennl@users.noreply.github.com>

sheremet-va · 2026-04-29T07:10:40Z

Oh, seems like tests are failing

…verted the default so the behavior stays the same Co-authored-by: Copilot <copilot@github.com>

neumaennl · 2026-04-29T08:05:06Z

Oh, seems like tests are failing

I wasn't ready. Now it should be fine. The one failing check is a flaky playwright test running into a timeout that shouldn't be caused by my changes.

Copilot AI review requested due to automatic review settings April 24, 2026 21:18

Copilot started reviewing on behalf of neumaennl April 24, 2026 21:18 View session

Copilot AI reviewed Apr 24, 2026

View reviewed changes

Comment thread packages/vitest/src/node/reporters/junit.ts

Comment thread docs/guide/reporters.md Outdated

neumaennl mentioned this pull request Apr 25, 2026

Add jest-junit-compatible naming options to junit-reporter #10191

Closed

4 tasks

neumaennl mentioned this pull request Apr 25, 2026

Migrate from Jest to Vitest neumaennl/vscode-visual-xml-schema-editor#168

Open

neumaennl force-pushed the copilot/add-junit-naming-parity branch 2 times, most recently from 1ad53a6 to ff150ed Compare April 25, 2026 08:44

sheremet-va previously approved these changes Apr 27, 2026

View reviewed changes

sheremet-va requested a review from AriPerkkio April 27, 2026 12:14

neumaennl dismissed sheremet-va’s stale review via e75b09a April 28, 2026 05:46

neumaennl force-pushed the copilot/add-junit-naming-parity branch from ff150ed to e75b09a Compare April 28, 2026 05:46

sheremet-va reviewed Apr 28, 2026

View reviewed changes

neumaennl force-pushed the copilot/add-junit-naming-parity branch from 9863d1c to 570727c Compare April 28, 2026 07:08

neumaennl requested a review from sheremet-va April 28, 2026 08:25

sheremet-va previously approved these changes Apr 28, 2026

View reviewed changes

AriPerkkio previously approved these changes Apr 28, 2026

View reviewed changes

neumaennl dismissed stale reviews from AriPerkkio and sheremet-va via 39ad3de April 29, 2026 06:41

AriPerkkio previously approved these changes Apr 29, 2026

View reviewed changes

Copilot AI and others added 6 commits April 29, 2026 08:53

feat(junit-reporter): add jest-junit-compatible naming options

9a11574

Agent-Logs-Url: https://github.com/neumaennl/vitest/sessions/e2943b00-8b3b-4733-854d-07b3b2366f66 Co-authored-by: neumaennl <7926739+neumaennl@users.noreply.github.com>

fix(junit-reporter): use absolute filepath fallback and ?? consistency

5cf9b35

Agent-Logs-Url: https://github.com/neumaennl/vitest/sessions/e2943b00-8b3b-4733-854d-07b3b2366f66 Co-authored-by: neumaennl <7926739+neumaennl@users.noreply.github.com>

fix(junit-reporter): use consistent filename for template vars; fix d…

040472f

…ocs wording Agent-Logs-Url: https://github.com/neumaennl/vitest/sessions/a7cecfc9-6b7a-4178-9f6b-810d04207d7b Co-authored-by: neumaennl <7926739+neumaennl@users.noreply.github.com>

fix(junit-reporter): use replacer functions to prevent $ interpolatio…

a59d9a6

…n in templates Agent-Logs-Url: https://github.com/neumaennl/vitest/sessions/f01d6aee-fd1d-417f-8a79-fd312a35e48a Co-authored-by: neumaennl <7926739+neumaennl@users.noreply.github.com>

fix(junit-reporter): restore task.file.name for {filename} template v…

ee85c8c

…ar; fix docs grammar Agent-Logs-Url: https://github.com/neumaennl/vitest/sessions/d25e62ee-1d1e-45fd-8dc0-c7daf255346b Co-authored-by: neumaennl <7926739+neumaennl@users.noreply.github.com>

fix(junit-reporter): fixed sample test location after rebase

921811d

neumaennl force-pushed the copilot/add-junit-naming-parity branch from 39ad3de to eb41a34 Compare April 29, 2026 06:53

sheremet-va previously approved these changes Apr 29, 2026

View reviewed changes

fix(junit-reporter): flipped noStackTrace option to stackTrace and in…

582f2d8

…verted the default so the behavior stays the same Co-authored-by: Copilot <copilot@github.com>

neumaennl dismissed stale reviews from sheremet-va and AriPerkkio via 582f2d8 April 29, 2026 07:19

neumaennl force-pushed the copilot/add-junit-naming-parity branch from eb41a34 to 582f2d8 Compare April 29, 2026 07:19

neumaennl requested review from AriPerkkio and sheremet-va April 29, 2026 07:56

sheremet-va approved these changes Apr 29, 2026

View reviewed changes

sheremet-va merged commit 2739334 into vitest-dev:main Apr 29, 2026
15 of 16 checks passed

neumaennl deleted the copilot/add-junit-naming-parity branch April 29, 2026 08:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(junit-reporter): add jest-junit-compatible naming options#10189

feat(junit-reporter): add jest-junit-compatible naming options#10189
sheremet-va merged 7 commits intovitest-dev:mainfrom
neumaennl:copilot/add-junit-naming-parity

neumaennl commented Apr 24, 2026 •

edited

Loading

Uh oh!

netlify Bot commented Apr 24, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

neumaennl commented Apr 25, 2026

Uh oh!

sheremet-va Apr 28, 2026 •

edited

Loading

Uh oh!

neumaennl Apr 28, 2026

Uh oh!

AriPerkkio Apr 28, 2026

Uh oh!

neumaennl Apr 28, 2026

Uh oh!

neumaennl Apr 29, 2026

Uh oh!

sheremet-va commented Apr 29, 2026

Uh oh!

Uh oh!

neumaennl commented Apr 29, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

		@@ -0,0 +1,19 @@
		import { describe, expect, it } from 'vitest'

Uh oh!

Conversation

neumaennl commented Apr 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Problem

Solution

New options

Extended classnameTemplate

New template variable: {classname}

New template variable: {basename}

Example – jest-junit-compatible output

Compatibility

Tests

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 Apr 24, 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!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

neumaennl commented Apr 25, 2026

Uh oh!

sheremet-va Apr 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

neumaennl Apr 28, 2026

Choose a reason for hiding this comment

Uh oh!

AriPerkkio Apr 28, 2026

Choose a reason for hiding this comment

Uh oh!

neumaennl Apr 28, 2026

Choose a reason for hiding this comment

Uh oh!

neumaennl Apr 29, 2026

Choose a reason for hiding this comment

Uh oh!

sheremet-va commented Apr 29, 2026

Uh oh!

Uh oh!

neumaennl commented Apr 29, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

neumaennl commented Apr 24, 2026 •

edited

Loading

Extended `classnameTemplate`

New template variable: `{classname}`

New template variable: `{basename}`

netlify Bot commented Apr 24, 2026 •

edited

Loading

sheremet-va Apr 28, 2026 •

edited

Loading