feat: parse {command} in markdown documentation
4 files changed, 289 insertions(+), 0 deletions(-)
A internal/nixdocs/command/command.go
@@ -0,0 +1,174 @@ +//nolint:wrapcheck +package command + +import ( + "bytes" + + "github.com/yuin/goldmark" + "github.com/yuin/goldmark/ast" + "github.com/yuin/goldmark/parser" + "github.com/yuin/goldmark/renderer" + "github.com/yuin/goldmark/renderer/html" + "github.com/yuin/goldmark/text" + "github.com/yuin/goldmark/util" +) + +// Node represents a command reference node in markdown AST. +type Node struct { + ast.BaseInline + Command []byte +} + +// Inline implements ast.Inline interface. +func (n *Node) Inline() bool { + return true +} + +// Kind implements ast.Node.Kind interface. +func (n *Node) Kind() ast.NodeKind { + return KindCommand +} + +// Dump implements ast.Node.Dump interface. +func (n *Node) Dump(source []byte, level int) { + ast.DumpHelper(n, source, level, map[string]string{ + "Command": string(n.Command), + }, nil) +} + +// KindCommand is a NodeKind for command nodes. +var KindCommand = ast.NewNodeKind("Command") + +// Parser is a Goldmark inline parser for parsing command nodes. +// +// Command references have the format {command}`name` which will be rendered as +// a span with the command name in code tags. +type Parser struct{} + +var _ parser.InlineParser = (*Parser)(nil) + +var openBrace = byte('{') + +// Trigger reports characters that trigger this parser. +func (*Parser) Trigger() []byte { + return []byte{openBrace} +} + +// Parse parses a command node. +func (p *Parser) Parse(_ ast.Node, block text.Reader, _ parser.Context) ast.Node { + line, segment := block.PeekLine() + + // Check if we have enough characters for {command}` + if len(line) < 10 || line[0] != openBrace { + return nil + } + + // Check for {command}` prefix + if !bytes.HasPrefix(line, []byte("{command}`")) { + return nil + } + + // Skip the {command}` prefix + line = line[10:] + start := segment.Start + 10 + + // Find the closing backtick + endPos := bytes.IndexByte(line, '`') + if endPos < 0 { + return nil + } + + // Extract the command name + commandName := line[:endPos] + if len(commandName) == 0 { + return nil + } + + // Create the node + n := &Node{ + Command: commandName, + } + + // Set the text segment to include the entire {command}`name` text + textSegment := text.NewSegment(segment.Start, start+endPos+1) + n.AppendChild(n, ast.NewTextSegment(textSegment)) + + // Advance the reader past this node + block.Advance(10 + endPos + 1) // {command}` + name + ` + + return n +} + +// HTMLRenderer is a renderer for command nodes. +type HTMLRenderer struct { + html.Config +} + +// NewHTMLRenderer returns a new HTMLRenderer. +func NewHTMLRenderer(opts ...html.Option) renderer.NodeRenderer { + r := &HTMLRenderer{ + Config: html.NewConfig(), + } + for _, opt := range opts { + opt.SetHTMLOption(&r.Config) + } + + return r +} + +// RegisterFuncs implements renderer.NodeRenderer.RegisterFuncs. +func (r *HTMLRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer) { + reg.Register(KindCommand, r.renderCommand) +} + +func (r *HTMLRenderer) renderCommand( + w util.BufWriter, + source []byte, //nolint:revive + node ast.Node, + entering bool, +) (ast.WalkStatus, error) { + if !entering { + return ast.WalkContinue, nil + } + + n := node.(*Node) + + if _, err := w.WriteString(`<span class="command"><code>`); err != nil { + return ast.WalkStop, err + } + + if _, err := w.Write(n.Command); err != nil { + return ast.WalkStop, err + } + + if _, err := w.WriteString("</code></span>"); err != nil { + return ast.WalkStop, err + } + + return ast.WalkSkipChildren, nil +} + +// Extension is a goldmark extension for command references. +type Extension struct{} + +// Extend implements goldmark.Extender.Extend. +func (e *Extension) Extend(m goldmark.Markdown) { + // Register the parser + m.Parser().AddOptions( + parser.WithInlineParsers( + util.Prioritized(new(Parser), 100), + ), + ) + + // Register the renderer + m.Renderer().AddOptions( + renderer.WithNodeRenderers( + util.Prioritized(NewHTMLRenderer(), 500), + ), + ) +} + +// New returns a new command extension. +func New() goldmark.Extender { + return &Extension{} +}
A internal/nixdocs/command/command_test.go
@@ -0,0 +1,78 @@ +package command + +import ( + "bytes" + "testing" + + "github.com/yuin/goldmark" +) + +func TestCommandExtension(t *testing.T) { + markdown := goldmark.New( + goldmark.WithExtensions( + New(), + ), + ) + + tests := []struct { + name string + input string + expected string + }{ + { + name: "basic command reference", + input: "{command}`git clone`", + expected: "<p><span class=\"command\"><code>git clone</code></span></p>\n", + }, + { + name: "command reference in sentence", + input: "You can use {command}`mkdir -p` to create nested directories.", + expected: "<p>You can use <span class=\"command\"><code>mkdir -p</code></span> to create nested directories.</p>\n", + }, + { + name: "multiple command references", + input: "Both {command}`ls -la` and {command}`find . -name \"*.go\"` can be used.", + expected: "<p>Both <span class=\"command\"><code>ls -la</code></span> and <span class=\"command\">" + + "<code>find . -name \"*.go\"</code></span> can be used.</p>\n", + }, + { + name: "incomplete command reference - no closing backtick", + input: "{command}`missingBacktick", + expected: "<p>{command}`missingBacktick</p>\n", + }, + { + name: "incomplete command reference - empty command name", + input: "{command}``", + expected: "<p>{command}``</p>\n", + }, + { + name: "command reference with code block", + input: "{command}`grep -r` is used in `terminal.sh`", + expected: "<p><span class=\"command\"><code>grep -r</code></span> " + + "is used in <code>terminal.sh</code></p>\n", + }, + } + + for _, test := range tests { + t.Run(test.name, func(t *testing.T) { + var buf bytes.Buffer + if err := markdown.Convert([]byte(test.input), &buf); err != nil { + t.Fatalf("Failed to convert markdown: %v", err) + } + + if got := buf.String(); got != test.expected { + t.Errorf("Expected:\n%q\nGot:\n%q", test.expected, got) + } + }) + } +} + +func TestCommandNodeKind(t *testing.T) { + n := &Node{} + if kind := n.Kind(); kind != KindCommand { + t.Errorf("Expected node kind %v, got %v", KindCommand, kind) + } + if !n.Inline() { + t.Error("Expected node to be inline") + } +}
A internal/nixdocs/command/example/main.go
@@ -0,0 +1,35 @@ +package main + +import ( + "bytes" + "fmt" + "os" + + "go.alanpearce.eu/searchix/internal/nixdocs/command" + + "github.com/yuin/goldmark" +) + +func main() { + // Create a new markdown parser with the command extension + md := goldmark.New( + goldmark.WithExtensions( + command.New(), + ), + ) + + // Example markdown text with command references + markdown := "Use {command}`git clone git@github.com:example/repo.git` to clone the repository." + + // Convert markdown to HTML + var buf bytes.Buffer + if err := md.Convert([]byte(markdown), &buf); err != nil { + fmt.Fprintf(os.Stderr, "Error converting markdown: %v\n", err) + os.Exit(1) + } + + // Print the resulting HTML + fmt.Println("HTML Output:") + fmt.Println("===========") + fmt.Println(buf.String()) +}
M internal/nixdocs/nixdocs.go → internal/nixdocs/nixdocs.go
@@ -5,6 +5,7 @@ fences "github.com/stefanfritsch/goldmark-fences" "github.com/yuin/goldmark" "github.com/yuin/goldmark/extension" + "go.alanpearce.eu/searchix/internal/nixdocs/command" "go.alanpearce.eu/searchix/internal/nixdocs/option" "go.alanpearce.eu/searchix/internal/nixdocs/optlink" )@@ -15,5 +16,6 @@ extension.NewLinkify(), &fences.Extender{}, optlink.New(), option.New(), + command.New(), ) }