bindown

type AddDependencyFromTemplateOpts struct {
	TemplateSource string
	DependencyName string
	Vars           map[string]string
}

type Config struct {
	// The directory where bindown will cache downloads and extracted files. This is relative to the directory where
	// the configuration file resides. cache paths should always use / as a delimiter even on Windows or other
	// operating systems where the native delimiter isn't /.
	Cache string `json:"cache,omitempty" yaml:"cache,omitempty"`

	// The directory that bindown installs files to. This is relative to the directory where the configuration file
	// resides. install_directory paths should always use / as a delimiter even on Windows or other operating systems
	// where the native delimiter isn't /.
	InstallDir string `json:"install_dir,omitempty" yaml:"install_dir,omitempty"`

	// List of systems supported by this config. Systems are in the form of os/architecture.
	Systems []System `json:"systems,omitempty" yaml:"systems,omitempty"`

	// Dependencies available for bindown to install.
	Dependencies map[string]*Dependency `json:"dependencies,omitempty" yaml:",omitempty"`

	// Templates that can be used by dependencies in this file.
	Templates map[string]*Dependency `json:"templates,omitempty" yaml:",omitempty"`

	// Upstream sources for templates.
	TemplateSources map[string]string `json:"template_sources,omitempty" yaml:"template_sources,omitempty"`

	// Checksums of downloaded files.
	URLChecksums map[string]string `json:"url_checksums,omitempty" yaml:"url_checksums,omitempty"`

	Filename string `json:"-" yaml:"-"`
}

type ConfigDownloadDependenciesOpts struct {
	Force                bool
	AllowMissingChecksum bool
	AllDeps              bool
	Stdout               io.Writer
}

type ConfigExtractDependenciesOpts struct {
	AllowMissingChecksum bool
	AllDeps              bool
	Stdout               io.Writer
}

type ConfigInstallDependenciesOpts struct {
	Output               string
	TargetDir            string
	Stdout               io.Writer
	Force                bool
	AllowMissingChecksum bool
	ToCache              bool
	AllDeps              bool
}

type ConfigInstallDependencyOpts struct {
	// TargetPath is the path where the executable should end up
	TargetPath string
	// Force - install even if it already exists
	Force bool
	// AllowMissingChecksum - whether to allow missing checksum
	AllowMissingChecksum bool
	// ToCache - if set, the dependency will be installed to a cache directory. ToCache overrides TargetPath.
	ToCache bool
}

type ConfigWrapDependenciesOpts struct {
	Output               string
	BindownExec          string
	BindownTag           string
	BindownWrapped       string
	BaseURL              string
	AllowMissingChecksum bool
	AllDeps              bool
	Stdout               io.Writer
}

type Dependency struct {
	// The homepage for this dependency. Informational only.
	Homepage *string `json:"homepage,omitempty" yaml:",omitempty"`

	// A description of the dependency. Informational only.
	Description *string `json:"description,omitempty" yaml:",omitempty"`

	// A template for this dependency. Value is the name of a template in the templates section of this config.
	// Any unset fields in this dependency will be set by values from the template. Overrides in the dependency
	// and its template are concatenated with the template's overrides coming first. Vars and substitutions
	// are both combined with the dependency's value taking precedence.
	Template *string `json:"template,omitempty" yaml:",omitempty"`

	Overrideable `json:",inline" yaml:",inline"`

	// List of systems this dependency supports. Systems are in the form of os/architecture.
	Systems []System `json:"systems,omitempty" yaml:"systems,omitempty"`

	// A list of variables that must be present for an install to succeed
	RequiredVars []string `json:"required_vars,omitempty" yaml:"required_vars,omitempty"`
	// contains filtered or unexported fields
}

type DependencyOverride struct {
	// Limits the override to configurations matching all of the matchers. Keys may be "os", "arch" or any variable name.
	// Values are an array of values to match. Any matching value will match. If a value can be interpreted as a
	// semantic version it will be treated as such.
	OverrideMatcher map[string][]string `json:"matcher" yaml:"matcher,omitempty"`

	// Values to override the parent dependency
	Dependency Overrideable `json:"dependency" yaml:"dependency,omitempty"`
}

type Overrideable struct {
	// The url to download a dependency from.
	URL *string `json:"url,omitempty" yaml:",omitempty"`

	// The path in the downloaded archive where the binary is located. Default is ./<bin>
	ArchivePath *string `json:"archive_path,omitempty" yaml:"archive_path,omitempty"`

	// The name of the binary to be installed. Default is the name of the dependency.
	BinName *string `json:"bin,omitempty" yaml:"bin,omitempty"`

	// Whether to create a symlink to the bin instead of copying it.
	Link *bool `json:"link,omitempty" yaml:",omitempty"`

	// A list of variables that can be used in 'url', 'archive_path' and 'bin'.
	//
	// Two variables are always added based on the current environment: 'os' and 'arch'. Those are the operating
	// system and architecture as defined by go's GOOS and GOARCH variables. I should document what those are
	// somewhere.
	//
	// You can reference a variable using golang template syntax. For example, you could have a url set to
	// `https://example.org/mydependency/v{{.version}}/mydependency-{{.os}}-{{.arch}}.tar.gz`.  If you define the var
	// 'version: 1.2.3' and run bindown on a 64-bit Linux system, it will download
	// `https://example.org/mydependency/v1.2.3/mydependency-linux-amd64.tar.gz`.
	Vars map[string]string `json:"vars,omitempty" yaml:",omitempty"`

	// Overrides allows you to override values depending on the os and architecture of the target system.
	Overrides []DependencyOverride `json:"overrides,omitempty" yaml:",omitempty"`

	// Substitutions will substitute values from vars. The key is the name of the variable to substitute. The value is
	// a map of substitutions. { "os": { "linux": "Linux", "darwin": "MacOS" } } is an example of a substitution that
	// will update the os variable.
	Substitutions map[string]map[string]string `json:"substitutions,omitempty" yaml:",omitempty"`
}

type System string