yam

Documentation

Index

• Variables
• func ExecDiff(want, got []byte) error
• func Format(fsys rwfs.FS, paths []string, options FormatOptions) error
• func Lint(fsys fs.FS, paths []string, handler DiffHandler, options FormatOptions) error
• type DiffHandler
• type FormatOptions

Variables

var (
	ErrDidNotPassLintCheck = errors.New("input did not pass the lint check")
)

Functions

func ExecDiff

func ExecDiff(want, got []byte) error

func Format

func Format(fsys rwfs.FS, paths []string, options FormatOptions) error

func Lint

func Lint(fsys fs.FS, paths []string, handler DiffHandler, options FormatOptions) error

Types

type DiffHandler

type DiffHandler func(want, got []byte) error

type FormatOptions

type FormatOptions struct {
	// EncodeOptions specifies the encoder-specific format options.
	EncodeOptions formatted.EncodeOptions

	// FinalNewline specifies whether to ensure the input has a final newline before
	// further formatting is applied.
	FinalNewline bool `mapstructure:"final-newline"`

	// TrimTrailingWhitespace specifies whether to trim any trailing space
	// characters from each line before further formatting is applied.
	TrimTrailingWhitespace bool `mapstructure:"trim-lines"`
}