yaml

type Decoder ¶

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

func NewDecoder(r io.Reader) *Decoder

func (d *Decoder) Decode(v any) error

type Encoder ¶

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

func NewEncoder(w io.Writer) *Encoder

func (e *Encoder) Close() error

func (e *Encoder) Encode(v any) error

type Error ¶

type Error struct {
	Err         error
	Path        *yaml.Path
	Token       *token.Token
	Theme       *theme.Theme
	Formatter   string
	Source      []byte
	SourceLines int // Number of lines to show around the error in the source.
}

Error represents a YAML error. It includes the original error, and the *token.Token where the error occurred.

func NewError(err error, opts ...ErrorOpt) *Error

func (e Error) Error() string

type ErrorOpt ¶

type ErrorOpt func(e *Error)

func WithFormatter(formatter string) ErrorOpt

func WithPath(path *yaml.Path) ErrorOpt

func WithSource(source []byte) ErrorOpt

func WithSourceLines(lines int) ErrorOpt

func WithTheme(t *theme.Theme) ErrorOpt

func WithToken(tk *token.Token) ErrorOpt

type ErrorWrapper ¶

type ErrorWrapper struct {
	Opts []ErrorOpt
}

func NewErrorWrapper(opts ...ErrorOpt) *ErrorWrapper

func (ew *ErrorWrapper) Wrap(err error, opts ...ErrorOpt) error

type LookupCommentFunc ¶

type LookupCommentFunc func(commentMap map[string]string) func(t reflect.Type, f string) string

type PrintFunc ¶

type PrintFunc func() *Property

PrintFunc returns property instance.

type Printer ¶

type Printer struct {
	MapKey  PrintFunc
	Anchor  PrintFunc
	Alias   PrintFunc
	Bool    PrintFunc
	String  PrintFunc
	Number  PrintFunc
	Comment PrintFunc
}

Printer create text from token collection or ast. This is a simplified version of github.com/goccy/go-yaml/printer.Printer, with styling and annotation functionality removed.

func (p *Printer) PrintErrorToken(tk *token.Token, lines int) (string, int)

func (p *Printer) PrintTokens(tokens token.Tokens) string

type Property ¶

type Property struct {
	Prefix string
	Suffix string
}

Property additional property set for each the token.

type SchemaGenerator ¶

type SchemaGenerator struct {
	Reflector         *jsonschema.Reflector
	LookupCommentFunc LookupCommentFunc

	Tests bool // Include test files.
	// contains filtered or unexported fields
}

SchemaGenerator generates a JSON schema from a Go type using reflection. It looks up comments from the source code to provide documentation, one or more package paths are provided. Uses github.com/invopop/jsonschema.

func NewSchemaGenerator(reflectTarget any, packagePaths ...string) *SchemaGenerator

func (g *SchemaGenerator) Generate() ([]byte, error)

type Validator ¶

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

Validator validates data against a JSON schema. Uses github.com/santhosh-tekuri/jsonschema/v6.

func MustNewValidator(url string, schemaData []byte) *Validator

func NewValidator(url string, schemaData []byte) (*Validator, error)

func (s *Validator) Validate(data any) error