config

Documentation

Index

• func Dir() (string, error)
• func FilePath(override string) (string, error)
• func Save(cfg Config) error
• type AutocorrectConfig
• type Config
  • func DefaultConfig() Config
  • func Load(override string) (Config, error)
  • func (c Config) ProviderCfg(name string) ProviderConfig
• type ProviderConfig

Functions

func Dir

func Dir() (string, error)

Dir returns the platform-appropriate config directory for bashcorrect.

func FilePath

func FilePath(override string) (string, error)

FilePath returns the full path to the config file, using override if non-empty.

func Save

func Save(cfg Config) error

Save writes cfg to cfg.Path, creating parent directories as needed.

Types

type AutocorrectConfig

type AutocorrectConfig struct {
	AutoRun  bool `toml:"auto_run"`
	ShowDiff bool `toml:"show_diff"`
}

AutocorrectConfig controls autocorrect behaviour.

type Config

type Config struct {
	ActiveProvider string                    `toml:"active_provider"`
	TriggerPrefix  string                    `toml:"trigger_prefix"`
	Providers      map[string]ProviderConfig `toml:"providers"`
	Autocorrect    AutocorrectConfig         `toml:"autocorrect"`

	// Path is the file this config was loaded from (not persisted).
	Path string `toml:"-"`
}

Config is the top-level config struct.

func DefaultConfig

func DefaultConfig() Config

DefaultConfig returns a Config pre-populated with sensible defaults.

func Load

func Load(override string) (Config, error)

Load reads the config file at the given path (or the default location). If the file does not exist, it returns the default config.

func (Config) ProviderCfg

func (c Config) ProviderCfg(name string) ProviderConfig

ProviderCfg returns the ProviderConfig for the named provider, or an empty one if not set.

type ProviderConfig

type ProviderConfig struct {
	APIKey string `toml:"api_key"`
	Model  string `toml:"model"`
}

ProviderConfig holds per-provider credentials and model selection.