expander

package
v0.16.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 23, 2026 License: BSD-3-Clause Imports: 10 Imported by: 3

Documentation

Overview

Package expander provides an extension for representing expandable expressions in command line arguments. The main use case is for dynamically evaluating these expressions with values that occur during the execution of the evaluators.

Index

Constants

This section is empty.

Variables

View Source
var Nil = Func(nilImpl)

Nil provides an expander which always provides nil

Functions

func Fprint

func Fprint(w io.Writer, pattern *Pattern, e Interface) (count int, err error)

Fprint expands the pattern using the given expander and writes to the specified writer.

Types

type ErrUnknownToken

type ErrUnknownToken string

func (ErrUnknownToken) Error

func (e ErrUnknownToken) Error() string

type Func

type Func func(string) any

Func converts the given string key into its variable expansion

func (Func) Expand

func (f Func) Expand(key string) any

type Interface

type Interface interface {
	Expand(key string) any
}

Interface converts the given string key into its variable expansion

func Colors

func Colors() Interface

func Compose

func Compose(expanders ...Interface) Interface

func Env

func Env() Interface

func Prefix

func Prefix(p string, e Interface) Interface

Prefix provides an expander which looks for and cuts a given prefix and delegates the result to the underlying expander

func Reflect added in v0.12.0

func Reflect(v any) Interface

Reflect provides a simple expander around a given value using reflection

func Runtime added in v0.15.0

func Runtime() Interface

Runtime provides an expander for Go runtime variables: numCPU, os, arch, version. Intended for use with Prefix("go", Runtime()).

func Time

func Time(t time.Time) Interface

Time obtains an expander for the specified time

func Unknown

func Unknown() Interface

type Map

type Map map[string]any

func (Map) Expand

func (m Map) Expand(k string) any

type Pattern

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

func Compile

func Compile(pattern string) *Pattern

func CompilePattern

func CompilePattern(pattern, start, end string) *Pattern

func (*Pattern) Expand

func (p *Pattern) Expand(expand Interface) string

func (*Pattern) ExpandAny added in v0.16.0

func (p *Pattern) ExpandAny(expand Interface) any

ExpandAny expands the pattern, returning the underlying type of the expansion when the pattern consists of a single expression with no format specifier applied.. When the pattern has multiple expressions, a literal fallback, or a format specifier, it falls back to string interpolation like Expand.

func (*Pattern) Fprint added in v0.16.0

func (p *Pattern) Fprint(w io.Writer, e Interface) (count int, err error)

Fprint expands the pattern using the given expander and writes to the specified writer. As a special case, if w has a method Expander() Interface, this method will be called to obtain an expander which composes with the expander e. The main use of this convention is to allow writers to supply control expressions. For an example, see Renderer.

func (*Pattern) String

func (p *Pattern) String() string

func (*Pattern) WithMeta

func (p *Pattern) WithMeta(name string, pattern *Pattern) *Pattern

type Renderer

type Renderer struct {
	io.Writer
	// contains filtered or unexported fields
}

Renderer is a specialized writer that understands writing to multiple files and the corresponding variable support. When used as a writer to Fprint, two control expressions are exposed, stdout and stderr, which can be used to redirect to the underlying writers. For example, "%(stderr)debug: %(v:#v)%(newline)%(stdout)%(v)" would print debug text to whatever writer was set for stderr.

func NewRenderer

func NewRenderer(stdout, stderr io.Writer) *Renderer

func (*Renderer) Expander added in v0.16.0

func (r *Renderer) Expander() Interface

Expander gets the expander for Renderer, which exposes control expressions, stdout and stderr, which switch the writer to use

type Syntax

type Syntax int
const (
	// SyntaxDefault indicates that the expression syntax uses the
	// form <name>[':' <format>]. That is, an optional format string is allowed
	// to control the output.
	SyntaxDefault Syntax = iota

	// SyntaxRecursive causes recursive expression evaluation to
	// be allowed. For example, the expression ${VISUAL:${EDITOR}}
	// would evaluate both environment variables, falling back to EDITOR.
	SyntaxRecursive
)

func (Syntax) Compile

func (s Syntax) Compile(pattern string) *Pattern

func (Syntax) CompilePattern

func (s Syntax) CompilePattern(pattern, start, end string) *Pattern

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL