format

Documentation

Index

• Constants
• func Apply(format Format, input any, opts Options) (string, error)
• func ChangesAsText(changes *diff.Changes, opts Options) string
• func JQ(data interface{}, opts ...any) (string, error)
• func JSON(data any) (string, error)
• func Text(input any, opts ...any) (string, error)
• func YAML(data interface{}) (string, error)
• type Format
  • func (f *Format) Set(s string) error
  • func (f *Format) String() string
  • func (f *Format) Type() string
• type InvalidFormatError
  • func (e *InvalidFormatError) Error() string
• type Options
• type UnknownFormatError
  • func (e *UnknownFormatError) Error() string
• type UnknownInputTypeError
  • func (e *UnknownInputTypeError) Error() string

Constants

const (
	JSONFormat = "json"
	YAMLFormat = "yaml"
	TextFormat = "text"
	JQFormat   = "jq"
)

Functions

func Apply

func Apply(format Format, input any, opts Options) (string, error)

func ChangesAsText

func ChangesAsText(changes *diff.Changes, opts Options) string

func JQ

func JQ(data interface{}, opts ...any) (string, error)

func JSON

func JSON(data any) (string, error)

func Text

func Text(input any, opts ...any) (string, error)

func YAML

func YAML(data interface{}) (string, error)

Types

type Format

type Format struct {
	Name       string
	Expression string
}

func (*Format) Set

func (f *Format) Set(s string) error

func (*Format) String

func (f *Format) String() string

func (*Format) Type

func (f *Format) Type() string

type InvalidFormatError

type InvalidFormatError struct {
	Format string
}

func (*InvalidFormatError) Error

func (e *InvalidFormatError) Error() string

type Options

type Options struct {
	Indent    int
	StatsOnly bool
}

type UnknownFormatError

type UnknownFormatError struct {
	Format string
}

func (*UnknownFormatError) Error

func (e *UnknownFormatError) Error() string

type UnknownInputTypeError

type UnknownInputTypeError struct {
	Type string
}

func (*UnknownInputTypeError) Error

func (e *UnknownInputTypeError) Error() string