add codestyle and rename Renderer to MarkdownConverter

emad-elsaid · emad-elsaid · commit 059348bac27e · 2024-12-20T18:58:10.000+01:00
This makes it more meaningful when using it: xlog.MarkdownConverter().Renderer()...
diff --git a/extensions/autolink/autolink.go b/extensions/autolink/autolink.go
@@ -17,7 +17,7 @@ type AutoLink struct{}
 
 func (AutoLink) Name() string { return "autolink" }
 func (AutoLink) Init() {
-	MarkDownRenderer.Renderer().AddOptions(renderer.WithNodeRenderers(
+	MarkdownConverter().Renderer().AddOptions(renderer.WithNodeRenderers(
 		util.Prioritized(&extension{}, -1),
 	))
 }
diff --git a/extensions/autolink_pages/extension.go b/extensions/autolink_pages/extension.go
@@ -22,10 +22,10 @@ func (AutoLinkPages) Init() {
 
 	RegisterWidget(WidgetAfterView, 1, backlinksSection)
 	RegisterTemplate(templates, "templates")
-	MarkDownRenderer.Parser().AddOptions(parser.WithInlineParsers(
+	MarkdownConverter().Parser().AddOptions(parser.WithInlineParsers(
 		util.Prioritized(&pageLinkParser{}, 999),
 	))
-	MarkDownRenderer.Renderer().AddOptions(renderer.WithNodeRenderers(
+	MarkdownConverter().Renderer().AddOptions(renderer.WithNodeRenderers(
 		util.Prioritized(&pageLinkRenderer{}, -1),
 	))
 }
diff --git a/extensions/date/extension.go b/extensions/date/extension.go
@@ -17,10 +17,10 @@ func (Date) Name() string { return "date" }
 func (Date) Init() {
 	RegisterTemplate(templates, "templates")
 	Get(`/+/date/{date}`, dateHandler)
-	MarkDownRenderer.Parser().AddOptions(parser.WithInlineParsers(
+	MarkdownConverter().Parser().AddOptions(parser.WithInlineParsers(
 		util.Prioritized(&dateParser{}, 999),
 	))
-	MarkDownRenderer.Renderer().AddOptions(renderer.WithNodeRenderers(
+	MarkdownConverter().Renderer().AddOptions(renderer.WithNodeRenderers(
 		util.Prioritized(&dateRenderer{}, 0),
 	))
 }
diff --git a/extensions/gpg/page.go b/extensions/gpg/page.go
@@ -34,7 +34,7 @@ func (p *page) Render() template.HTML {
 	content := p.Content()
 	content = xlog.PreProcess(content)
 	var buf bytes.Buffer
-	if err := xlog.MarkDownRenderer.Convert([]byte(content), &buf); err != nil {
+	if err := xlog.MarkdownConverter().Convert([]byte(content), &buf); err != nil {
 		return template.HTML(err.Error())
 	}
 
@@ -95,7 +95,7 @@ func (p *page) Write(content xlog.Markdown) bool {
 func (p *page) AST() ([]byte, ast.Node) {
 	src := p.Content()
 	if p.ast == nil {
-		p.ast = xlog.MarkDownRenderer.Parser().Parse(text.NewReader([]byte(src)))
+		p.ast = xlog.MarkdownConverter().Parser().Parse(text.NewReader([]byte(src)))
 	}
 
 	return []byte(src), p.ast
diff --git a/extensions/hashtags/hashtags.go b/extensions/hashtags/hashtags.go
@@ -36,10 +36,10 @@ func (Hashtags) Init() {
 	RegisterTemplate(templates, "templates")
 	shortcode.RegisterShortCode("hashtag-pages", shortcode.ShortCode{Render: hashtagPages})
 
-	MarkDownRenderer.Renderer().AddOptions(renderer.WithNodeRenderers(
+	MarkdownConverter().Renderer().AddOptions(renderer.WithNodeRenderers(
 		util.Prioritized(&HashTag{}, 0),
 	))
-	MarkDownRenderer.Parser().AddOptions(parser.WithInlineParsers(
+	MarkdownConverter().Parser().AddOptions(parser.WithInlineParsers(
 		util.Prioritized(&HashTag{}, 999),
 	))
 }
diff --git a/extensions/heading/renderer.go b/extensions/heading/renderer.go
@@ -18,7 +18,7 @@ type Heading struct{}
 
 func (Heading) Name() string { return "heading" }
 func (Heading) Init() {
-	MarkDownRenderer.Renderer().AddOptions(renderer.WithNodeRenderers(
+	MarkdownConverter().Renderer().AddOptions(renderer.WithNodeRenderers(
 		util.Prioritized(&headingRenderer{}, 0),
 	))
 }
diff --git a/extensions/images/extension.go b/extensions/images/extension.go
@@ -15,12 +15,12 @@ type Images struct{}
 
 func (Images) Name() string { return "images" }
 func (Images) Init() {
-	MarkDownRenderer.Parser().AddOptions(
+	MarkdownConverter().Parser().AddOptions(
 		parser.WithASTTransformers(
 			util.Prioritized(columnizeImagesParagraph{}, 0),
 		),
 	)
-	MarkDownRenderer.Renderer().AddOptions(renderer.WithNodeRenderers(
+	MarkdownConverter().Renderer().AddOptions(renderer.WithNodeRenderers(
 		util.Prioritized(&imagesColumnsRenderer{}, 0),
 	))
 }
diff --git a/extensions/images/renderer.go b/extensions/images/renderer.go
@@ -19,7 +19,7 @@ func (s *imagesColumnsRenderer) render(w util.BufWriter, source []byte, n ast.No
 
 		for c := n.FirstChild(); c != nil; c = c.NextSibling() {
 			w.WriteString(`<div class="column">`)
-			MarkDownRenderer.Renderer().Render(w, source, c)
+			MarkdownConverter().Renderer().Render(w, source, c)
 			w.WriteString(`</div>`)
 		}
 
diff --git a/extensions/mathjax/extension.go b/extensions/mathjax/extension.go
@@ -17,15 +17,15 @@ func (Mathjax) Name() string { return "mathjax" }
 func (Mathjax) Init() {
 	RegisterStaticDir(js)
 	registerBuildFiles()
-	MarkDownRenderer.Parser().AddOptions(
+	MarkdownConverter().Parser().AddOptions(
 		parser.WithInlineParsers(
 			util.Prioritized(&inlineMathParser{}, 999),
 		),
 		parser.WithBlockParsers(
 			util.Prioritized(&mathJaxBlockParser{}, 999),
 		),
 	)
-	MarkDownRenderer.Renderer().AddOptions(renderer.WithNodeRenderers(
+	MarkdownConverter().Renderer().AddOptions(renderer.WithNodeRenderers(
 		util.Prioritized(&InlineMathRenderer{startDelim: `\(`, endDelim: `\)`}, 0),
 		util.Prioritized(&MathBlockRenderer{startDelim: `\[`, endDelim: `\]`}, 0),
 	))
diff --git a/extensions/rtl/rtl.go b/extensions/rtl/rtl.go
@@ -16,7 +16,7 @@ type RTL struct{}
 
 func (RTL) Name() string { return "rtl" }
 func (RTL) Init() {
-	MarkDownRenderer.Parser().AddOptions(
+	MarkdownConverter().Parser().AddOptions(
 		parser.WithASTTransformers(
 			util.Prioritized(addDirAuto{}, 0),
 		),
diff --git a/extensions/shortcode/extension.go b/extensions/shortcode/extension.go
@@ -15,13 +15,13 @@ type ShortCodeEx struct{}
 
 func (ShortCodeEx) Name() string { return "shortcode" }
 func (ShortCodeEx) Init() {
-	MarkDownRenderer.Parser().AddOptions(parser.WithBlockParsers(
+	MarkdownConverter().Parser().AddOptions(parser.WithBlockParsers(
 		util.Prioritized(&shortCodeParser{}, 0),
 	))
-	MarkDownRenderer.Renderer().AddOptions(renderer.WithNodeRenderers(
+	MarkdownConverter().Renderer().AddOptions(renderer.WithNodeRenderers(
 		util.Prioritized(&shortCodeRenderer{}, 0),
 	))
-	MarkDownRenderer.Parser().AddOptions(
+	MarkdownConverter().Parser().AddOptions(
 		parser.WithASTTransformers(
 			util.Prioritized(transformShortCodeBlocks{}, 0),
 		),
diff --git a/extensions/shortcode/parser_test.go b/extensions/shortcode/parser_test.go
@@ -60,7 +60,7 @@ func TestShortCode(t *testing.T) {
 			shortcode.RegisterShortCode("test", shortcode.ShortCode{Render: handler, Default: ""})
 
 			output := bytes.NewBufferString("")
-			xlog.MarkDownRenderer.Convert([]byte(tc.input), output)
+			xlog.MarkdownConverter().Convert([]byte(tc.input), output)
 			if output.String() != tc.output {
 				t.Errorf("input: %s\nexpected: %s\noutput: %s", tc.input, tc.output, output.String())
 			}
diff --git a/extensions/shortcode/shortcode.go b/extensions/shortcode/shortcode.go
@@ -15,7 +15,7 @@ type ShortCode struct {
 
 func render(i Markdown) string {
 	var b bytes.Buffer
-	MarkDownRenderer.Convert([]byte(i), &b)
+	MarkdownConverter().Convert([]byte(i), &b)
 	return b.String()
 }
 
diff --git a/extensions/todo/extension.go b/extensions/todo/extension.go
@@ -14,7 +14,7 @@ type TODO struct{}
 
 func (TODO) Name() string { return "todo" }
 func (TODO) Init() {
-	MarkDownRenderer.Renderer().AddOptions(renderer.WithNodeRenderers(
+	MarkdownConverter().Renderer().AddOptions(renderer.WithNodeRenderers(
 		util.Prioritized(&TaskCheckBoxHTMLRenderer{}, 0),
 	))
 
diff --git a/flags.go b/flags.go
@@ -14,6 +14,7 @@ type Configuration struct {
 	NotFoundPage       string // name of the index page markdown file
 	BindAddress        string // bind address for the server
 	ServeInsecure      bool   // should the server use https for cookie
+	CodeStyle          string
 	CsrfCookieName     string
 	DisabledExtensions string
 }
@@ -35,4 +36,5 @@ func init() {
 	flag.BoolVar(&Config.ServeInsecure, "serve-insecure", false, "Accept http connections and forward crsf cookie over non secure connections")
 	flag.StringVar(&Config.CsrfCookieName, "csrf-cookie", "xlog_csrf", "CSRF cookie name")
 	flag.StringVar(&Config.DisabledExtensions, "disabled-extensions", "", "disable list of extensions by name, comma separated")
+	flag.StringVar(&Config.CodeStyle, "codestyle", "dracula", "code highlighting style name from the list supported by https://pkg.go.dev/github.com/alecthomas/chroma/v2/styles")
 }
diff --git a/page.go b/page.go
@@ -74,7 +74,7 @@ func (p *page) Render() template.HTML {
 	src, ast := p.AST()
 
 	var buf bytes.Buffer
-	if err := MarkDownRenderer.Renderer().Render(&buf, src, ast); err != nil {
+	if err := MarkdownConverter().Renderer().Render(&buf, src, ast); err != nil {
 		return template.HTML(err.Error())
 	}
 
@@ -149,7 +149,7 @@ func (p *page) AST() (source []byte, tree ast.Node) {
 	content := p.preProcessedContent()
 
 	if p.ast == nil || p.lastUpdate != lastModified {
-		p.ast = MarkDownRenderer.Parser().Parse(text.NewReader([]byte(content)))
+		p.ast = MarkdownConverter().Parser().Parse(text.NewReader([]byte(content)))
 	}
 
 	return []byte(content), p.ast
diff --git a/renderer.go b/renderer.go
@@ -1,6 +1,8 @@
 package xlog
 
 import (
+	"sync"
+
 	chroma_html "github.com/alecthomas/chroma/v2/formatters/html"
 	"github.com/alecthomas/chroma/v2/styles"
 	"github.com/yuin/goldmark"
@@ -16,30 +18,32 @@ import (
 // The instance of markdown renderer. this is what takes the page content and
 // converts it to HTML. it defines what features to use from goldmark and what
 // options to turn on
-var MarkDownRenderer = goldmark.New(
-	goldmark.WithExtensions(
-		extension.GFM,
-		extension.DefinitionList,
-		extension.Footnote,
-		extension.Typographer,
-		highlighting.NewHighlighting(
-			highlighting.WithCustomStyle(styles.Get("dracula")),
-			highlighting.WithFormatOptions(
-				chroma_html.WithLineNumbers(true),
+var MarkdownConverter = sync.OnceValue(func() goldmark.Markdown {
+	return goldmark.New(
+		goldmark.WithExtensions(
+			extension.GFM,
+			extension.DefinitionList,
+			extension.Footnote,
+			extension.Typographer,
+			highlighting.NewHighlighting(
+				highlighting.WithCustomStyle(styles.Get(Config.CodeStyle)),
+				highlighting.WithFormatOptions(
+					chroma_html.WithLineNumbers(true),
+				),
 			),
+			emoji.Emoji,
 		),
-		emoji.Emoji,
-	),
 
-	goldmark.WithParserOptions(
-		parser.WithAutoHeadingID(),
-	),
+		goldmark.WithParserOptions(
+			parser.WithAutoHeadingID(),
+		),
 
-	goldmark.WithRendererOptions(
-		html.WithHardWraps(),
-		html.WithUnsafe(),
-	),
-)
+		goldmark.WithRendererOptions(
+			html.WithHardWraps(),
+			html.WithUnsafe(),
+		),
+	)
+})
 
 // FindInAST takes an AST node and walks the tree depth first
 // searching for a node of a specific type can be used to find first image,

Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ type AutoLink struct{}`
`17`	`17`
`18`	`18`	`func (AutoLink) Name() string { return "autolink" }`
`19`	`19`	`func (AutoLink) Init() {`
`20`		`- MarkDownRenderer.Renderer().AddOptions(renderer.WithNodeRenderers(`
	`20`	`+ MarkdownConverter().Renderer().AddOptions(renderer.WithNodeRenderers(`
`21`	`21`	`util.Prioritized(&extension{}, -1),`
`22`	`22`	`))`
`23`	`23`	`}`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ type Heading struct{}`
`18`	`18`
`19`	`19`	`func (Heading) Name() string { return "heading" }`
`20`	`20`	`func (Heading) Init() {`
`21`		`- MarkDownRenderer.Renderer().AddOptions(renderer.WithNodeRenderers(`
	`21`	`+ MarkdownConverter().Renderer().AddOptions(renderer.WithNodeRenderers(`
`22`	`22`	`util.Prioritized(&headingRenderer{}, 0),`
`23`	`23`	`))`
`24`	`24`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,12 +15,12 @@ type Images struct{}`
`15`	`15`
`16`	`16`	`func (Images) Name() string { return "images" }`
`17`	`17`	`func (Images) Init() {`
`18`		`- MarkDownRenderer.Parser().AddOptions(`
	`18`	`+ MarkdownConverter().Parser().AddOptions(`
`19`	`19`	`parser.WithASTTransformers(`
`20`	`20`	`util.Prioritized(columnizeImagesParagraph{}, 0),`
`21`	`21`	`),`
`22`	`22`	`)`
`23`		`- MarkDownRenderer.Renderer().AddOptions(renderer.WithNodeRenderers(`
	`23`	`+ MarkdownConverter().Renderer().AddOptions(renderer.WithNodeRenderers(`
`24`	`24`	`util.Prioritized(&imagesColumnsRenderer{}, 0),`
`25`	`25`	`))`
`26`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ func (s *imagesColumnsRenderer) render(w util.BufWriter, source []byte, n ast.No`
`19`	`19`
`20`	`20`	`for c := n.FirstChild(); c != nil; c = c.NextSibling() {`
`21`	`21`	w.WriteString(`<div class="column">`)
`22`		`- MarkDownRenderer.Renderer().Render(w, source, c)`
	`22`	`+ MarkdownConverter().Renderer().Render(w, source, c)`
`23`	`23`	w.WriteString(`</div>`)
`24`	`24`	`}`
`25`	`25`