Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

basic

package

Go to main page

Versions in this module

v0

v0.21.0

Jan 5, 2026

Changes in this version

type Config

+ ForceQuoteStyle yamlFeatures.QuoteStyle

v0.20.0

Oct 22, 2025

v0.19.0

Oct 17, 2025

v0.18.1

Oct 16, 2025

v0.18.0

Oct 14, 2025

v0.17.2

Jun 23, 2025

v0.17.1

Jun 19, 2025

v0.17.0

May 25, 2025

Changes in this version

type Config

+ DisableAliasKeyCorrection bool

+ ForceArrayStyle yamlFeatures.SequenceStyle

v0.16.0

Feb 10, 2025

Changes in this version

type Config

+ ArrayIndent int

+ IndentRootArray bool

v0.15.0

Jan 10, 2025

v0.14.0

Nov 1, 2024

Changes in this version

type Config

+ StripDirectives bool

v0.13.0

Jun 24, 2024

Changes in this version

type BasicFormatter

+ func (f *BasicFormatter) ConfigMap() (map[string]any, error)

type Config

+ EOFNewline bool

+ TrimTrailingWhitespace bool

v0.12.1

May 4, 2024

v0.12.0

May 3, 2024

v0.11.0

Feb 10, 2024

Changes in this version

type Config

+ RetainLineBreaksSingle bool

v0.10.0

Sep 2, 2023

v0.9.0

Apr 2, 2023

Changes in this version

type Config

+ DropMergeTag bool

+ PadLineComments int

v0.8.0

Mar 18, 2023

Changes in this version

type Config

+ IndentlessArrays bool

v0.7.1

Jan 8, 2023

v0.7.0

Jan 8, 2023

Changes in this version

type Config

+ LineLength int

+ ScanFoldedAsLiteral bool

v0.6.0

Nov 1, 2022

Changes in this version

type BasicFormatter

+ YAMLFeatures YAMLFeatureList

type Config

+ DisallowAnchors bool

+ type YAMLFeatureFunc func(yaml.Node) error

+ type YAMLFeatureList []YAMLFeatureFunc

+ func ConfigureYAMLFeaturesFromConfig(config *Config) YAMLFeatureList

+ func (fl YAMLFeatureList) ApplyFeatures(node yaml.Node) error

v0.5.0

Sep 22, 2022

Changes in this version

+ type BasicFormatterError struct

+ func (e BasicFormatterError) Error() string

+ func (e BasicFormatterError) Unwrap() error

type BasicFormatterFactory

+ func (f *BasicFormatterFactory) NewFormatter(configData map[string]interface{}) (yamlfmt.Formatter, error)

v0.4.0

Sep 19, 2022

Changes in this version

+ func ConfigureFeaturesFromConfig(config *Config) yamlfmt.FeatureList

type BasicFormatter

+ Features yamlfmt.FeatureList

type Config

+ EmojiSupport bool

+ RetainLineBreaks bool

v0.3.0

Aug 27, 2022

Changes in this version

type Config

+ LineEnding string

v0.2.0

Aug 23, 2022

Changes in this version

type Config

+ IncludeDocumentStart bool

v0.1.0

Aug 22, 2022

Changes in this version

+ const BasicFormatterType

+ type BasicFormatter struct

+ Config *Config

+ func (f *BasicFormatter) Format(yamlContent []byte) ([]byte, error)

+ func (f *BasicFormatter) Type() string

+ type BasicFormatterFactory struct

+ func (f *BasicFormatterFactory) NewDefault() yamlfmt.Formatter

+ func (f *BasicFormatterFactory) NewWithConfig(configData map[string]interface{}) (yamlfmt.Formatter, error)

+ func (f *BasicFormatterFactory) Type() string

+ type Config struct

+ Indent int

+ func DefaultConfig() *Config