Merge commit 'ad273dbe5dba7bd0e901270464e25fc1f030a5b5' as 'backend/goldmark'

2026-05-24 09:40:13 +02:00
parent 5ed3f1b8b7 ad273dbe5d
commit 5113059d22
109 changed files with 54777 additions and 0 deletions
@@ -0,0 +1,141 @@
+package extension
+
+import (
+	"testing"
+
+	"github.com/yuin/goldmark"
+	gast "github.com/yuin/goldmark/ast"
+	"github.com/yuin/goldmark/parser"
+	"github.com/yuin/goldmark/renderer/html"
+	"github.com/yuin/goldmark/testutil"
+	"github.com/yuin/goldmark/text"
+	"github.com/yuin/goldmark/util"
+)
+
+func TestFootnote(t *testing.T) {
+	markdown := goldmark.New(
+		goldmark.WithRendererOptions(
+			html.WithUnsafe(),
+		),
+		goldmark.WithExtensions(
+			Footnote,
+		),
+	)
+	testutil.DoTestCaseFile(markdown, "_test/footnote.txt", t, testutil.ParseCliCaseArg()...)
+}
+
+type footnoteID struct {
+}
+
+func (a *footnoteID) Transform(node *gast.Document, reader text.Reader, pc parser.Context) {
+	node.Meta()["footnote-prefix"] = "article12-"
+}
+
+func TestFootnoteOptions(t *testing.T) {
+	markdown := goldmark.New(
+		goldmark.WithRendererOptions(
+			html.WithUnsafe(),
+		),
+		goldmark.WithExtensions(
+			NewFootnote(
+				WithFootnoteIDPrefix("article12-"),
+				WithFootnoteLinkClass("link-class"),
+				WithFootnoteBacklinkClass("backlink-class"),
+				WithFootnoteLinkTitle("link-title-%%-^^"),
+				WithFootnoteBacklinkTitle("backlink-title"),
+				WithFootnoteBacklinkHTML("^"),
+			),
+		),
+	)
+
+	testutil.DoTestCase(
+		markdown,
+		testutil.MarkdownTestCase{
+			No:          1,
+			Description: "Footnote with options",
+			Markdown: `That's some text with a footnote.[^1]
+
+Same footnote.[^1]
+
+Another one.[^2]
+
+[^1]: And that's the footnote.
+[^2]: Another footnote.
+`,
+			Expected: `<p>That's some text with a footnote.<sup id="article12-fnref:1"><a href="#article12-fn:1" class="link-class" title="link-title-2-1" role="doc-noteref">1</a></sup></p>
+<p>Same footnote.<sup id="article12-fnref1:1"><a href="#article12-fn:1" class="link-class" title="link-title-2-1" role="doc-noteref">1</a></sup></p>
+<p>Another one.<sup id="article12-fnref:2"><a href="#article12-fn:2" class="link-class" title="link-title-1-2" role="doc-noteref">2</a></sup></p>
+<div class="footnotes" role="doc-endnotes">
+<hr>
+<ol>
+<li id="article12-fn:1">
+<p>And that's the footnote.&#160;<a href="#article12-fnref:1" class="backlink-class" title="backlink-title" role="doc-backlink">^</a>&#160;<a href="#article12-fnref1:1" class="backlink-class" title="backlink-title" role="doc-backlink">^</a></p>
+</li>
+<li id="article12-fn:2">
+<p>Another footnote.&#160;<a href="#article12-fnref:2" class="backlink-class" title="backlink-title" role="doc-backlink">^</a></p>
+</li>
+</ol>
+</div>`,
+		},
+		t,
+	)
+
+	markdown = goldmark.New(
+		goldmark.WithParserOptions(
+			parser.WithASTTransformers(
+				util.Prioritized(&footnoteID{}, 100),
+			),
+		),
+		goldmark.WithRendererOptions(
+			html.WithUnsafe(),
+		),
+		goldmark.WithExtensions(
+			NewFootnote(
+				WithFootnoteIDPrefixFunction(func(n gast.Node) []byte {
+					v, ok := n.OwnerDocument().Meta()["footnote-prefix"]
+					if ok {
+						return util.StringToReadOnlyBytes(v.(string))
+					}
+					return nil
+				}),
+				WithFootnoteLinkClass([]byte("link-class")),
+				WithFootnoteBacklinkClass([]byte("backlink-class")),
+				WithFootnoteLinkTitle([]byte("link-title-%%-^^")),
+				WithFootnoteBacklinkTitle([]byte("backlink-title")),
+				WithFootnoteBacklinkHTML([]byte("^")),
+			),
+		),
+	)
+
+	testutil.DoTestCase(
+		markdown,
+		testutil.MarkdownTestCase{
+			No:          2,
+			Description: "Footnote with an id prefix function",
+			Markdown: `That's some text with a footnote.[^1]
+
+Same footnote.[^1]
+
+Another one.[^2]
+
+[^1]: And that's the footnote.
+[^2]: Another footnote.
+`,
+			Expected: `<p>That's some text with a footnote.<sup id="article12-fnref:1"><a href="#article12-fn:1" class="link-class" title="link-title-2-1" role="doc-noteref">1</a></sup></p>
+<p>Same footnote.<sup id="article12-fnref1:1"><a href="#article12-fn:1" class="link-class" title="link-title-2-1" role="doc-noteref">1</a></sup></p>
+<p>Another one.<sup id="article12-fnref:2"><a href="#article12-fn:2" class="link-class" title="link-title-1-2" role="doc-noteref">2</a></sup></p>
+<div class="footnotes" role="doc-endnotes">
+<hr>
+<ol>
+<li id="article12-fn:1">
+<p>And that's the footnote.&#160;<a href="#article12-fnref:1" class="backlink-class" title="backlink-title" role="doc-backlink">^</a>&#160;<a href="#article12-fnref1:1" class="backlink-class" title="backlink-title" role="doc-backlink">^</a></p>
+</li>
+<li id="article12-fn:2">
+<p>Another footnote.&#160;<a href="#article12-fnref:2" class="backlink-class" title="backlink-title" role="doc-backlink">^</a></p>
+</li>
+</ol>
+</div>`,
+		},
+		t,
+	)
+}