tools

type Aliases = unmarshal.SingleOrSliceType[string]

type Checker struct {
	// Test defines the commands that should be run to test or validate the tool's functionality.
	Test command.Commands
	// Checksum is used for verifying the integrity of the tool (e.g., via a hash).
	Checksum Checksum
}

type Checksum struct {
	// Path to the checksum file.
	Path string
	// Enabled specifies whether checksum verification is enabled.
	Enabled bool
}

type Condition struct {
	// Condition is a string that represents a boolean expression (e.g., "true" or "false") that determines whether the
	// operation should be skipped.
	Condition string
	// Reason provides an optional explanation for why the operation is being skipped.
	Reason string
}

type Defaults struct {
	// Exe specifies default executable details such as patterns for identifying the binary.
	Exe Exe
	// Output specifies the default output path for the tool.
	Output string
	// Platform defines default platform-specific settings (e.g., OS and architecture).
	Platform detect.Platform
	// Values contains default custom values for the tool configuration.
	Values map[string]any
	// Fallbacks defines default fallback configurations or sources in case the primary configuration fails.
	Fallbacks []string
	// Hints provide default matching patterns or heuristics for the tool.
	Hints match.Hints
	// Source defines the default source configuration for fetching the tool (e.g., GitHub, local files).
	Source sources.Source
	// Tags are default labels or markers for categorizing the tool.
	Tags Tags
	// Strategy defines the default deployment or fetching strategy for the tool.
	Strategy Strategy
	// Extensions lists default additional file extensions related to the tool.
	Extensions []string
	// Env defines default environment variables applied when running the tool.
	Env env.Env
	// Mode specifies the default operating mode for the tool (e.g., silent mode, verbose mode).
	Mode Mode
	// Version specifies the default version details for the tool.
	Version Version
}

type Exe struct {
	// Name is the name under which the binary will be stored in the output folder.
	Name string
	// Patterns specifies the patterns used to locate the binary in the downloaded folder.
	// This can either be a single string or a slice of strings.
	Patterns unmarshal.SingleOrSliceType[string]
}

type Extensions = unmarshal.SingleOrSliceType[string]

type Fallbacks = unmarshal.SingleOrSliceType[sources.Type]

type Mode string

type Settings struct {
}

type Skip []Condition

type Strategy string

type Tags []string

type Tool struct {
	// Name of the tool, usually a short identifier or title.
	Name string
	// Description of the tool, giving more context about its purpose.
	Description string
	// Version specifies the version of the tool.
	Version Version
	// Path represents the URL or file path where the tool can be fetched or downloaded from.
	Path string
	// Output defines the output path where the tool will be installed or extracted.
	Output string
	// Exe specifies the executable details for the tool, such as patterns or names for locating the binary.
	Exe Exe
	// Platform defines the platform-specific details for the tool, including OS and architecture constraints.
	Platform detect.Platform
	// Aliases represent alternative names or shortcuts for the tool.
	Aliases Aliases
	// Values contains custom values or variables used in the tool's configuration.
	Values map[string]any
	// Fallbacks defines fallback configurations in case the primary configuration fails.
	Fallbacks Fallbacks
	// Hints provide additional matching patterns or heuristics for the tool.
	Hints match.Hints
	// Source defines the source configuration, which determines how the tool is fetched (e.g., GitHub, local files).
	Source sources.Source
	// Tags are labels or markers that can be used to categorize or filter the tool.
	Tags Tags
	// Strategy defines how the tool is deployed, fetched, or managed (e.g., download strategies, handling retries).
	Strategy Strategy
	// Extensions lists additional files or behaviors that are tied to the tool.
	Extensions Extensions
	// Skip defines conditions under which certain steps (e.g., downloading, testing) are skipped.
	Skip Skip
	// Post defines commands that should be run after the main operation, such as post-installation steps.
	Post command.Commands
	// Mode defines the operating mode for the tool, potentially controlling behavior such as silent mode or verbose
	// mode.
	Mode Mode
	// Settings contains custom settings or options that modify the behavior of the tool.
	Settings Settings
	// Env defines the environment variables that are applied when running the tool.
	Env env.Env
	// Check defines a set of instructions for verifying the tool's integrity or functionality.
	Check Checker
	// NoVerifySSL specifies whether SSL verification should be disabled when fetching the tool.
	NoVerifySSL bool `yaml:"no_verify_ssl"`
}

type Tools []Tool

type Version struct {
	// Version holds the string representation of the parsed version.
	Version string
	// Commands contains the list of command strategies used to extract the version.
	Commands unmarshal.SingleOrSliceType[string]
	// Patterns contains the list of regex patterns for parsing the version from output strings.
	Patterns unmarshal.SingleOrSliceType[string]
}