Documentation
¶
Overview ¶
Package onboard materializes live paths into a module.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Options ¶
type Options struct {
// Ctx carries cancellation to mise subprocesses; nil means Background.
Ctx context.Context
ProfileRoot string
Paths []string
App string
Mode string
Packages []PackageEntry
Tools []string
Host bool
DryRun bool
Yes bool
Home string
Hostname string
}
Options configures the onboard operation.
type PackageEntry ¶ added in v0.11.0
PackageEntry is one declared distro package. Description, when set, is rendered as a trailing "# <desc>" comment next to the package in module.toml — it is cosmetic only; resolve reads back just the bare names (the TOML parser ignores comments), so descriptions do not enter the data model.
func ParsePackages ¶ added in v0.11.0
func ParsePackages(values []string) ([]PackageEntry, error)
ParsePackages parses --packages values into entries. kong splits the flag value on commas (its default), so each element is already one entry by the time it reaches here; an entry is either a bare package name ("ripgrep", "aur/foo") or name="description". Because kong splits on commas unconditionally, a description must not itself contain a comma — use a comma-free wording. (Hand-authored module.toml files are not so constrained, since their descriptions sit inside the quoted array entry.)
Source Files