format

Documentation

Index

• func Run(dir string, args ...string) error
• func Source(src []byte) ([]byte, error)
• type Formatter
  • func New(cfg *config.Config) (*Formatter, error)
  • func (f *Formatter) Source(src []byte) ([]byte, error)

Functions

func Run

func Run(dir string, args ...string) error

Run formats Gunk files to be canonically formatted.

func Source

func Source(src []byte) ([]byte, error)

Source canonically formats a single Gunk file, returning the result and any error encountered.

Types

type Formatter

type Formatter struct {
	Config *config.Config
	// contains filtered or unexported fields
}

Formatter is a struct that holds the state of the formatter. A new formatter should be initialized when using different config.

func New

func New(cfg *config.Config) (*Formatter, error)

New creates a new instance of Formatter.

func (*Formatter) Source

func (f *Formatter) Source(src []byte) ([]byte, error)

Source canonically formats a single Gunk file using the formatter's config, returning the result and any error encountered.