Feat: Use custom heading anchors

Confluence Anchors are case-sensitive.
kovetskiy · Oct 22, 2024 · ba944ef · ba944ef
1 parent e7a3877
commit ba944ef
Show file tree

Hide file tree

Showing 8 changed files with 98 additions and 36 deletions.
diff --git a/markdown/markdown.go b/markdown/markdown.go
@@ -91,8 +91,10 @@ func CompileMarkdown(markdown []byte, stdlib *stdlib.Lib, path string, mermaidPr
 			html.WithXHTML(),
 		))
 
+	ctx := parser.NewContext(parser.WithIDs(&cparser.ConfluenceIDs{Values: map[string]bool{}}))
+
 	var buf bytes.Buffer
-	err := converter.Convert(markdown, &buf)
+	err := converter.Convert(markdown, &buf, parser.WithContext(ctx))
 
 	if err != nil {
 		panic(err)

diff --git a/parser/confluenceids.go b/parser/confluenceids.go
@@ -0,0 +1,56 @@
+package parser
+
+import (
+	"fmt"
+
+	"github.com/yuin/goldmark/ast"
+	"github.com/yuin/goldmark/util"
+)
+
+type ConfluenceIDs struct {
+	Values map[string]bool
+}
+
+
+// https://github.com/yuin/goldmark/blob/d9c03f07f08c2d36f23afe52dda865f05320ac86/parser/parser.go#L75
+func (s *ConfluenceIDs) Generate(value []byte, kind ast.NodeKind) []byte {
+	value = util.TrimLeftSpace(value)
+	value = util.TrimRightSpace(value)
+	result := []byte{}
+	for i := 0; i < len(value); {
+		v := value[i]
+		l := util.UTF8Len(v)
+		i += int(l)
+		if l != 1 {
+			continue
+		}
+		if util.IsAlphaNumeric(v) || v == '/' {
+			result = append(result, v)
+		} else if util.IsSpace(v) || v == '-' || v == '_' {
+			result = append(result, '-')
+		}
+	}
+	if len(result) == 0 {
+		if kind == ast.KindHeading {
+			result = []byte("heading")
+		} else {
+			result = []byte("id")
+		}
+	}
+	if _, ok := s.Values[util.BytesToReadOnlyString(result)]; !ok {
+		s.Values[util.BytesToReadOnlyString(result)] = true
+		return result
+	}
+	for i := 1; ; i++ {
+		newResult := fmt.Sprintf("%s-%d", result, i)
+		if _, ok := s.Values[newResult]; !ok {
+			s.Values[newResult] = true
+			return []byte(newResult)
+		}
+
+	}
+}
+
+func (s *ConfluenceIDs) Put(value []byte) {
+	s.Values[util.BytesToReadOnlyString(value)] = true
+}
diff --git a/testdata/header-droph1.html b/testdata/header-droph1.html
@@ -4,3 +4,4 @@ <h4 id="d">d</h4>
 <h5 id="e">e</h5>
 <h1 id="f">f</h1>
 <h2 id="g">g</h2>
+<h1 id="This/is-some-Heading">This/is some Heading</h1>
diff --git a/testdata/header.html b/testdata/header.html
@@ -5,3 +5,4 @@ <h4 id="d">d</h4>
 <h5 id="e">e</h5>
 <h1 id="f">f</h1>
 <h2 id="g">g</h2>
+<h1 id="This/is-some-Heading">This/is some Heading</h1>
diff --git a/testdata/header.md b/testdata/header.md
@@ -8,3 +8,5 @@ f
 =
 g
 -
+
+# This/is some Heading
diff --git a/testdata/quotes-droph1.html b/testdata/quotes-droph1.html
@@ -1,4 +1,4 @@
-<h2 id="first-heading">First Heading</h2>
+<h2 id="First-Heading">First Heading</h2>
 <ac:structured-macro ac:name="note"><ac:parameter ac:name="icon">true</ac:parameter><ac:rich-text-body>
 <p><strong>NOTES:</strong></p>
 <ol>
@@ -11,7 +11,7 @@ <h2 id="first-heading">First Heading</h2>
 </blockquote>
 <p><strong>Warn (Should not be picked as blockquote type)</strong></p>
 </ac:rich-text-body></ac:structured-macro>
-<h2 id="second-heading">Second Heading</h2>
+<h2 id="Second-Heading">Second Heading</h2>
 <ac:structured-macro ac:name="warning"><ac:parameter ac:name="icon">true</ac:parameter><ac:rich-text-body>
 <p><strong>Warn</strong></p>
 <ul>
@@ -23,12 +23,12 @@ <h2 id="second-heading">Second Heading</h2>
 <li>Regular list
 that runs long</li>
 </ul>
-<h2 id="third-heading">Third Heading</h2>
+<h2 id="Third-Heading">Third Heading</h2>
 <ac:structured-macro ac:name="info"><ac:parameter ac:name="icon">true</ac:parameter><ac:rich-text-body>
 <!-- Info -->
 <p>Test</p>
 </ac:rich-text-body></ac:structured-macro>
-<h2 id="fourth-heading---warn-should-not-get-picked-as-block-quote">Fourth Heading - Warn should not get picked as block quote</h2>
+<h2 id="Fourth-Heading---Warn-should-not-get-picked-as-block-quote">Fourth Heading - Warn should not get picked as block quote</h2>
 <ac:structured-macro ac:name="tip"><ac:parameter ac:name="icon">true</ac:parameter><ac:rich-text-body>
 <p><strong>TIP:</strong></p>
 <ol>
@@ -41,36 +41,36 @@ <h2 id="fourth-heading---warn-should-not-get-picked-as-block-quote">Fourth Headi
 </blockquote>
 <p><strong>Warn (Should not be picked as blockquote type)</strong></p>
 </ac:rich-text-body></ac:structured-macro>
-<h2 id="simple-blockquote">Simple Blockquote</h2>
+<h2 id="Simple-Blockquote">Simple Blockquote</h2>
 <blockquote>
 <p>This paragraph is a simple blockquote</p>
 </blockquote>
-<h2 id="gh-alerts-heading">GH Alerts Heading</h2>
-<h3 id="note-type-alert-heading">Note Type Alert Heading</h3>
+<h2 id="GH-Alerts-Heading">GH Alerts Heading</h2>
+<h3 id="Note-Type-Alert-Heading">Note Type Alert Heading</h3>
 <ac:structured-macro ac:name="info"><ac:parameter ac:name="icon">true</ac:parameter><ac:rich-text-body>
 <p>[!NOTE]</p>
 <ul>
 <li>Note bullet 1</li>
 <li>Note bullet 2</li>
 </ul>
 </ac:rich-text-body></ac:structured-macro>
-<h3 id="tip-type-alert-heading">Tip Type Alert Heading</h3>
+<h3 id="Tip-Type-Alert-Heading">Tip Type Alert Heading</h3>
 <ac:structured-macro ac:name="tip"><ac:parameter ac:name="icon">true</ac:parameter><ac:rich-text-body>
 <p>[!TIP]</p>
 <ul>
 <li>Tip bullet 1</li>
 <li>Tip bullet 2</li>
 </ul>
 </ac:rich-text-body></ac:structured-macro>
-<h3 id="warning-type-alert-heading">Warning Type Alert Heading</h3>
+<h3 id="Warning-Type-Alert-Heading">Warning Type Alert Heading</h3>
 <ac:structured-macro ac:name="note"><ac:parameter ac:name="icon">true</ac:parameter><ac:rich-text-body>
 <p>[!WARNING]</p>
 <ul>
 <li>Warning bullet 1</li>
 <li>Warning bullet 2</li>
 </ul>
 </ac:rich-text-body></ac:structured-macro>
-<h3 id="importantcaution-type-alert-heading">Important/Caution Type Alert Heading</h3>
+<h3 id="Important/Caution-Type-Alert-Heading">Important/Caution Type Alert Heading</h3>
 <ac:structured-macro ac:name="info"><ac:parameter ac:name="icon">true</ac:parameter><ac:rich-text-body>
 <p>[!IMPORTANT]</p>
 <ul>
@@ -85,7 +85,7 @@ <h3 id="importantcaution-type-alert-heading">Important/Caution Type Alert Headin
 <li>Important bullet 2</li>
 </ul>
 </ac:rich-text-body></ac:structured-macro>
-<h3 id="should-not-be-picked-up-and-converted-into-blockquote-macro">Should not be picked up and converted into blockquote macro</h3>
+<h3 id="Should-not-be-picked-up-and-converted-into-blockquote-macro">Should not be picked up and converted into blockquote macro</h3>
 <blockquote>
 <p>[[!NOTE]</p>
 </blockquote>

diff --git a/testdata/quotes-stripnewlines.html b/testdata/quotes-stripnewlines.html
@@ -1,5 +1,5 @@
-<h1 id="main-heading">Main Heading</h1>
-<h2 id="first-heading">First Heading</h2>
+<h1 id="Main-Heading">Main Heading</h1>
+<h2 id="First-Heading">First Heading</h2>
 <ac:structured-macro ac:name="note"><ac:parameter ac:name="icon">true</ac:parameter><ac:rich-text-body>
 <p><strong>NOTES:</strong></p>
 <ol>
@@ -11,7 +11,7 @@ <h2 id="first-heading">First Heading</h2>
 </blockquote>
 <p><strong>Warn (Should not be picked as blockquote type)</strong></p>
 </ac:rich-text-body></ac:structured-macro>
-<h2 id="second-heading">Second Heading</h2>
+<h2 id="Second-Heading">Second Heading</h2>
 <ac:structured-macro ac:name="warning"><ac:parameter ac:name="icon">true</ac:parameter><ac:rich-text-body>
 <p><strong>Warn</strong></p>
 <ul>
@@ -22,12 +22,12 @@ <h2 id="second-heading">Second Heading</h2>
 <ul>
 <li>Regular list that runs long</li>
 </ul>
-<h2 id="third-heading">Third Heading</h2>
+<h2 id="Third-Heading">Third Heading</h2>
 <ac:structured-macro ac:name="info"><ac:parameter ac:name="icon">true</ac:parameter><ac:rich-text-body>
 <!-- Info -->
 <p>Test</p>
 </ac:rich-text-body></ac:structured-macro>
-<h2 id="fourth-heading---warn-should-not-get-picked-as-block-quote">Fourth Heading - Warn should not get picked as block quote</h2>
+<h2 id="Fourth-Heading---Warn-should-not-get-picked-as-block-quote">Fourth Heading - Warn should not get picked as block quote</h2>
 <ac:structured-macro ac:name="tip"><ac:parameter ac:name="icon">true</ac:parameter><ac:rich-text-body>
 <p><strong>TIP:</strong></p>
 <ol>
@@ -39,36 +39,36 @@ <h2 id="fourth-heading---warn-should-not-get-picked-as-block-quote">Fourth Headi
 </blockquote>
 <p><strong>Warn (Should not be picked as blockquote type)</strong></p>
 </ac:rich-text-body></ac:structured-macro>
-<h2 id="simple-blockquote">Simple Blockquote</h2>
+<h2 id="Simple-Blockquote">Simple Blockquote</h2>
 <blockquote>
 <p>This paragraph is a simple blockquote</p>
 </blockquote>
-<h2 id="gh-alerts-heading">GH Alerts Heading</h2>
-<h3 id="note-type-alert-heading">Note Type Alert Heading</h3>
+<h2 id="GH-Alerts-Heading">GH Alerts Heading</h2>
+<h3 id="Note-Type-Alert-Heading">Note Type Alert Heading</h3>
 <ac:structured-macro ac:name="info"><ac:parameter ac:name="icon">true</ac:parameter><ac:rich-text-body>
 <p>[!NOTE]</p>
 <ul>
 <li>Note bullet 1</li>
 <li>Note bullet 2</li>
 </ul>
 </ac:rich-text-body></ac:structured-macro>
-<h3 id="tip-type-alert-heading">Tip Type Alert Heading</h3>
+<h3 id="Tip-Type-Alert-Heading">Tip Type Alert Heading</h3>
 <ac:structured-macro ac:name="tip"><ac:parameter ac:name="icon">true</ac:parameter><ac:rich-text-body>
 <p>[!TIP]</p>
 <ul>
 <li>Tip bullet 1</li>
 <li>Tip bullet 2</li>
 </ul>
 </ac:rich-text-body></ac:structured-macro>
-<h3 id="warning-type-alert-heading">Warning Type Alert Heading</h3>
+<h3 id="Warning-Type-Alert-Heading">Warning Type Alert Heading</h3>
 <ac:structured-macro ac:name="note"><ac:parameter ac:name="icon">true</ac:parameter><ac:rich-text-body>
 <p>[!WARNING]</p>
 <ul>
 <li>Warning bullet 1</li>
 <li>Warning bullet 2</li>
 </ul>
 </ac:rich-text-body></ac:structured-macro>
-<h3 id="importantcaution-type-alert-heading">Important/Caution Type Alert Heading</h3>
+<h3 id="Important/Caution-Type-Alert-Heading">Important/Caution Type Alert Heading</h3>
 <ac:structured-macro ac:name="info"><ac:parameter ac:name="icon">true</ac:parameter><ac:rich-text-body>
 <p>[!IMPORTANT]</p>
 <ul>
@@ -83,7 +83,7 @@ <h3 id="importantcaution-type-alert-heading">Important/Caution Type Alert Headin
 <li>Important bullet 2</li>
 </ul>
 </ac:rich-text-body></ac:structured-macro>
-<h3 id="should-not-be-picked-up-and-converted-into-blockquote-macro">Should not be picked up and converted into blockquote macro</h3>
+<h3 id="Should-not-be-picked-up-and-converted-into-blockquote-macro">Should not be picked up and converted into blockquote macro</h3>
 <blockquote>
 <p>[[!NOTE]</p>
 </blockquote>

diff --git a/testdata/quotes.html b/testdata/quotes.html
@@ -1,5 +1,5 @@
-<h1 id="main-heading">Main Heading</h1>
-<h2 id="first-heading">First Heading</h2>
+<h1 id="Main-Heading">Main Heading</h1>
+<h2 id="First-Heading">First Heading</h2>
 <ac:structured-macro ac:name="note"><ac:parameter ac:name="icon">true</ac:parameter><ac:rich-text-body>
 <p><strong>NOTES:</strong></p>
 <ol>
@@ -12,7 +12,7 @@ <h2 id="first-heading">First Heading</h2>
 </blockquote>
 <p><strong>Warn (Should not be picked as blockquote type)</strong></p>
 </ac:rich-text-body></ac:structured-macro>
-<h2 id="second-heading">Second Heading</h2>
+<h2 id="Second-Heading">Second Heading</h2>
 <ac:structured-macro ac:name="warning"><ac:parameter ac:name="icon">true</ac:parameter><ac:rich-text-body>
 <p><strong>Warn</strong></p>
 <ul>
@@ -24,12 +24,12 @@ <h2 id="second-heading">Second Heading</h2>
 <li>Regular list
 that runs long</li>
 </ul>
-<h2 id="third-heading">Third Heading</h2>
+<h2 id="Third-Heading">Third Heading</h2>
 <ac:structured-macro ac:name="info"><ac:parameter ac:name="icon">true</ac:parameter><ac:rich-text-body>
 <!-- Info -->
 <p>Test</p>
 </ac:rich-text-body></ac:structured-macro>
-<h2 id="fourth-heading---warn-should-not-get-picked-as-block-quote">Fourth Heading - Warn should not get picked as block quote</h2>
+<h2 id="Fourth-Heading---Warn-should-not-get-picked-as-block-quote">Fourth Heading - Warn should not get picked as block quote</h2>
 <ac:structured-macro ac:name="tip"><ac:parameter ac:name="icon">true</ac:parameter><ac:rich-text-body>
 <p><strong>TIP:</strong></p>
 <ol>
@@ -42,36 +42,36 @@ <h2 id="fourth-heading---warn-should-not-get-picked-as-block-quote">Fourth Headi
 </blockquote>
 <p><strong>Warn (Should not be picked as blockquote type)</strong></p>
 </ac:rich-text-body></ac:structured-macro>
-<h2 id="simple-blockquote">Simple Blockquote</h2>
+<h2 id="Simple-Blockquote">Simple Blockquote</h2>
 <blockquote>
 <p>This paragraph is a simple blockquote</p>
 </blockquote>
-<h2 id="gh-alerts-heading">GH Alerts Heading</h2>
-<h3 id="note-type-alert-heading">Note Type Alert Heading</h3>
+<h2 id="GH-Alerts-Heading">GH Alerts Heading</h2>
+<h3 id="Note-Type-Alert-Heading">Note Type Alert Heading</h3>
 <ac:structured-macro ac:name="info"><ac:parameter ac:name="icon">true</ac:parameter><ac:rich-text-body>
 <p>[!NOTE]</p>
 <ul>
 <li>Note bullet 1</li>
 <li>Note bullet 2</li>
 </ul>
 </ac:rich-text-body></ac:structured-macro>
-<h3 id="tip-type-alert-heading">Tip Type Alert Heading</h3>
+<h3 id="Tip-Type-Alert-Heading">Tip Type Alert Heading</h3>
 <ac:structured-macro ac:name="tip"><ac:parameter ac:name="icon">true</ac:parameter><ac:rich-text-body>
 <p>[!TIP]</p>
 <ul>
 <li>Tip bullet 1</li>
 <li>Tip bullet 2</li>
 </ul>
 </ac:rich-text-body></ac:structured-macro>
-<h3 id="warning-type-alert-heading">Warning Type Alert Heading</h3>
+<h3 id="Warning-Type-Alert-Heading">Warning Type Alert Heading</h3>
 <ac:structured-macro ac:name="note"><ac:parameter ac:name="icon">true</ac:parameter><ac:rich-text-body>
 <p>[!WARNING]</p>
 <ul>
 <li>Warning bullet 1</li>
 <li>Warning bullet 2</li>
 </ul>
 </ac:rich-text-body></ac:structured-macro>
-<h3 id="importantcaution-type-alert-heading">Important/Caution Type Alert Heading</h3>
+<h3 id="Important/Caution-Type-Alert-Heading">Important/Caution Type Alert Heading</h3>
 <ac:structured-macro ac:name="info"><ac:parameter ac:name="icon">true</ac:parameter><ac:rich-text-body>
 <p>[!IMPORTANT]</p>
 <ul>
@@ -86,7 +86,7 @@ <h3 id="importantcaution-type-alert-heading">Important/Caution Type Alert Headin
 <li>Important bullet 2</li>
 </ul>
 </ac:rich-text-body></ac:structured-macro>
-<h3 id="should-not-be-picked-up-and-converted-into-blockquote-macro">Should not be picked up and converted into blockquote macro</h3>
+<h3 id="Should-not-be-picked-up-and-converted-into-blockquote-macro">Should not be picked up and converted into blockquote macro</h3>
 <blockquote>
 <p>[[!NOTE]</p>
 </blockquote>