config

package
v0.0.62-rc2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 16, 2026 License: MIT Imports: 24 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Checksum 

type Checksum map[string][]string

Checksum type for all checksum uses (env, command.env, command,checksum).

func (*Checksum) UnmarshalYAML 

func (c *Checksum) UnmarshalYAML(unmarshal func(any) error) error

UnmarshalYAML implements yaml.Unmarshaler interface.

type Cmd 

type Cmd struct {
	Name   string
	Script string // list will be joined
}

type Cmds 

type Cmds struct {
	Commands []*Cmd
	Append   bool
	Parallel bool
}

func (Cmds) AppendArgs 

func (c Cmds) AppendArgs(args []string)

AppendArgs appends arguments to cmd script.

func (Cmds) Clone 

func (c Cmds) Clone() Cmds

func (*Cmds) UnmarshalYAML 

func (c *Cmds) UnmarshalYAML(unmarshal func(any) error) error

UnmarshalYAML implements the yaml.Unmarshaler interface.

type Command 

type Command struct {
	Name      string
	GroupName string
	// Represents a list of commands (scripts)
	Cmds Cmds
	// script to run after cmd finished (cleanup, etc)
	After string
	// overrides global shell for this particular command
	Shell string
	// overrides global workdir (where lets.yaml is located) for this particular command
	WorkDir     string
	Description string
	// env from command
	Env *Envs
	// env files from command
	EnvFiles *EnvFiles
	// store docopts from options directive
	Docopts         string
	SkipDocopts     bool // default false
	Options         map[string]string
	CliOptions      map[string]string
	Depends         *Deps
	ChecksumMap     map[string]string
	PersistChecksum bool
	// args from 'lets run --debug' will become [--debug]
	Args []string

	ChecksumSources map[string][]string
	// contains filtered or unexported fields
}

func (*Command) ChecksumCalculator 

func (c *Command) ChecksumCalculator(workDir string) error

func (*Command) Clone 

func (c *Command) Clone() *Command

func (*Command) Dump 

func (c *Command) Dump() string

func (*Command) GetEnv 

func (c *Command) GetEnv(cfg Config, builtinEnv map[string]string) (map[string]string, error)

func (*Command) GetPersistedChecksums 

func (c *Command) GetPersistedChecksums() map[string]string

func (*Command) Help 

func (c *Command) Help() string

func (*Command) ReadChecksumsFromDisk 

func (c *Command) ReadChecksumsFromDisk(checksumsDir string, cmdName string, checksumMap map[string]string) error

ReadChecksumsFromDisk reads all checksums for cmd into map.

func (*Command) UnmarshalYAML 

func (c *Command) UnmarshalYAML(unmarshal func(any) error) error

type Commands 

type Commands map[string]*Command

type Config 

type Config struct {
	// absolute path to work dir - where config is placed
	WorkDir string
	// absolute path for lets config file
	FilePath string
	Commands Commands
	Shell    string
	// before is a script which will be included before every cmd
	Before string
	// init is a script which will be called exactly once before any command calls
	Init     string
	Env      *Envs
	EnvFiles *EnvFiles
	Version  string
	// absolute path to .lets
	DotLetsDir string
	// absolute path to .lets/checksums
	ChecksumsDir string
	// absolute path to .lets/mixins
	MixinsDir string

	// RemoteSource is the original URL when the config was loaded remotely; empty for local configs.
	RemoteSource string
	// contains filtered or unexported fields
}

Config is a struct for loaded config file.

func NewConfig 

func NewConfig(workDir string, configAbsPath string, dotLetsDir string) *Config

func NewMixinConfig 

func NewMixinConfig(cfg *Config, configAbsPath string) *Config

func (*Config) BuiltinEnv 

func (c *Config) BuiltinEnv(shell string) map[string]string

func (*Config) CommandBuiltinEnv 

func (c *Config) CommandBuiltinEnv(command *Command, shell string, workDir string) map[string]string

func (*Config) CreateChecksumsDir 

func (c *Config) CreateChecksumsDir() error

func (*Config) GetEnv 

func (c *Config) GetEnv() map[string]string

func (*Config) SetDownloadOptions added in v0.0.62 

func (c *Config) SetDownloadOptions(ctx context.Context, progress fetch.ProgressObserver, noCache bool)

func (*Config) SetupEnv 

func (c *Config) SetupEnv() error

SetupEnv must be called once. It is not intended to be called multiple times hence does not have mutex.

func (*Config) UnmarshalYAML 

func (c *Config) UnmarshalYAML(unmarshal func(any) error) error

type Dep 

type Dep struct {
	Name string
	Args []string
	Env  *Envs
}

func (Dep) Clone 

func (d Dep) Clone() Dep

func (Dep) HasArgs 

func (d Dep) HasArgs() bool

func (*Dep) UnmarshalYAML 

func (d *Dep) UnmarshalYAML(unmarshal func(any) error) error

UnmarshalYAML implements yaml.Unmarshaler interface.

type Deps 

type Deps struct {
	Keys    []string
	Mapping map[string]Dep
}

func (*Deps) Clone 

func (d *Deps) Clone() *Deps

func (*Deps) Get 

func (d *Deps) Get(key string) *Dep

Get get a value by a given key.

func (*Deps) Has 

func (d *Deps) Has(key string) bool

Has checks if a value exists by a given key.

func (*Deps) Range 

func (d *Deps) Range(yield func(key string, value Dep) error) error

Range allows you to loop into the Deps in its right order.

func (*Deps) Set 

func (d *Deps) Set(key string, value Dep)

Set sets a value to a given key.

func (*Deps) UnmarshalYAML 

func (d *Deps) UnmarshalYAML(node *yaml.Node) error

UnmarshalYAML implements the yaml.Unmarshaler interface.

type Env 

type Env struct {
	Name     string
	Value    string
	Sh       string
	Checksum Checksum
}

func (*Env) UnmarshalYAML 

func (e *Env) UnmarshalYAML(unmarshal func(any) error) error

UnmarshalYAML implements yaml.Unmarshaler interface.

type EnvFile 

type EnvFile struct {
	Name     string
	Required bool
}

func (*EnvFile) UnmarshalYAML 

func (e *EnvFile) UnmarshalYAML(unmarshal func(any) error) error

type EnvFiles 

type EnvFiles struct {
	Items []EnvFile
	// contains filtered or unexported fields
}

func (*EnvFiles) Append 

func (e *EnvFiles) Append(other *EnvFiles)

func (*EnvFiles) Clone 

func (e *EnvFiles) Clone() *EnvFiles

func (*EnvFiles) Load 

func (e *EnvFiles) Load(cfg Config, envMap map[string]string) (map[string]string, error)

func (*EnvFiles) UnmarshalYAML 

func (e *EnvFiles) UnmarshalYAML(node *yaml.Node) error

type Envs 

type Envs struct {
	Keys    []string
	Mapping map[string]Env
	// contains filtered or unexported fields
}

func (*Envs) Clone 

func (e *Envs) Clone() *Envs

func (*Envs) Dump 

func (e *Envs) Dump() map[string]string

func (*Envs) Empty 

func (e *Envs) Empty() bool

func (*Envs) Execute 

func (e *Envs) Execute(cfg Config, baseEnv map[string]string) error

Execute executes env entries for sh scrips and calculate checksums It is lazy and caches data on first call.

func (*Envs) Has 

func (e *Envs) Has(key string) bool

Has checks if a value exists by a given key.

func (*Envs) Merge 

func (e *Envs) Merge(other *Envs)

Merge merges the given Envs into the existing Envs. If current env not exists bu other exists we just init current env with other env.

func (*Envs) MergeMap 

func (e *Envs) MergeMap(other map[string]string)

MergeMap merges the given map into the existing Envs.

func (*Envs) Range 

func (e *Envs) Range(yield func(key string, value Env) error) error

Range allows you to loop into the envs in its right order.

func (*Envs) Set 

func (e *Envs) Set(key string, value Env)

Set sets a value to a given key.

func (*Envs) UnmarshalYAML 

func (e *Envs) UnmarshalYAML(node *yaml.Node) error

UnmarshalYAML implements the yaml.Unmarshaler interface.

type Mixin 

type Mixin struct {
	FileName string
	// e.g. .gitignored
	Ignored bool
	Remote  *RemoteMixin
}

func (*Mixin) IsRemote 

func (m *Mixin) IsRemote() bool

func (*Mixin) Source 

func (m *Mixin) Source() string

func (*Mixin) UnmarshalYAML 

func (m *Mixin) UnmarshalYAML(unmarshal func(any) error) error

type Mixins 

type Mixins []*Mixin

type RemoteMixin 

type RemoteMixin struct {
	URL     string
	Version string
	// contains filtered or unexported fields
}

func (*RemoteMixin) Filename 

func (rm *RemoteMixin) Filename() string

Filename is name of mixin file (hash from url).

func (*RemoteMixin) Path 

func (rm *RemoteMixin) Path() string

Path is abs path to mixin file (.lets/mixins/<filename>).

type Version 

type Version string

func (*Version) UnmarshalYAML 

func (v *Version) UnmarshalYAML(unmarshal func(any) error) error

UnmarshalYAML implements yaml.Unmarshaler interface.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.