feat: add formatTestPath helper for improved test path rendering

Author: Ma11hewThomas

badges/coverage.svg

@@ -317,3 +317,40 @@ export function getGitHubIconHelper(): void {
     }
   )
 }
+
+/**
+ * Formats a test path by replacing spaces and ">" with GitHub arrow-right octoicon.
+ * This makes test paths more readable in markdown.
+ *
+ * @example
+ * In Handlebars:
+ * {{formatTestPath "filename.ts > suiteone > suitetwo" "test name"}}
+ * {{formatTestPath suite name}}
+ *
+ * @param {string} suite - The test suite path (may contain spaces or ">" as separators).
+ * @param {string} name - The test name.
+ * @returns {string} A formatted string with GitHub arrow-right icons between path segments.
+ */
+export function formatTestPathHelper(): void {
+  Handlebars.registerHelper('formatTestPath', (suite: string, name: string) => {
+    if (!suite) {
+      return name
+    }
+
+    const normalizedPath = suite
+      .replace(/\s*>\s*/g, '|')
+      .replace(/\s*>\s*/g, '|')
+      .replace(/\s+/g, '|')
+
+    const parts = normalizedPath.split('|').filter(Boolean)
+
+    const formattedPath = parts
+      .map(part => part.trim())
+      .filter(Boolean)
+      .join(' ![arrow-right](https://ctrf.io/assets/github/arrow-right.svg) ')
+
+    return new Handlebars.SafeString(
+      `${formattedPath} ![arrow-right](https://ctrf.io/assets/github/arrow-right.svg) ${name}`
+    )
+  })
+}

dist/index.js

@@ -14,6 +14,7 @@ import {
   formatDurationMsToHumanHelper,
   formatDurationStartStopToHumanHelper,
   formatRateHelper,
+  formatTestPathHelper,
   getEmojiHelper,
   getGitHubIconHelper,
   LimitFailedTests,
@@ -57,4 +58,5 @@ export function registerAllHelpers(): void {
   anyFlakyTestsHelper()
   anyFailedTestsHelper()
   anySkippedTestsHelper()
+  formatTestPathHelper()
 }

dist/index.js.map

@@ -47,7 +47,7 @@
 {{#each ctrf.tests}}
 {{#if (eq status "failed")}}
 {{#if suite}}
-{{suite}} > {{name}}
+{{formatTestPath suite name}}
 
 {{else}}
 {{name}}
@@ -64,7 +64,7 @@
 {{#each ctrf.tests}}
 {{#if (eq flaky true)}}
 {{#if suite}}
-{{suite}} > {{name}}
+{{formatTestPath suite name}}
 {{else}}
 {{name}}
 {{/if}}
@@ -80,7 +80,7 @@
 {{#each ctrf.tests}}
 {{#if (eq status "skipped")}}
 {{#if suite}}
-{{suite}} > {{name}}
+{{formatTestPath suite name}}
 {{else}}
 {{name}}
 {{/if}}
@@ -96,7 +96,7 @@
 {{#each ctrf.tests}}
 {{#if (eq status "pending")}}
 {{#if suite}}
-{{suite}} > {{name}}
+{{formatTestPath suite name}}
 {{else}}
 {{name}}
 {{/if}}
@@ -112,7 +112,7 @@
 {{#each ctrf.tests}}
 {{#if (eq status "other")}}
 {{#if suite}}
-{{suite}} > {{name}}
+{{formatTestPath suite name}}
 {{else}}
 {{name}}
 {{/if}}