lambgofile

Documentation

Overview

Package lambgofile assists with loading and representing .lambgo.yml files.

Index

• Constants
• Variables
• type Config
• type ErkCannotLoadConfig
• type Loader
  • func (l *Loader) LoadConfig(pwd string) (*Config, error)
• type LoaderAPI

Constants

const ExampleFile = `` /* 662-byte string literal not displayed */

ExampleFile for use in error messages and CLI help menus.

Variables

var (
	ErrCannotFindGoModule  = erk.New(ErkCannotLoadConfig{}, "Cannot find root go.mod file by searching parent working directories")
	ErrCannotParseGoModule = erk.New(ErkCannotLoadConfig{}, "Cannot read module path from go.mod file: {{.path}}")
	ErrCannotOpenFile      = erk.New(ErkCannotLoadConfig{}, "Cannot open the file '{{.path}}': {{.err}}")
	ErrCannotUnmarshalFile = erk.New(ErkCannotLoadConfig{}, "Cannot parse the file '{{.path}}': {{.err}}")
	ErrCannotParseFlags    = erk.New(ErkCannotLoadConfig{}, "Cannot parse build flags '{{.flags}}': {{.err}}")
)

Types

type Config

type Config struct {
	DisableParallelBuild bool   `yaml:"-"`
	RootPath             string `yaml:"-"`
	ModulePath           string `yaml:"-"`

	OutDirectory   string   `yaml:"outDirectory"`
	ZippedFileName string   `yaml:"zippedFileName"`
	RawBuildFlags  string   `yaml:"buildFlags"`
	BuildFlags     []string `yaml:"-"`
	BuildPaths     []string `yaml:"buildPaths"`
}

Config is the root of the .lambgo.yml file.

type ErkCannotLoadConfig

type ErkCannotLoadConfig struct{ erk.DefaultKind }

type Loader

type Loader struct {
	FS fs.FS
}

Loader allows loading the project's .lambgo.yml file.

func (*Loader) LoadConfig

func (l *Loader) LoadConfig(pwd string) (*Config, error)

LoadConfig from the .lambgo.yml file that is located in pwd or a parent of pwd.

type LoaderAPI

type LoaderAPI interface {
	LoadConfig(pwd string) (*Config, error)
}