fix(markdown): remove double and trailing dashes from heading ids (#1711

)
nuxt · Nov 30, 2022 · 67e1f53 · 67e1f53
1 parent ef92b20
commit 67e1f53
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 0 deletions.
diff --git a/src/runtime/markdown-parser/compiler.ts b/src/runtime/markdown-parser/compiler.ts
@@ -20,6 +20,12 @@ export default function (this: any, _options: MarkdownOptions) {
     if (Array.isArray(node)) {
       return node.map(parseAsJSON).filter(Boolean)
     }
+
+    // Remove double dashes and trailing dash from heading ids
+    if (node.tagName?.startsWith('h') && node.properties.id) {
+      node.properties.id = node.properties.id.replace(/-+/g, '-').replace(/-$/, '')
+    }
+
     /**
      * Element node creates an isolated children array to
      * allow nested elements

diff --git a/test/features/parser-markdown.ts b/test/features/parser-markdown.ts
@@ -179,5 +179,22 @@ export const testMarkdownParser = () => {
       expect(nodes.shift().props.href).toEqual('../../foo')
       expect(nodes.shift().props.href).toEqual('../../_foo')
     })
+
+    test('No trailing dashes in heading ids', async () => {
+      const parsed = await $fetch('/api/parse', {
+        method: 'POST',
+        body: {
+          id: 'content:index.md',
+          content: [
+            '# `<Alert />` ',
+            '## `<Alert />` -',
+            '### `<Alert />` \\#',
+            '### `<Alert />`.'
+          ].join('\n')
+        }
+      })
+      expect(parsed.body.children[0].props.id).toEqual('alert')
+      expect(parsed.body.children[1].props.id).toEqual('alert')
+    })
   })
 }