fmt

Documentation

Index

• Constants
• Variables
• func FormatSource(filename string, content []byte, fmtrName string, config interface{}, ...) ([]byte, error)
• func Info(which string) (err error)
• func Pull(fmtr string) error
• func Run(args []string, rflags flags.RootPflagpole, cflags flags.FmtFlagpole) (err error)
• func Start(fmtr string, replace bool) error
• func Stop(fmtr string) error
• func Test(fmtr string) error
• func UpdateFormatterStatus() error
• type Formatter
  • func (fmtr *Formatter) Call(filename string, content []byte, config any) ([]byte, error)
  • func (fmtr *Formatter) WaitForReady(retry int, delay time.Duration) error
  • func (fmtr *Formatter) WaitForRunning(retry int, delay time.Duration) error
• type NoFormatterError
  • func NewNoFormatterError(filename, reason string) *NoFormatterError
  • func (e *NoFormatterError) Error() string

Constants

const ContainerPrefix = "hof-fmt-"

Variables

var (
	FORMAT_DISABLED        = false
	DOCKER_FORMAT_DISABLED = false
)

var CONTAINER_REPO = "ghcr.io/hofstadter-io"

(CONSIDER) make this comma separated, so we can have fallback?

Functions

func FormatSource

func FormatSource(filename string, content []byte, fmtrName string, config interface{}, formatData bool) ([]byte, error)

func Info

func Info(which string) (err error)

func Pull

func Pull(fmtr string) error

func Run

func Run(args []string, rflags flags.RootPflagpole, cflags flags.FmtFlagpole) (err error)

func Start

func Start(fmtr string, replace bool) error

func Stop

func Stop(fmtr string) error

func Test

func Test(fmtr string) error

func UpdateFormatterStatus

func UpdateFormatterStatus() error

Types

type Formatter

type Formatter struct {
	// name, same as tools/%
	Name      string
	Version   string
	Available []string

	// Info
	Status    string
	Running   bool
	Ready     bool
	Host      string
	Port      string
	Container *container.Container
	Images    []*container.Image

	Config  interface{}
	Default interface{}
}

func (*Formatter) Call

func (fmtr *Formatter) Call(filename string, content []byte, config any) ([]byte, error)

func (*Formatter) WaitForReady

func (fmtr *Formatter) WaitForReady(retry int, delay time.Duration) error

func (*Formatter) WaitForRunning

func (fmtr *Formatter) WaitForRunning(retry int, delay time.Duration) error

type NoFormatterError

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

func NewNoFormatterError

func NewNoFormatterError(filename, reason string) *NoFormatterError

func (*NoFormatterError) Error

func (e *NoFormatterError) Error() string