cliconfig

Documentation

Overview

Package cliconfig provides a configuration file loader.

It is intended for internal use by buildkite-agent only.

Index

• type File
  • func (f File) AbsolutePath() (string, error)
  • func (f File) Exists() bool
  • func (f *File) Load() error
• type Loader
  • func (l Loader) Errorf(format string, v ...any) error
  • func (l *Loader) Load() (warnings []string, err error)

Types

type File

type File struct {
	// The path to the file
	Path string

	// A map of key/values that was loaded from the file
	Config map[string]string
}

func (File) AbsolutePath

func (f File) AbsolutePath() (string, error)

func (File) Exists

func (f File) Exists() bool

func (*File) Load

func (f *File) Load() error

type Loader

type Loader struct {
	// The context that is passed when using a urfave/cli action
	CLI *cli.Context

	// The struct that the config values will be loaded into
	Config any

	// The logger used
	Logger logger.Logger

	// A slice of paths to files that should be used as config files
	DefaultConfigFilePaths []string

	// The file that was used when loading this configuration
	File *File
}

func (Loader) Errorf

func (l Loader) Errorf(format string, v ...any) error

func (*Loader) Load

func (l *Loader) Load() (warnings []string, err error)

Loads the config from the CLI and config files that are present and returns any warnings or errors