config

Documentation

Overview

Package config provides layered configuration loading.

Index

• func ApplyOverrides(cfg *Config, o FlagOverrides)
• func GlobalConfigDir() string
• func LoadFromEnv(cfg *Config)
• func NormalizeBaseURL(url string) string
• func RepoConfigPath() string
• func ShellQuote(s string) string
• type Config
  • func Default() *Config
  • func Load(overrides FlagOverrides) (*Config, error)
  • func (cfg *Config) ApplyProfile(name string) error
• type FlagOverrides
• type ProfileConfig
• type Source
• type TrustEntry
• type TrustStore
  • func LoadTrustStore(configDir string) *TrustStore
  • func NewTrustStore(configDir string) *TrustStore
  • func (ts *TrustStore) IsTrusted(path string) bool
  • func (ts *TrustStore) List() []TrustEntry
  • func (ts *TrustStore) Trust(path string) error
  • func (ts *TrustStore) Untrust(path string) (bool, error)

Functions

func ApplyOverrides

func ApplyOverrides(cfg *Config, o FlagOverrides)

ApplyOverrides applies non-empty flag overrides to cfg. Exported so root.go can re-apply after profile overlay.

func GlobalConfigDir

func GlobalConfigDir() string

GlobalConfigDir returns the global config directory path.

func LoadFromEnv

func LoadFromEnv(cfg *Config)

LoadFromEnv loads configuration from environment variables. Exported so root.go can re-apply after profile overlay.

func NormalizeBaseURL

func NormalizeBaseURL(url string) string

NormalizeBaseURL ensures consistent URL format (no trailing slash).

func RepoConfigPath

func RepoConfigPath() string

RepoConfigPath walks up from CWD to find .basecamp/config.json at the git repo root. Returns empty string if not found or outside $HOME.

func ShellQuote

func ShellQuote(s string) string

ShellQuote returns a POSIX single-quoted string safe for copy-paste into a shell. Single quotes inside the value are escaped as '\” (end quote, escaped literal quote, resume quote).

Types

type Config

type Config struct {
	// API settings
	BaseURL    string `json:"base_url"`
	AccountID  string `json:"account_id"`
	ProjectID  string `json:"project_id"`
	TodolistID string `json:"todolist_id"`

	// Profile settings (named identity+environment bundles)
	Profiles       map[string]*ProfileConfig `json:"profiles,omitempty"`
	DefaultProfile string                    `json:"default_profile,omitempty"`
	ActiveProfile  string                    `json:"-"` // Set at runtime, not persisted

	// Auth settings
	Scope string `json:"scope"`

	// Cache settings
	CacheDir     string `json:"cache_dir"`
	CacheEnabled bool   `json:"cache_enabled"`

	// Output settings
	Format string `json:"format"`

	// Behavior preferences (persisted via config set, overridable by flags)
	Hints   *bool `json:"hints,omitempty"`
	Stats   *bool `json:"stats,omitempty"`
	Verbose *int  `json:"verbose,omitempty"`

	// Sources tracks where each value came from (for debugging).
	Sources map[string]string `json:"-"`
}

Config holds the resolved configuration.

func Default

func Default() *Config

Default returns the default configuration.

func Load

func Load(overrides FlagOverrides) (*Config, error)

Load loads configuration from all sources with proper precedence. Precedence: flags > env > local > repo > global > system > defaults

func (*Config) ApplyProfile

func (cfg *Config) ApplyProfile(name string) error

ApplyProfile overlays profile values onto the config.

This is the first pass of a two-pass precedence system:

Pass 1 (this method): Profile values unconditionally overwrite config fields.
Pass 2 (caller):      LoadFromEnv + ApplyOverrides re-apply env vars and CLI
                       flags, which take final precedence over profile values.

The caller in root.go MUST call LoadFromEnv and ApplyOverrides after this method to maintain the precedence chain: flags > env > profile > file > defaults.

type FlagOverrides

type FlagOverrides struct {
	Account  string
	Project  string
	Todolist string
	Profile  string
	CacheDir string
	Format   string
}

FlagOverrides holds command-line flag values.

type ProfileConfig

type ProfileConfig struct {
	BaseURL    string `json:"base_url"`
	AccountID  string `json:"account_id,omitempty"`
	ProjectID  string `json:"project_id,omitempty"`
	TodolistID string `json:"todolist_id,omitempty"`
	Scope      string `json:"scope,omitempty"`
	ClientID   string `json:"client_id,omitempty"`
}

ProfileConfig holds configuration for a named profile.

type Source

type Source string

Source indicates where a config value came from.

const (
	SourceDefault Source = "default"
	SourceSystem  Source = "system"
	SourceGlobal  Source = "global"
	SourceRepo    Source = "repo"
	SourceLocal   Source = "local"
	SourceEnv     Source = "env"
	SourceFlag    Source = "flag"
	SourcePrompt  Source = "prompt"
)

type TrustEntry

type TrustEntry struct {
	Path      string `json:"path"`
	TrustedAt string `json:"trusted_at"`
}

TrustEntry records a single trusted config path and when it was trusted.

type TrustStore

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

TrustStore manages the set of trusted local/repo config file paths. Trusted configs are allowed to set authority keys (base_url, profiles, default_profile) that are normally rejected from local/repo sources.

func LoadTrustStore

func LoadTrustStore(configDir string) *TrustStore

LoadTrustStore is a convenience that creates a TrustStore and verifies the backing directory exists. A missing file is fine (empty store); a missing directory is a no-op (returns nil store, no error).

func NewTrustStore

func NewTrustStore(configDir string) *TrustStore

NewTrustStore returns a TrustStore backed by trusted-configs.json in configDir.

func (*TrustStore) IsTrusted

func (ts *TrustStore) IsTrusted(path string) bool

IsTrusted reports whether path (after canonicalization) is in the trust store.

func (*TrustStore) List

func (ts *TrustStore) List() []TrustEntry

List returns all trusted entries.

func (*TrustStore) Trust

func (ts *TrustStore) Trust(path string) error

Trust adds path to the trust store (idempotent — re-trusting updates the timestamp).

func (*TrustStore) Untrust

func (ts *TrustStore) Untrust(path string) (bool, error)

Untrust removes path from the trust store. Returns true if it was present.