Escape certain characters for Markdown, fix antfu#13

rioj7 · Nov 15, 2024 · 30f0404 · 30f0404
1 parent 96b7ebe
commit 30f0404
Showing 1 changed file with 11 additions and 3 deletions.
diff --git a/src/index.ts b/src/index.ts
@@ -44,6 +44,14 @@ function getConfigObject(packageJson: any) {
 export function generateMarkdown(packageJson: any) {
   const MAX_TABLE_COL_CHAR = 150
 
+  function markdownEscape(text: string) {
+    return text
+      .replace('&', '&amp;')
+      .replace('<', '&lt;')
+      .replace('>', '&gt;')
+      .replace('|', '&vert;');
+  }
+
   let commandsTable = [
     ['Command', 'Title'],
   ]
@@ -57,9 +65,9 @@ export function generateMarkdown(packageJson: any) {
       ...packageJson.contributes.commands.map((c: any) => {
         return [
           `\`${c.command}\``,
-          c.category
+          markdownEscape(c.category
             ? `${c.category}: ${c.title}`
-            : c.title,
+            : c.title),
         ]
       }),
     )
@@ -77,7 +85,7 @@ export function generateMarkdown(packageJson: any) {
           const defaultVal = defaultValFromSchema(value) || ''
           return [
             `\`${key}\``,
-            value?.description || value?.markdownDescription || '',
+            markdownEscape(value?.description || value?.markdownDescription || ''),
             `\`${String(value.type)}\``,
             defaultVal.length < MAX_TABLE_COL_CHAR ? `\`${defaultVal}\`` : 'See package.json',
           ]