Files
gitea-tea/internal/terminal/markdown.go
T
bircni 8bf979099b perf: drop wasted requests and reuse markdown renderers
pr edit with reviewers and other fields reads the pull request once,
org delete counts only repositories, org view counts concurrently,
team list skips the repository count of all-repository teams,
pr diff --web builds the URL locally, pr list re-reads pull requests
concurrently for review fields, and glamour renderers are built once
per width and color.

Signed-off-by: bircni <bircni@icloud.com>
2026-10-12 18:44:29 +02:00

81 lines
2.3 KiB
Go

// Copyright 2026 The Gitea Authors. All rights reserved.
// SPDX-License-Identifier: MIT
package terminal
import (
"regexp"
"strings"
"sync"
"charm.land/glamour/v2"
"charm.land/glamour/v2/styles"
)
// MarkdownEnabled resolves the markdown preference: raw never renders, and auto renders on TTY stdout.
func MarkdownEnabled(preference string, outTTY bool) bool {
return outTTY && preference != "raw"
}
// glamourLinks matches the OSC 8 hyperlinks that glamour writes for markdown links.
var glamourLinks = regexp.MustCompile("\x1b\\]8;[^\x07\x1b]*(?:\x07|\x1b\\\\)")
// renderers caches a glamour renderer per width and color, as building one parses its style each
// time; the lock also serializes rendering.
var renderers = struct {
sync.Mutex
byKey map[[2]int]*glamour.TermRenderer
}{byKey: map[[2]int]*glamour.TermRenderer{}}
func markdownRenderer(width int, color bool) (*glamour.TermRenderer, error) {
key := [2]int{width, 0}
if color {
key[1] = 1
}
if renderer := renderers.byKey[key]; renderer != nil {
return renderer, nil
}
style := styles.NoTTYStyleConfig
if color {
style = styles.DarkStyleConfig
// The terminal's own text color keeps body text readable on light backgrounds too.
style.Document.Color = nil
}
renderer, err := glamour.NewTermRenderer(glamour.WithStyles(style), glamour.WithWordWrap(width), glamour.WithPreservedNewLines())
if err == nil {
renderers.byKey[key] = renderer
}
return renderer, err
}
// Markdown renders sanitized markdown for d: wrapped to its width (80 when unknown), colored or plain,
// with links only when d allows them. It keeps line breaks like Gitea does, and returns the sanitized
// text unrendered if rendering fails.
func Markdown(text string, d Display) string {
text = SafeText(text)
width := d.Width
if width <= 0 {
width = 80
}
renderers.Lock()
renderer, err := markdownRenderer(width, d.Color)
if err != nil {
renderers.Unlock()
return text
}
rendered, err := renderer.Render(text)
renderers.Unlock()
if err != nil {
return text
}
if !d.Links {
rendered = glamourLinks.ReplaceAllString(rendered, "")
}
// glamour pads every line to the full width.
lines := strings.Split(rendered, "\n")
for i, line := range lines {
lines[i] = strings.TrimRight(line, " ")
}
return strings.Trim(strings.Join(lines, "\n"), "\n")
}