bonito

type ChannelInput struct {
	// URL is the source URL of the channel.
	URL ChannelURL
	// Version is the respective version string corresponding to the VCS defined
	// in the channel URL. For example, if the VCS is Git, then the URL's scheme
	// might be git+https, and the version string would imply a branch name,
	// tag, or commit hash.
	//
	// If the Version string is empty, then it is not included in the marshaled
	// text at all.
	Version string
}

type ChannelLock struct {
	// URL is the resolved channel URL that's used for Nix. This URL must always
	// point to the same file, and the store hash guarantees that.
	URL string `json:"url"`
	// StoreHash is the hash part of the /nix/store output path of the channel.
	StoreHash nixutil.StoreHash `json:"store_hash"`
}

type ChannelRegistry struct {
	// Channels maps the channel names to its respective input strings.
	Channels map[string]ChannelInput `toml:"channels"`
	// Aliases maps a channel name to another channel name as aliases. The
	// aliasing channel will have the same channel input as the aliased.
	Aliases map[string]string `toml:"aliases"`
}

type ChannelResolver func(context.Context, ChannelInput) (string, error)

type ChannelURL string

type Config struct {
	// Global is the global channels.
	Global struct {
		// PreferredUser is the preferred user to use for nix-channel invocations.
		// If this is empty, then it will be picked automatically.
		PreferredUser string `toml:"preferred_user,omitempty"`
		ChannelRegistry
	} `toml:"global"`

	// Flakes is the flakes channels.
	Flakes struct {
		Enable bool   `toml:"enable"`
		Output string `toml:"output"` // ("nix") or "flakes"
		ChannelRegistry
	} `toml:"flakes"`

	// Users maps the usernames to their respective UserConfig.
	Users map[Username]UserConfig `toml:"users"`
}

type LockFile struct {
	// Channels maps channel URLs to its lock.
	Channels map[ChannelInput]ChannelLock `json:"channels"`
}

type State struct {
	Config Config
	Lock   LockFile
}

type UserConfig struct {
	// UseSudo, if true, will use sudo if the current user is not the user that
	// this config belongs to. If it's false and the current user is not this
	// user, then an error will be thrown.
	UseSudo bool `toml:"use-sudo"`
	// OverrideChannels, if true, will cause all channels not defined in the
	// configuration file to be deleted.
	OverrideChannels bool `toml:"override-channels"`
	ChannelRegistry
}

type Username = string