manifest

type Action interface {
	Apply(p *Package) error
	String() string
	// contains filtered or unexported methods
}

type AnnotatedManifest struct {
	FS        fs.FS
	Path      string // Fully qualified path to manifest, including the FS.
	Name      string
	Errors    []error
	*Manifest // May be nil if errors were encountered.
}

type AutoVersionBlock struct {
	GitHubRelease string                `hcl:"github-release,optional" help:"GitHub <user>/<repo> to retrieve and update versions from the releases API."`
	HTML          *HTMLAutoVersionBlock `hcl:"html,block" help:"Extract version information from a HTML URL using XPath."`

	VersionPattern        string `` /* 130-byte string literal not displayed */
	IgnoreInvalidVersions bool   `` /* 165-byte string literal not displayed */
}

type ChannelBlock struct {
	Name    string        `hcl:"name,label" help:"Name of the channel (eg. stable, alpha, etc.)."`
	Update  time.Duration `hcl:"update" help:"Update frequency for this channel."`
	Version string        `` /* 144-byte string literal not displayed */
	Layer
}

type ChmodAction struct {
	Pos hcl.Position `hcl:"-"`

	Mode int    `hcl:"mode" help:"File mode to set."`
	File string `hcl:"file" help:"File to set mode on."`
}

type Config struct {
	// Path to environment root.
	Env string
	// State path where packages are installed.
	State string
	platform.Platform
}

type CopyAction struct {
	Pos hcl.Position `hcl:"-"`

	From string      `` /* 149-byte string literal not displayed */
	To   string      `hcl:"to" help:"The relative destination to copy to, based on the context."`
	Mode os.FileMode `hcl:"mode,optional" help:"File mode of file."`
}

type DeleteAction struct {
	Pos       hcl.Position `hcl:"-"`
	Recursive bool         `hcl:"recursive,optional" help:"Recursively delete."`
	Files     []string     `hcl:"files" help:"Files to delete."`
}

type Event string

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

type HTMLAutoVersionBlock struct {
	URL   string `hcl:"url" help:"URL to retrieve HTML from."`
	XPath string `` /* 153-byte string literal not displayed */
	CSS   string `` /* 161-byte string literal not displayed */
}

type Layer struct {
	Arch         string            `hcl:"arch,optional" help:"CPU architecture to match (amd64, 386, arm, etc.)."`
	Binaries     []string          `hcl:"binaries,optional" help:"Relative glob from $root to individual terminal binaries."`
	Apps         []string          `hcl:"apps,optional" help:"Relative paths to Mac .app packages to install."`
	Rename       map[string]string `hcl:"rename,optional" help:"Rename files after unpacking to ${root}."`
	Requires     []string          `hcl:"requires,optional" help:"Packages this one requires."`
	RuntimeDeps  []string          `` /* 128-byte string literal not displayed */
	Provides     []string          `hcl:"provides,optional" help:"This package provides the given virtual packages."`
	Dest         string            `hcl:"dest,optional" help:"Override archive extraction destination for package."`
	Files        map[string]string `hcl:"files,optional" help:"Files to load strings from to be used in the manifest."`
	Strip        int               `hcl:"strip,optional" help:"Number of path prefix elements to strip."`
	Root         string            `hcl:"root,optional" help:"Override root for package."`
	Test         *string           `hcl:"test,optional" help:"Command that will test the package is operational."`
	Env          envars.Envars     `hcl:"env,optional" help:"Environment variables to export."`
	Vars         map[string]string `hcl:"vars,optional" help:"Set local variables used during manifest evaluation."`
	Source       string            `` /* 201-byte string literal not displayed */
	DontExtract  bool              `hcl:"dont-extract,optional" help:"Don't extract the package source, just copy it into the installation directory."`
	Mirrors      []string          `hcl:"mirrors,optional" help:"Mirrors to use if the primary source is unavailable."`
	SHA256       string            `` /* 144-byte string literal not displayed */
	SHA256Source string            `hcl:"sha256-source,optional" help:"URL for SHA256 checksum file for source package."`
	Darwin       []*Layer          `hcl:"darwin,block" help:"Darwin-specific configuration."`
	Linux        []*Layer          `hcl:"linux,block" help:"Linux-specific configuration."`
	Platform     []*PlatformBlock  `` /* 134-byte string literal not displayed */
	Triggers     []*Trigger        `hcl:"on,block" help:"Triggers to run on lifecycle events."`
	Mutable      bool              `hcl:"mutable,optional" help:"Package will not be made read-only."`
}

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

type Manifest struct {
	Layer
	Default     string            `hcl:"default,optional" help:"Default version or channel if not specified."`
	Description string            `hcl:"description" help:"Human readable description of the package."`
	Homepage    string            `hcl:"homepage,optional" help:"Home page."`
	Repository  string            `hcl:"repository,optional" help:"Source Repository."`
	SHA256Sums  map[string]string `hcl:"sha256sums,optional" help:"SHA256 checksums of source packages for verification."`
	Versions    []VersionBlock    `hcl:"version,block" help:"Definition of and configuration for a specific version."`
	Channels    []ChannelBlock    `hcl:"channel,block" help:"Definition of and configuration for an auto-update channel."`
}

type ManifestErrors map[string][]error

type MessageAction struct {
	Pos hcl.Position `hcl:"-"`

	Text string `hcl:"text" help:"Message text to display to user."`
}

type MkdirAction struct {
	Pos hcl.Position `hcl:"-"`

	Dir  string      `hcl:"dir" help:"The absolute directory to create."`
	Mode os.FileMode `hcl:"mode,optional" help:"File mode of directory."`
}

type Package struct {
	Description          string
	Homepage             string
	Repository           string
	Reference            Reference
	Arch                 string
	Binaries             []string
	Apps                 []string
	Requires             []string
	RuntimeDeps          []Reference
	Provides             []string
	Env                  envars.Ops
	Source               string
	SHA256Source         string
	DontExtract          bool // Don't extract the package, just download it.
	Mirrors              []string
	Root                 string
	SHA256               string
	Mutable              bool
	Dest                 string
	Test                 string
	Strip                int
	Triggers             map[Event][]Action  `json:"-"` // Triggers keyed by event.
	UpdateInterval       time.Duration       // How often should we check for updates? 0, if never
	Files                []*ResolvedFileRef  `json:"-"`
	FS                   fs.FS               `json:"-"` // FS the Package was loaded from.
	Warnings             []string            `json:"-"`
	UnsupportedPlatforms []platform.Platform // Unsupported core platforms

	// Filled in by Env.
	Linked    bool `json:"-"` // Linked into environment.
	State     PackageState
	ETag      string
	UpdatedAt time.Time
}

type PackageState int

type Packages []*Package

type PlatformBlock struct {
	Attrs []string `hcl:"attr,label" help:"Regex to match against platform attributes <arch>, <os>, and <arch>-<os>."`
	Layer
}

type Reference struct {
	Name    string
	Version Version
	Channel string
}

type References []Reference

type RenameAction struct {
	Pos hcl.Position `hcl:"-"`

	From string `hcl:"from" help:"Source path to rename."`
	To   string `hcl:"to" help:"Destination path to rename to."`
}

type ResolvedFileRef struct {
	FS       fs.FS
	FromPath string
	ToPath   string
}

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

type RunAction struct {
	Pos hcl.Position `hcl:"-"`

	Command string   `hcl:"cmd" help:"The command to execute, split by shellquote."`
	Dir     string   `hcl:"dir,optional" help:"The directory where the command is run. Defaults to the ${root} directory."`
	Args    []string `hcl:"args,optional" help:"The arguments to the binary."`
	Env     []string `hcl:"env,optional" help:"The environment variables for the execution."`
	Stdin   string   `hcl:"stdin,optional" help:"Optional string to be used as the stdin for the command."`
}

type Selector interface {
	// Name of the package without version or channel qualifiers
	Name() string
	// String representation of this selector
	String() string
	// Matches checks if the selector matches this Reference
	Matches(ref Reference) bool
	// IsFullyQualified returns true if the selector specifies a version or a channel
	IsFullyQualified() bool
}

type SymlinkAction struct {
	Pos hcl.Position `hcl:"-"`

	From string `hcl:"from" help:"The absolute source file to symlink from."`
	To   string `hcl:"to" help:"The absolute destination to symlink to."`
}

type Trigger struct {
	Event Event `hcl:"event,label" help:"Event to Trigger (unpack, install, activate)."`

	Run     []*RunAction     `hcl:"run,block" help:"A command to run when the event is triggered."`
	Copy    []*CopyAction    `hcl:"copy,block" help:"A file to copy when the event is triggered."`
	Chmod   []*ChmodAction   `hcl:"chmod,block" help:"Change a files mode."`
	Rename  []*RenameAction  `hcl:"rename,block" help:"Rename a file."`
	Delete  []*DeleteAction  `hcl:"delete,block" help:"Delete files."`
	Message []*MessageAction `hcl:"message,block" help:"Display a message to the user."`
	Mkdir   []*MkdirAction   `hcl:"mkdir,block" help:"Create a directory and any missing parents."`
	Symlink []*SymlinkAction `hcl:"symlink,block" help:"Create a symbolic link."`
}

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

type VersionBlock struct {
	Version     []string          `hcl:"version,label" help:"Version(s) of package."`
	AutoVersion *AutoVersionBlock `hcl:"auto-version,block" help:"Automatically update versions."`
	Layer
}

type Versions []Version