Types

This page documents all exported types in the nuri package. These types are defined in the ast package and re-exported so consumers write nuri.Element, nuri.CodeToHTMLOptions, etc. The theme.FontStyle type used in token styles is documented in Theme Package.

Options structs

CodeToHTMLOptions

1
type CodeToHTMLOptions struct {
2
    Lang           string
3
    Theme          string
4
    Themes         map[string]string
5
    DefaultColor   *bool
6
    Transformers   []Transformer
7
    HighlightLines []LineRange
8
    FocusLines     []LineRange
9
    InsertedLines  []LineRange
10
    DeletedLines   []LineRange
11
    PreClass       string
12
    CodeClass      string
13
    PreAttrs       map[string]string
14
    CodeAttrs      map[string]string
15
    ClassMap       *StyleClassMap
16
    MaxLineLength  *int
17
    TimeoutMs      *int
18
}

Configures an h.CodeToHTML() call.

CodeToTokensOptions

1
type CodeToTokensOptions struct {
2
    Lang          string
3
    Theme         string
4
    Themes        map[string]string
5
    MaxLineLength *int
6
    TimeoutMs     *int
7
}

Configures an h.CodeToTokens() call.

CodeToANSIOptions

1
type CodeToANSIOptions struct {
2
    Lang          string
3
    Theme         string
4
    ColorDepth    ColorDepth
5
    MaxLineLength *int
6
    TimeoutMs     *int
7
}

Configures an h.CodeToANSI() call.

CodeToSVGOptions

1
type CodeToSVGOptions struct {
2
    Lang           string
3
    Theme          string
4
    MaxLineLength  *int
5
    TimeoutMs      *int
6
    FontFamily     string
7
    FontSize       float64
8
    LineHeight     float64
9
    PadX           float64
10
    PadY           float64
11
    TabWidth       int
12
    CornerRadius   float64
13
    ShowBackground *bool
14
}

Configures an h.CodeToSVG() call. SVG-specific fields use renderer defaults when zero-valued.

CodeToJSONOptions

1
type CodeToJSONOptions struct {
2
    Lang          string
3
    Theme         string
4
    Themes        map[string]string
5
    MaxLineLength *int
6
    TimeoutMs     *int
7
    Indent        bool
8
}

Configures an h.CodeToJSON() call.

CodeToPlainTextOptions

1
type CodeToPlainTextOptions struct {
2
    Lang          string
3
    Theme         string
4
    MaxLineLength *int
5
    TimeoutMs     *int
6
}

Configures an h.CodeToPlainText() call. Theme is accepted for API uniformity but has no effect on the output.

Result types

TokensResult

1
type TokensResult struct {
2
    Tokens      [][]ThemedToken    `json:"tokens"`
3
    FG          string             `json:"fg"`
4
    BG          string             `json:"bg"`
5
    ThemeName   string             `json:"themeName"`
6
    Diagnostics []Diagnostic       `json:"diagnostics,omitempty"`
7
    ThemeFG     map[string]string  `json:"themeFG,omitempty"`
8
    ThemeBG     map[string]string  `json:"themeBG,omitempty"`
9
    ThemeNames  []string           `json:"themeNames,omitempty"`
10
}

Output of h.CodeToTokens() and h.CodeToHighlightedTokens().

ThemedToken

1
type ThemedToken struct {
2
    Content     string                `json:"content"`
3
    Color       string                `json:"color,omitempty"`
4
    BgColor     string                `json:"bgColor,omitempty"`
5
    FontStyle   theme.FontStyle       `json:"fontStyle"`
6
    Scopes      []string              `json:"scopes,omitempty"`
7
    ThemeStyles map[string]TokenStyle `json:"themeStyles,omitempty"`
8
}

A single token with resolved style information.

TokenStyle

1
type TokenStyle struct {
2
    Color     string          `json:"color,omitempty"`
3
    BgColor   string          `json:"bgColor,omitempty"`
4
    FontStyle theme.FontStyle `json:"fontStyle"`
5
}

Resolved style for a single theme. Used as values in ThemedToken.ThemeStyles.

Diagnostics

Diagnostic

1
type Diagnostic struct {
2
    Line int    `json:"line"`
3
    Kind string `json:"kind"`
4
}

Records a non-fatal degradation during tokenization. Line is 0-based.

HTML AST

Node

1
type Node interface {
2
    WriteTo(w io.Writer) (int64, error)
3
}

An HTML node that can serialize itself. Satisfies io.WriterTo. Both *Element and *Text implement this interface.

Element

1
type Element struct {
2
    Tag      string
3
    Classes  []string
4
    Styles   map[string]string
5
    Attrs    map[string]string
6
    Children []Node
7
}

An HTML element node. Styles and attributes are emitted in sorted key order for deterministic output.

Methods:

• AddClass(class string) -- appends a CSS class if not already present.
• SetAttr(key, val string) -- sets an HTML attribute. Initializes the Attrs map if nil.
• WriteTo(w io.Writer) (int64, error) -- serializes the element and its children to w. Style values and attribute values are HTML-escaped.

Text

1
type Text struct {
2
    Content string
3
}

A text node. Content is HTML-escaped on write (<, >, & become <, >, &).

Methods:

• WriteTo(w io.Writer) (int64, error) -- writes the HTML-escaped content to w.

Line decorations

LineRange

1
type LineRange struct {
2
    Start int
3
    End   int
4
}

A 1-based inclusive range of lines. Used in CodeToHTMLOptions decoration fields (HighlightLines, FocusLines, InsertedLines, DeletedLines).

Methods:

• Contains(line int) bool -- reports whether the range includes line (1-based).

Range

1
func Range(start, end int) LineRange

Returns a LineRange spanning from start to end (1-based, inclusive).

Lines

1
func Lines(nums ...int) []LineRange

Returns a slice of single-line LineRange values. Each Start and End equals the given line number.

InRanges

1
func InRanges(ranges []LineRange, line int) bool

Reports whether line is contained in any of the given ranges.

Style-to-class

StyleClassMap

1
type StyleClassMap struct { /* unexported fields */ }

Collects unique style combinations and assigns deterministic hashed class names. Pass a shared instance across multiple h.CodeToHTML() calls via CodeToHTMLOptions.ClassMap to deduplicate styles, then call CSS() for the stylesheet.

Constructor:

1
func NewStyleClassMap() *StyleClassMap

Methods:

• Get(styles map[string]string) string -- returns the class name for the given style map, creating a new hashed class if this combination is new.
• CSS() string -- returns the complete stylesheet. Rules are sorted by class name for deterministic output.

CanonicalStyles

1
func CanonicalStyles(styles map[string]string) string

Produces a deterministic string key from a style map. Keys are sorted; format is key1:val1;key2:val2. Used as the deduplication key in StyleClassMap.Get.

StyleHash

1
func StyleHash(canon string) string

Computes a deterministic short hash from a canonical style string using FNV-64a. Returns a string of the form _s_{hexdigest}.

StylestoCSS

1
func StylestoCSS(styles map[string]string) string

Converts a style map to a CSS rule body string. Keys are sorted; format is key1: val1; key2: val2.

Theme colors

ThemeColors

1
type ThemeColors struct {
2
    Type                string
3
    Background          string
4
    Foreground          string
5
    SelectionBackground string
6
    LineHighlightBg     string
7
    Colors              map[string]string
8
}

Exposes a theme's UI colors. Returned by h.GetThemeColors().

Color depth

ColorDepth

1
type ColorDepth int

Specifies the ANSI color mode for terminal output.

Font style

The FontStyle type is defined in the theme package as theme.FontStyle. It appears in ThemedToken.FontStyle and TokenStyle.FontStyle. See Theme Package for the type definition, constants (FontStyleNone, FontStyleItalic, FontStyleBold, FontStyleUnderline, FontStyleStrikethrough), and the Has() method.