yamlfmt

package module

v0.1.0 Latest Latest Go to latest Published: Oct 25, 2023 License: Apache-2.0 Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/melt-inc/yamlfmt

Links

Open Source Insights

README ¶

YAMLfmt

YAMLfmt is a compact, efficient, and comment-preserving YAML formatter built on top of kubernetes-sigs/yaml and go-yaml — the same core code used by kubectl.

Documentation ¶

Index ¶

func Ffmt(in io.Reader, out io.Writer, opt ...Option) error
func NewEncoder(w io.Writer, opts ...Option) *yaml.Encoder
func NewReader(r io.Reader) io.Reader
func Sfmt(in string, opt ...Option) (string, error)
func Transcode(in decoder, out encoder) (err error)
type CRLFTransformer
- func (t *CRLFTransformer) Reset()
- func (t *CRLFTransformer) Transform(dst, src []byte, atEOF bool) (j int, i int, err error)
type Option
- func WithCompactSequenceStyle(compact bool) Option
- func WithIndentSize(size int) Option

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Ffmt ¶

func Ffmt(in io.Reader, out io.Writer, opt ...Option) error

Ffmt reads unformatted yaml from in and writes formatted yaml to out

func NewEncoder ¶

func NewEncoder(w io.Writer, opts ...Option) *yaml.Encoder

func NewReader ¶

func NewReader(r io.Reader) io.Reader

NewReader returns a reader that transforms all CRLF in r to LF

func Sfmt ¶

func Sfmt(in string, opt ...Option) (string, error)

Sfmt formats the input yaml string and returns it

func Transcode ¶

func Transcode(in decoder, out encoder) (err error)

Transcode decodes and encodes every yaml document from in to out

Types ¶

type CRLFTransformer ¶

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

func (*CRLFTransformer) Reset ¶

func (t *CRLFTransformer) Reset()

func (*CRLFTransformer) Transform ¶

func (t *CRLFTransformer) Transform(dst, src []byte, atEOF bool) (j int, i int, err error)

type Option ¶

type Option func(*yaml.Encoder)

func WithCompactSequenceStyle ¶

func WithCompactSequenceStyle(compact bool) Option

func WithIndentSize ¶

func WithIndentSize(size int) Option

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
cmd

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