Fix inferring IDs of headings with HTML

Closes GH-73.
remarkjs · Apr 3, 2023 · 415557c · 415557c
1 parent 38da293
commit 415557c
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 2 deletions.
diff --git a/lib/find/find-references.js b/lib/find/find-references.js
@@ -76,7 +76,9 @@ export async function findReferences(ctx) {
     let id = String(props.name || props.id || data.id || '')
 
     if (!id && node.type === 'heading') {
-      id = slugs.slug(toString(node, {includeImageAlt: false}))
+      id = slugs.slug(
+        toString(node, {includeImageAlt: false, includeHtml: false})
+      )
     }
 
     if (id) {

diff --git a/package.json b/package.json
@@ -49,7 +49,7 @@
     "@types/mdast": "^3.0.0",
     "github-slugger": "^2.0.0",
     "hosted-git-info": "^5.0.0",
-    "mdast-util-to-string": "^3.0.0",
+    "mdast-util-to-string": "^3.2.0",
     "propose": "0.0.5",
     "to-vfile": "^7.0.0",
     "trough": "^2.0.0",

diff --git a/test/index.js b/test/index.js
@@ -76,6 +76,17 @@ test('remark-validate-links', async (t) => {
     'should support landmarks and references to prototypal values'
   )
 
+  const fileHtml = await remark()
+    .use(links)
+    .use(sort)
+    .process('# a <!-- b --> c\n# a <!-- b -->\n# a\n[](#a--c) [](#a-), [](#a)')
+
+  t.deepEqual(
+    fileHtml.messages.map(String),
+    [],
+    'should slug headings with HTML correctly'
+  )
+
   let {stderr} = await exec(
     [
       bin,