config

Documentation

Index

• Constants
• Variables
• type Config
  • func Defaults() *Config
  • func ParseYAML(data []byte) (*Config, error)
  • func (c *Config) Clone() *Config
• type Filter
  • func (f *Filter) Evaluate(env interface{}) (bool, error)
• type FilterBlockEnv
• type FilterDocumentEnv
• type Loader
  • func NewLoader(configName, configType string, configRootPath fs.FS, opts ...LoaderOption) *Loader
  • func (l *Loader) FindConfigChain(path string) ([][]byte, error)
  • func (l *Loader) RootConfig() ([]byte, error)
  • func (l *Loader) SetConfigRootPath(configRootPath fs.FS)
• type LoaderOption
  • func WithLogger(logger *zap.Logger) LoaderOption
  • func WithProjectRootPath(projectRootPath fs.FS) LoaderOption

Constants

const (
	FilterTypeBlock    = "FILTER_TYPE_BLOCK"
	FilterTypeDocument = "FILTER_TYPE_DOCUMENT"
)

Variables

var ErrRootConfigNotFound = errors.New("root configuration file not found")

Types

type Config

type Config struct {
	ProjectRoot             string
	ProjectFilename         string
	ProjectFindRepoUpward   bool
	ProjectIgnorePaths      []string
	ProjectDisableGitignore bool
	ProjectEnvUseSystemEnv  bool
	ProjectEnvSources       []string
	ProjectFilters          []*Filter

	RuntimeDockerEnabled         bool
	RuntimeDockerImage           string
	RuntimeDockerBuildContext    string
	RuntimeDockerBuildDockerfile string

	ServerAddress     string
	ServerTLSEnabled  bool
	ServerTLSCertFile string
	ServerTLSKeyFile  string

	LogEnabled bool
	LogPath    string
	LogVerbose bool
}

Config is a flatten configuration of runme.yaml. The purpose of it is to unify all the different configuration versions into a single struct.

func Defaults

func Defaults() *Config

func ParseYAML

func ParseYAML(data []byte) (*Config, error)

func (*Config) Clone

func (c *Config) Clone() *Config

type Filter

type Filter struct {
	Type      string
	Condition string
	Extra     map[string]interface{}
}

func (*Filter) Evaluate

func (f *Filter) Evaluate(env interface{}) (bool, error)

type FilterBlockEnv

type FilterBlockEnv struct {
	Background             bool     `expr:"background"`
	CloseTerminalOnSuccess bool     `expr:"close_terminal_on_success"`
	Cwd                    string   `expr:"cwd"`
	ExcludeFromRunAll      bool     `expr:"exclude_from_run_all"`
	Interactive            bool     `expr:"interactive"`
	IsNamed                bool     `expr:"is_named"`
	Language               string   `expr:"language"`
	Name                   string   `expr:"name"`
	PromptEnv              bool     `expr:"prompt_env"`
	Tags                   []string `expr:"tags"`
}

FilterBlockEnv is the environment with fields corresponding to the options documented on https://docs.runme.dev/configuration/cell-level. Cell options are converted to this environment before evaluating the filter.

The `expr` tag is used to map the field to the corresponding option. Without it, all variables start with capitalized letters.

type FilterDocumentEnv

type FilterDocumentEnv struct {
	Cwd   string `expr:"cwd"`
	Shell string `expr:"shell"`
}

FilterDocumentEnv is the environment with fields corresponding to the options documented on https://docs.runme.dev/configuration/document-level. Document options are converted to this environment before evaluating the filter.

type Loader

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

Loader allows to load configuration files from a file system.

func NewLoader

func NewLoader(configName, configType string, configRootPath fs.FS, opts ...LoaderOption) *Loader

func (*Loader) FindConfigChain

func (l *Loader) FindConfigChain(path string) ([][]byte, error)

func (*Loader) RootConfig

func (l *Loader) RootConfig() ([]byte, error)

func (*Loader) SetConfigRootPath

func (l *Loader) SetConfigRootPath(configRootPath fs.FS)

type LoaderOption

type LoaderOption func(*Loader)

func WithLogger

func WithLogger(logger *zap.Logger) LoaderOption

func WithProjectRootPath

func WithProjectRootPath(projectRootPath fs.FS) LoaderOption