feat(reporter): Sightly improved documentation for junit reporter and…

… fixed typo. Change-Id: Ie77e0955011fa42d2a8ef42c074327589d780739
vitest-dev · Nov 11, 2024 · 2e3dc97 · 2e3dc97
1 parent 04add0c
commit 2e3dc97
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/docs/guide/reporters.md b/docs/guide/reporters.md
@@ -251,6 +251,11 @@ AssertionError: expected 5 to be 4 // Object.is equality
 
 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.
 
+The supported placeholders for the `classnameTemplate` option are:
+- filename
+- filepath
+- suitename
+
 ```ts
 export default defineConfig({
   test: {

diff --git a/packages/vitest/src/node/reporters/junit.ts b/packages/vitest/src/node/reporters/junit.ts
@@ -19,7 +19,7 @@ interface ClassnameTemplateVariables {
 
 export interface JUnitOptions {
   outputFile?: string
-  /** @deprecated Use `classnameTempalte` instead. */
+  /** @deprecated Use `classnameTemplate` instead. */
   classname?: string
 
   /**