feat(reporter): Mention classnameTemplate in the doc

Change-Id: I1caa6e359998071ced9839ad27d121d25e8b8d99
vitest-dev · Nov 7, 2024 · 04add0c · 04add0c
1 parent 23448c0
commit 04add0c
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/docs/guide/reporters.md b/docs/guide/reporters.md
@@ -249,13 +249,13 @@ AssertionError: expected 5 to be 4 // Object.is equality
 </testsuites>
 ```
 
-The outputted XML contains nested `testsuites` and `testcase` tags. You can use the environment variables `VITEST_JUNIT_SUITE_NAME` and `VITEST_JUNIT_CLASSNAME` to configure their `name` and `classname` attributes, respectively. These can also be customized via reporter options:
+The outputted XML contains nested `testsuites` and `testcase` tags. You can use the environment variables `VITEST_JUNIT_SUITE_NAME` and `VITEST_JUNIT_CLASSNAME` to configure their `name` and `classname` attributes, respectively. These can also be customized via reporter options `suiteName` and `classnameTemplate`. `classnameTemplate` can either be a template string or a function.
 
 ```ts
 export default defineConfig({
   test: {
     reporters: [
-      ['junit', { suiteName: 'custom suite name', classname: 'custom-classname' }]
+      ['junit', { suiteName: 'custom suite name', classnameTemplate: 'filename:{filename} - filepath:{filepath} - suite:{suitename}' }]
     ]
   },
 })