core

Documentation

Index

• Constants
• type Age
  • func (a Age) ReadIdentity() (age.Identity, error)
• type Brews
  • func (c *Brews) Diff() (*DiffResult, error)
  • func (c *Brews) String() string
• type ConfigFile
  • func SetupEnv(cfgpath string) (ConfigFile, error)
  • func (c ConfigFile) EncryptedFiles() []string
• type ConfigMap
  • func (cm ConfigMap) Get(key string) *Brews
• type DiffResult
• type Exec
• type Flags
• type PathResolver
  • func (pr PathResolver) Resolve(ip string) (string, error)
• type Script
• type Template
  • func (t Template) ShouldTrim() bool
• type VarFile
  • func (vf *VarFile) UnmarshalYAML(unmarshal func(any) error) error
• type Variables

Constants

const EnvPrefix = "MMDOT_"

Types

type Age

type Age struct {
	Recipients   []string `yaml:"recipients"`
	IdentityFile string   `yaml:"identity_file"`
}

func (Age) ReadIdentity

func (a Age) ReadIdentity() (age.Identity, error)

type Brews

type Brews struct {
	Remove   bool     `yaml:"remove"`
	Outfile  string   `yaml:"outfile"`
	Includes []string `yaml:"includes"`
	Brews    []string `yaml:"brews"`
	Taps     []string `yaml:"taps"`
	Casks    []string `yaml:"casks"`
	MAS      []string `yaml:"mas"`
}

func (*Brews) Diff

func (c *Brews) Diff() (*DiffResult, error)

Diff returns a comparison between the brews in the Config and those installed on the machine. It categorizes brews into: - Present: Items in config and installed on the machine - Absent: Items in config but not installed on the machine - Extra: Items installed on the machine but not in the config (drift detection)

func (*Brews) String

func (c *Brews) String() string

String returns a shell script to install the taps and brews

type ConfigFile

type ConfigFile struct {
	Macros    map[string]string `yaml:"macros"`
	Exec      Exec              `yaml:"exec"`
	Age       Age               `yaml:"age"`
	Brews     ConfigMap         `yaml:"brews"`
	Variables Variables         `yaml:"variables"`
	Templates []Template        `yaml:"templates"`
	ConfigDir string            `yaml:"-"` // Directory containing the config file (not serialized)
}

func SetupEnv

func SetupEnv(cfgpath string) (ConfigFile, error)

func (ConfigFile) EncryptedFiles

func (c ConfigFile) EncryptedFiles() []string

Returns a list of all files that should to be encrypted

type ConfigMap

type ConfigMap map[string]*Brews

func (ConfigMap) Get

func (cm ConfigMap) Get(key string) *Brews

type DiffResult

type DiffResult struct {
	Present []string // Present on machine
	Absent  []string // Absent from machine
	Extra   []string // Present in config, Absent from machine
}

type Exec

type Exec struct {
	Shell   string   `yaml:"shell"`
	Scripts []Script `yaml:"scripts"`
}

ExecConfig represents the shell execution configuration

type Flags

type Flags struct {
	LogLevel       string
	ConfigFilePath string
}

type PathResolver

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

PathResolver provides a resolving service for paths that turns a relative or paths with '~' type symbols into absolute paths.

func (PathResolver) Resolve

func (pr PathResolver) Resolve(ip string) (string, error)

type Script

type Script struct {
	Path string   `yaml:"path"`
	Tags []string `yaml:"tags"`
}

Script represents a single executable script with associated tags

type Template

type Template struct {
	Name        string         `yaml:"name"`
	Tags        []string       `yaml:"tags"`
	Template    string         `yaml:"template"` // File or Template
	Output      string         `yaml:"output"`
	Permissions string         `yaml:"perm"` // Must be valid permissions
	Vars        map[string]any `yaml:"vars"`
	Trim        *bool          `yaml:"trim"` // Trim leading/trailing whitespace from output (default: true)
}

func (Template) ShouldTrim

func (t Template) ShouldTrim() bool

type VarFile

type VarFile struct {
	Path    string
	IsVault bool
}

func (*VarFile) UnmarshalYAML

func (vf *VarFile) UnmarshalYAML(unmarshal func(any) error) error

type Variables

type Variables struct {
	VarFiles []VarFile      `yaml:"var_files"`
	Vars     map[string]any `yaml:"vars"`
}