fix(utils): literal asterisk in Markdown doc should be escaped

code-pushup · Mar 18, 2024 · 6348ba3 · 6348ba3
1 parent b0ce212
commit 6348ba3
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/packages/utils/src/lib/reports/__snapshots__/report-diff-added.md b/packages/utils/src/lib/reports/__snapshots__/report-diff-added.md
@@ -7,10 +7,10 @@
 |🏷️ Category|⭐ Current score|⭐ Previous score|🔄 Score change|
 |:--|:--:|:--:|:--:|
 |Bug prevention|🟡 **63**|🟡 68|![🠋 −5](https://img.shields.io/badge/%F0%9F%A0%8B%20%E2%88%925-red)|
-|Performance|🟢 **94**|_n/a (*)_|_n/a (*)_|
+|Performance|🟢 **94**|_n/a (\*)_|_n/a (\*)_|
 |Code style|🟡 **54**|🟡 54|–|
 
-_(*) New category._
+_(\*) New category._
 
 ## 🎗️ Groups
 

diff --git a/packages/utils/src/lib/reports/generate-md-reports-diff.ts b/packages/utils/src/lib/reports/generate-md-reports-diff.ts
@@ -85,8 +85,8 @@ function formatDiffCategoriesSection(diff: ReportsDiff): string {
           ...added.map(category => [
             category.title,
             formatScoreWithColor(category.score),
-            style('n/a (*)', ['i']),
-            style('n/a (*)', ['i']),
+            style('n/a (\\*)', ['i']),
+            style('n/a (\\*)', ['i']),
           ]),
           ...unchanged.map(category => [
             category.title,
@@ -97,7 +97,7 @@ function formatDiffCategoriesSection(diff: ReportsDiff): string {
         ].map(row => (hasChanges ? row : row.slice(0, 2))),
         hasChanges ? ['l', 'c', 'c', 'c'] : ['l', 'c'],
       ),
-    added.length > 0 && style('(*) New category.', ['i']),
+    added.length > 0 && style('(\\*) New category.', ['i']),
   );
 }