config

Documentation

Index

• type GitOptions
• type Options
  • func DefaultOptions() Options
  • func Load(logger *slog.Logger, path string) (Options, error)

Types

type GitOptions

type GitOptions struct {
	// Bare is equivalent to `--bare` from git with additional
	// quality-of-life improvements.
	Bare bool `toml:"bare"`
}

type Options

type Options struct {
	// GiorPath is the root path where all repositories are cloned
	// to. For example, the repo example.com/foobar would cloned to the
	// path <GiorPath>/example.com/foobar.
	GiorPath string     `toml:"gior-path"`
	Git      GitOptions `toml:"git"`
}

Options is the top-level struct that holds all configuration that will be parsed from the configuration file.

func DefaultOptions

func DefaultOptions() Options

func Load

func Load(logger *slog.Logger, path string) (Options, error)

Load returns config Options for the configuration file at the provided path. If the configuration file does not exist, default Options are returned without erroring.