render

Feb 6, 2025

Changes in this version

type SettingsOption

+ func WithFilterKeys(keys ...string) SettingsOption

Apr 4, 2024

Changes in this version

type SettingsOption

+ func WithExport(boolean bool) SettingsOption

Feb 19, 2024

Changes in this version

type Handler

+ func NewAstSelectorHandler(selectors ...ast.Selector) Handler

Feb 15, 2024

Changes in this version

type Settings

+ InterpolatedValues bool

Feb 10, 2024

Changes in this version

type Handler

+ func RetainExactKey(value ...string) Handler

Feb 10, 2024

Changes in this version

+ var ExcludeActiveAssignments = newSelectorHandler(ast.ExcludeActiveAssignments)

+ var ExcludeComments = newSelectorHandler(ast.ExcludeComments)

+ var ExcludeDisabledAssignments = newSelectorHandler(ast.ExcludeDisabledAssignments)

+ var ExcludeHiddenViaAnnotation = newSelectorHandler(ast.ExcludeHiddenViaAnnotation)

type Handler

+ func ExcludeKeyPrefix(value string) Handler

+ func RetainGroup(value string) Handler

+ func RetainKeyPrefix(value string) Handler

type Settings

+ func (rs Settings) Handlers() []Handler

Feb 9, 2024

Changes in this version

+ type CompletionOutputKeys struct

+ func (CompletionOutputKeys) Assignment(a *ast.Assignment, settings Settings) *Lines

+ func (CompletionOutputKeys) GroupBanner(group *ast.Group, settings Settings) *Lines

+ func (r CompletionOutputKeys) Comment(comment *ast.Comment, settings Settings) *Lines

+ func (r CompletionOutputKeys) Newline(newline *ast.Newline, settings Settings) *Lines

type HandlerSignal

+ func FilterActiveStatements(hi *HandlerInput) HandlerSignal

type Lines

+ func (lb Lines) Lines() []string

+ type OutputType uint

+ const CompletionKeyOnly

type Renderer

+ func NewUnfilteredRenderer(settings Settings, additionalHandlers ...Handler) *Renderer

type SettingsOption

+ func WithOutputType(t OutputType) SettingsOption

+ func WithOutputter(o Output) SettingsOption

Feb 5, 2024

Changes in this version

+ type ColorizedOutput struct

+ func (ColorizedOutput) Assignment(assignment *ast.Assignment, settings Settings) *Lines

+ func (ColorizedOutput) Comment(comment *ast.Comment, settings Settings) *Lines

+ func (ColorizedOutput) GroupBanner(group *ast.Group, settings Settings) *Lines

+ func (ColorizedOutput) Newline(newline *ast.Newline, settings Settings) *Lines

type HandlerInput

+ CurrentStatement any

+ PreviousStatement ast.Statement

+ Renderer *Renderer

+ ReturnValue *Lines

+ type HandlerSignal uint

+ func FilterComments(hi *HandlerInput) HandlerSignal

+ func FilterDisabledStatements(hi *HandlerInput) HandlerSignal

+ func FilterGroupName(hi *HandlerInput) HandlerSignal

+ func FilterKeyPrefix(hi *HandlerInput) HandlerSignal

+ func FormatterHandler(hi *HandlerInput) HandlerSignal

+ func (hs HandlerSignal) String() string

+ type Line struct

+ Debug string

+ Literal string

+ func (l Line) String() string

+ type Lines struct

+ func NewLinesCollection() *Lines

+ func (lb *Lines) Add(value string) *Lines

+ func (lb *Lines) Append(buf *Lines) *Lines

+ func (lb *Lines) IsEmpty() bool

+ func (lb *Lines) Newline(id ...string) *Lines

+ func (lb Lines) String() string

+ type Output interface

+ Assignment func(*ast.Assignment, Settings) *Lines

+ Comment func(*ast.Comment, Settings) *Lines

+ GroupBanner func(*ast.Group, Settings) *Lines

+ Newline func(*ast.Newline, Settings) *Lines

+ type PlainOutput struct

+ func (PlainOutput) Assignment(a *ast.Assignment, settings Settings) *Lines

+ func (PlainOutput) GroupBanner(group *ast.Group, settings Settings) *Lines

+ func (r PlainOutput) Comment(comment *ast.Comment, settings Settings) *Lines

+ func (r PlainOutput) Newline(newline *ast.Newline, settings Settings) *Lines

type Renderer

+ PreviousStatement ast.Statement

type Settings

+ ShowGroupBanners bool

+ func NewSettings(options ...SettingsOption) *Settings

+ func (s *Settings) Apply(options ...SettingsOption) *Settings

+ type SettingsOption func(*Settings)

+ func WithBlankLines(b bool) SettingsOption

+ func WithColors(b bool) SettingsOption

+ func WithComments(b bool) SettingsOption

+ func WithFilterGroup(name string) SettingsOption

+ func WithFilterKeyPrefix(prefix string) SettingsOption

+ func WithFormattedOutput(b bool) SettingsOption

+ func WithGroupBanners(b bool) SettingsOption

+ func WithIncludeDisabled(b bool) SettingsOption

+ func WithInterpolation(b bool) SettingsOption

Feb 4, 2024

Changes in this version

+ const Newline

+ type Colorized struct

+ func (c Colorized) Assignment(a *ast.Assignment, settings Settings) string

+ func (c Colorized) Group(group *ast.Group, settings Settings) string

+ func (r Colorized) Comment(comment *ast.Comment, settings Settings, isAssignmentComment bool) string

+ func (r Colorized) Newline(newline *ast.Newline, settings Settings) string

+ type Handler func(in *HandlerInput) Signal

+ type HandlerInput struct

+ Presenter *Renderer

+ Previous ast.Statement

+ Settings Settings

+ Statement any

+ Value string

+ func (si *HandlerInput) Continue() Signal

+ func (si *HandlerInput) Return(val string) Signal

+ func (si *HandlerInput) Stop() Signal

+ type LineBuffer struct

+ func (lb *LineBuffer) Add(str string) *LineBuffer

+ func (lb *LineBuffer) AddPrinted(str string) bool

+ func (lb *LineBuffer) EnsureEOF() *LineBuffer

+ func (lb *LineBuffer) Get() string

+ func (lb *LineBuffer) GetWithEOF() string

+ func (lb *LineBuffer) Newline() *LineBuffer

+ type Outputter interface

+ Assignment func(*ast.Assignment, Settings) string

+ Comment func(*ast.Comment, Settings, bool) string

+ Group func(*ast.Group, Settings) string

+ Newline func(*ast.Newline, Settings) string

+ type Plain struct

+ func (c Plain) Assignment(a *ast.Assignment, settings Settings) string

+ func (c Plain) Group(group *ast.Group, settings Settings) string

+ func (r Plain) Comment(comment *ast.Comment, settings Settings, isAssignmentComment bool) string

+ func (r Plain) Newline(newline *ast.Newline, settings Settings) string

+ type Renderer struct

+ Output Outputter

+ Previous ast.Statement

+ Settings Settings

+ func NewFormatter() *Renderer

+ func NewRenderer(settings Settings, handlers ...Handler) *Renderer

+ func (r *Renderer) Assignment(a *ast.Assignment) string

+ func (r *Renderer) Comment(comment *ast.Comment, isAssignmentComment bool) string

+ func (r *Renderer) Document(doc *ast.Document) string

+ func (r *Renderer) Group(group *ast.Group) string

+ func (r *Renderer) Newline(newline *ast.Newline) string

+ func (r *Renderer) SetOutput(output Outputter)

+ func (r *Renderer) Statement(stmt any) string

+ type Settings struct

+ FilterGroup string

+ FilterKeyPrefix string

+ IncludeCommented bool

+ Interpolate bool

+ ShowBlankLines bool

+ ShowColors bool

+ ShowComments bool

+ ShowGroups bool

+ ShowPretty bool

+ func (rs *Settings) Match(assignment *ast.Assignment) bool

+ func (rs *Settings) WithBlankLines() bool

+ func (rs *Settings) WithColors() bool

+ func (rs *Settings) WithComments() bool

+ func (rs *Settings) WithGroups() bool

+ type Signal uint

+ const Continue

+ const Return

+ const Stop

+ func Format(in *HandlerInput) Signal

+ func (ss Signal) String() string