basic

README

Basic Formatter

The basic formatter is a barebones formatter that simply takes the data provided, serializes it with gopkg.in/yaml.v3 and encodes it again. This provides a consistent output format that is very opinionated and cannot be configured.

Configuration

Key	Default	Description
indentation	2	The indentation level in spaces to use for the formatted yaml
include_document_start	false	Include --- at document start

Documentation

Index

• Constants
• type BasicFormatter
  • func (f *BasicFormatter) Format(yamlContent []byte) ([]byte, error)
  • func (f *BasicFormatter) Type() string
• type BasicFormatterFactory
  • func (f *BasicFormatterFactory) NewDefault() yamlfmt.Formatter
  • func (f *BasicFormatterFactory) NewWithConfig(configData map[string]interface{}) (yamlfmt.Formatter, error)
  • func (f *BasicFormatterFactory) Type() string
• type Config
  • func DefaultConfig() *Config

Constants

const BasicFormatterType string = "basic"

Types

type BasicFormatter

type BasicFormatter struct {
	Config *Config
}

func (*BasicFormatter) Format

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

func (*BasicFormatter) Type

func (f *BasicFormatter) Type() string

type BasicFormatterFactory

type BasicFormatterFactory struct{}

func (*BasicFormatterFactory) NewDefault

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

func (*BasicFormatterFactory) NewWithConfig

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

func (*BasicFormatterFactory) Type

func (f *BasicFormatterFactory) Type() string

type Config

type Config struct {
	Indent               int  `mapstructure:"indent"`
	IncludeDocumentStart bool `mapstructure:"include_document_start"`
}

func DefaultConfig

func DefaultConfig() *Config