render

Documentation

Index

• Constants
• type ColorizedOutput
  • func (ColorizedOutput) Assignment(ctx context.Context, assignment *ast.Assignment, settings Settings) *Lines
  • func (ColorizedOutput) Comment(ctx context.Context, comment *ast.Comment, settings Settings) *Lines
  • func (ColorizedOutput) GroupBanner(ctx context.Context, group *ast.Group, settings Settings) *Lines
  • func (ColorizedOutput) Newline(ctx context.Context, newline *ast.Newline, settings Settings) *Lines
• type CompletionOutputKeys
  • func (CompletionOutputKeys) Assignment(ctx context.Context, assignment *ast.Assignment, settings Settings) *Lines
  • func (r CompletionOutputKeys) Comment(ctx context.Context, comment *ast.Comment, settings Settings) *Lines
  • func (CompletionOutputKeys) GroupBanner(ctx context.Context, group *ast.Group, settings Settings) *Lines
  • func (r CompletionOutputKeys) Newline(ctx context.Context, newline *ast.Newline, settings Settings) *Lines
• type Handler
  • func NewAstSelectorHandler(selectors ...ast.Selector) Handler
• type HandlerInput
  • func (hi *HandlerInput) Continue() HandlerSignal
  • func (hi *HandlerInput) Return(value *Lines) HandlerSignal
  • func (hi *HandlerInput) Stop() HandlerSignal
• type HandlerSignal
  • func FormatterHandler(ctx context.Context, input *HandlerInput) HandlerSignal
  • func (hs HandlerSignal) String() string
• type Line
  • func (l Line) String() string
• type Lines
  • 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) Lines() []string
  • func (lb *Lines) Newline(id ...string) *Lines
  • func (lb Lines) String() string
• type Output
• type OutputType
• type PlainOutput
  • func (PlainOutput) Assignment(ctx context.Context, assignment *ast.Assignment, settings Settings) *Lines
  • func (r PlainOutput) Comment(ctx context.Context, comment *ast.Comment, settings Settings) *Lines
  • func (PlainOutput) GroupBanner(ctx context.Context, group *ast.Group, settings Settings) *Lines
  • func (r PlainOutput) Newline(ctx context.Context, newline *ast.Newline, settings Settings) *Lines
• type Renderer
  • func NewFormatter() *Renderer
  • func NewRenderer(settings Settings, extraHandlers ...Handler) *Renderer
  • func NewUnfilteredRenderer(settings *Settings, extraHandlers ...Handler) *Renderer
  • func (r *Renderer) Statement(ctx context.Context, currentStatement any) *Lines
• type Settings
  • func NewSettings(options ...SettingsOption) *Settings
  • func (s *Settings) Apply(options ...SettingsOption) *Settings
  • func (rs Settings) Handlers() []ast.Selector
  • func (rs Settings) ShowBlankLines() bool
• type SettingsOption
  • func WithBlankLines(b bool) SettingsOption
  • func WithColors(b bool) SettingsOption
  • func WithComments(b bool) SettingsOption
  • func WithExport(boolean bool) SettingsOption
  • func WithFilterGroup(name string) SettingsOption
  • func WithFilterKeyPrefix(prefix string) SettingsOption
  • func WithFormattedOutput(boolean bool) SettingsOption
  • func WithGroupBanners(b bool) SettingsOption
  • func WithIncludeDisabled(b bool) SettingsOption
  • func WithInterpolation(b bool) SettingsOption
  • func WithOutputType(t OutputType) SettingsOption
  • func WithOutputter(o Output) SettingsOption

Constants

const Newline = "\n"

Types

type ColorizedOutput

type ColorizedOutput struct{}

func (ColorizedOutput) Assignment

func (ColorizedOutput) Assignment(ctx context.Context, assignment *ast.Assignment, settings Settings) *Lines

func (ColorizedOutput) Comment

func (ColorizedOutput) Comment(ctx context.Context, comment *ast.Comment, settings Settings) *Lines

func (ColorizedOutput) GroupBanner

func (ColorizedOutput) GroupBanner(ctx context.Context, group *ast.Group, settings Settings) *Lines

func (ColorizedOutput) Newline

func (ColorizedOutput) Newline(ctx context.Context, newline *ast.Newline, settings Settings) *Lines

type CompletionOutputKeys

type CompletionOutputKeys struct{}

func (CompletionOutputKeys) Assignment

func (CompletionOutputKeys) Assignment(ctx context.Context, assignment *ast.Assignment, settings Settings) *Lines

func (CompletionOutputKeys) Comment

func (r CompletionOutputKeys) Comment(ctx context.Context, comment *ast.Comment, settings Settings) *Lines

func (CompletionOutputKeys) GroupBanner

func (CompletionOutputKeys) GroupBanner(ctx context.Context, group *ast.Group, settings Settings) *Lines

func (CompletionOutputKeys) Newline

func (r CompletionOutputKeys) Newline(ctx context.Context, newline *ast.Newline, settings Settings) *Lines

type Handler

type Handler func(ctx context.Context, hi *HandlerInput) HandlerSignal

func NewAstSelectorHandler

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

type HandlerInput

type HandlerInput struct {
	CurrentStatement  any
	PreviousStatement ast.Statement
	Renderer          *Renderer
	ReturnValue       *Lines
	Settings          Settings
}

func (*HandlerInput) Continue

func (hi *HandlerInput) Continue() HandlerSignal

func (*HandlerInput) Return

func (hi *HandlerInput) Return(value *Lines) HandlerSignal

func (*HandlerInput) Stop

func (hi *HandlerInput) Stop() HandlerSignal

type HandlerSignal

type HandlerSignal uint

const (
	Continue HandlerSignal = iota
	Stop
	Return
)

func FormatterHandler

func FormatterHandler(ctx context.Context, input *HandlerInput) HandlerSignal

FormatterHandler is responsible for formatting an .env file according to our opinionated style.

func (HandlerSignal) String

func (hs HandlerSignal) String() string

String returns the string corresponding to the Handler Signal.

type Line

type Line struct {
	Literal string // The *real* value of the line being added
	Debug   string // A debug value to help track where NewLines are coming from (use DEBUG=1 to see them when using --pretty)
}

Line represents a line in an output

func (Line) String

func (l Line) String() string

type Lines

type Lines struct {
	// contains filtered or unexported fields
}

Lines is a collection of lines

func NewLinesCollection

func NewLinesCollection() *Lines

func (*Lines) Add

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

Add a new arbitrary string to the Lines instance

func (*Lines) Append

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

Append adds one Lines collection to the end of another if its's not empty

func (*Lines) IsEmpty

func (lb *Lines) IsEmpty() bool

IsEmpty returns if the Line has any lines or not

func (Lines) Lines

func (lb Lines) Lines() []string

Lines returns the raw slice of lines

func (*Lines) Newline

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

Newline adds a Newline to the collection

Optionally accepts a list of strings to help identify what the "origin" or reason for the newline is.

This can be seen when using [DEBUG=1] environment variable along with [--pretty] CLI flag

func (Lines) String

func (lb Lines) String() string

String joins all the LineItems together into slice and Join them by a newline + an additional trailing newline.

type Output

type Output interface {
	GroupBanner(ctx context.Context, group *ast.Group, settings Settings) *Lines
	Assignment(ctx context.Context, assignment *ast.Assignment, settings Settings) *Lines
	Comment(ctx context.Context, comment *ast.Comment, settings Settings) *Lines
	Newline(ctx context.Context, newline *ast.Newline, settings Settings) *Lines
}

type OutputType

type OutputType uint

const (
	Plain OutputType = iota
	Colorized
	CompletionKeyOnly
)

type PlainOutput

type PlainOutput struct{}

func (PlainOutput) Assignment

func (PlainOutput) Assignment(ctx context.Context, assignment *ast.Assignment, settings Settings) *Lines

func (PlainOutput) Comment

func (r PlainOutput) Comment(ctx context.Context, comment *ast.Comment, settings Settings) *Lines

func (PlainOutput) GroupBanner

func (PlainOutput) GroupBanner(ctx context.Context, group *ast.Group, settings Settings) *Lines

func (PlainOutput) Newline

func (r PlainOutput) Newline(ctx context.Context, newline *ast.Newline, settings Settings) *Lines

type Renderer

type Renderer struct {
	Output            Output
	PreviousStatement ast.Statement
	Settings          Settings
	// contains filtered or unexported fields
}

func NewFormatter

func NewFormatter() *Renderer

func NewRenderer

func NewRenderer(settings Settings, extraHandlers ...Handler) *Renderer

func NewUnfilteredRenderer

func NewUnfilteredRenderer(settings *Settings, extraHandlers ...Handler) *Renderer

func (*Renderer) Statement

func (r *Renderer) Statement(ctx context.Context, currentStatement any) *Lines

Statement is the main loop of the Renderer.

It's responsible for delegating statements to handlers, calling the right Output functions and track the ordering of Statements being rendered

type Settings

type Settings struct {
	ShowGroupBanners bool

	InterpolatedValues bool
	// contains filtered or unexported fields
}

func NewSettings

func NewSettings(options ...SettingsOption) *Settings

func (*Settings) Apply

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

func (Settings) Handlers

func (rs Settings) Handlers() []ast.Selector

func (Settings) ShowBlankLines

func (rs Settings) ShowBlankLines() bool

type SettingsOption

type SettingsOption func(*Settings)

func WithBlankLines

func WithBlankLines(b bool) SettingsOption

func WithColors

func WithColors(b bool) SettingsOption

func WithComments

func WithComments(b bool) SettingsOption

func WithExport

func WithExport(boolean bool) SettingsOption

func WithFilterGroup

func WithFilterGroup(name string) SettingsOption

func WithFilterKeyPrefix

func WithFilterKeyPrefix(prefix string) SettingsOption

func WithFormattedOutput

func WithFormattedOutput(boolean bool) SettingsOption

func WithGroupBanners

func WithGroupBanners(b bool) SettingsOption

func WithIncludeDisabled

func WithIncludeDisabled(b bool) SettingsOption

func WithInterpolation

func WithInterpolation(b bool) SettingsOption

func WithOutputType

func WithOutputType(t OutputType) SettingsOption

func WithOutputter

func WithOutputter(o Output) SettingsOption