Documentation
¶
Overview ¶
Package config is a helper package to facilitate getting and setting config values using Viper.
This package provides functions to read and write configuration settings for the eng CLI tool. It supports various configuration file formats and allows for easy management of local configuration settings.
Key features: - Load configuration from JSON, YAML, TOML, and other formats. - Set and get configuration values programmatically. - Support for environment variable overrides. - Easy integration with the Viper library.
These are local configs related to the eng CLI, not deployment configs.
Index ¶
- Variables
- func BareRepoPath() string
- func Branch() string
- func DisableAllProxies() error
- func DotfilesRepo() string
- func Email() string
- func FindProxyIndexByTitle(proxies []ProxyConfig, title string) int
- func FormatProxyOption(proxy ProxyConfig) string
- func GetActiveProxy() (string, bool)
- func GetDotfilesRepo()
- func GetEmail()
- func GetVerbose()
- func GitDevPath() string
- func MigrateConfig()
- func NormalizeProxyURLString(value string) string
- func RepoURL() string
- func SaveProxyConfigsImpl(proxies []ProxyConfig) error
- func SelectProxy(proxies []ProxyConfig) (int, error)
- func SetProxyEnvVars(proxyValue string)
- func UnsetProxyEnvVars()
- func UpdateBareRepoPath()
- func UpdateBranch()
- func UpdateDotfilesRepo()
- func UpdateRepoURL()
- func UpdateWorktreePath()
- func ValidateProxyURLString(value string) error
- func Verbose() bool
- func VerifyDotfilesConfig() (string, string, string, string)
- func WorktreePath() string
- type ProxyConfig
- type SaveProxyConfigsFunc
Constants ¶
This section is empty.
Variables ¶
var SaveProxyConfigs = SaveProxyConfigsImpl
SaveProxyConfigs is a variable that holds the function to save proxy configurations This can be overridden in tests.
Functions ¶
func BareRepoPath ¶
func BareRepoPath() string
BareRepoPath checks for the bare repository path in the configuration and returns it.
func Branch ¶
func Branch() string
Branch checks for the dotfiles branch in the configuration and returns it.
func DisableAllProxies ¶
func DisableAllProxies() error
DisableAllProxies disables all proxy configurations and unsets environment variables.
func DotfilesRepo ¶
func DotfilesRepo() string
DotfilesRepo is an alias for BareRepoPath for backward compatibility with external callers.
func Email ¶
func Email() string
Email checks for the user's email in the configuration and prompts the user to confirm it. If the email is not found or the user does not confirm it, the function will call updateEmail() to update the email. It logs the start and success of the email checking process and returns the confirmed email as a string.
func FindProxyIndexByTitle ¶
func FindProxyIndexByTitle(proxies []ProxyConfig, title string) int
FindProxyIndexByTitle returns the index of the proxy matching the title (case-insensitive), or -1.
func FormatProxyOption ¶
func FormatProxyOption(proxy ProxyConfig) string
FormatProxyOption renders a single proxy as a stylized radio option string. Example: "● Corp Proxy (http://proxy:8080)" with colored markers and dimmed value.
func GetActiveProxy ¶
GetActiveProxy returns the currently active proxy value and true if any proxy is enabled If no proxy is enabled, returns the first proxy value and false If no proxies exist, returns an empty string and false.
func GetDotfilesRepo ¶
func GetDotfilesRepo()
GetDotfilesRepo logs the current dotfiles repository path.
func GetEmail ¶
func GetEmail()
GetEmail retrieves the user's email from the configuration. If the email is not found in the configuration, it prompts the user to update it. Logs the process of checking and finding the email.
func GetVerbose ¶
func GetVerbose()
GetVerbose retrieves the verbose setting from the configuration. If the verbose setting is not found in the configuration, it prompts the user to update it. Logs the process of checking and finding the verbose setting.
func GitDevPath ¶
func GitDevPath() string
GitDevPath checks for the development folder path in the configuration and prompts the user to confirm it. If the path is not found or the user does not confirm it, the function will call updateGitDevPath() to update the path. It logs the start and success of the path checking process and returns the confirmed path as a string.
func MigrateConfig ¶
func MigrateConfig()
MigrateConfig handles the migration of old configuration keys to new standardized ones. It checks for old keys, moves their values to new keys if the new ones are empty, and saves the configuration if any changes were made.
func NormalizeProxyURLString ¶
NormalizeProxyURLString adds a default http scheme when missing.
func RepoURL ¶
func RepoURL() string
RepoURL checks for the dotfiles repository URL in the configuration and returns it.
func SaveProxyConfigsImpl ¶
func SaveProxyConfigsImpl(proxies []ProxyConfig) error
SaveProxyConfigsImpl is the actual implementation of saving proxy configurations to viper config.
func SelectProxy ¶
func SelectProxy(proxies []ProxyConfig) (int, error)
SelectProxy prompts the user to select a proxy from the list and returns the index.
func SetProxyEnvVars ¶
func SetProxyEnvVars(proxyValue string)
SetProxyEnvVars sets all proxy-related environment variables to the provided value and handles custom no_proxy settings.
func UnsetProxyEnvVars ¶
func UnsetProxyEnvVars()
UnsetProxyEnvVars unsets all proxy-related environment variables.
func UpdateBareRepoPath ¶
func UpdateBareRepoPath()
UpdateBareRepoPath prompts the user to input their bare repository path.
func UpdateBranch ¶
func UpdateBranch()
UpdateBranch prompts the user to select their dotfiles branch.
func UpdateDotfilesRepo ¶
func UpdateDotfilesRepo()
UpdateDotfilesRepo is an alias for UpdateBareRepoPath.
func UpdateRepoURL ¶
func UpdateRepoURL()
UpdateRepoURL prompts the user to input their dotfiles repository URL.
func UpdateWorktreePath ¶
func UpdateWorktreePath()
UpdateWorktreePath prompts the user to input their worktree path.
func ValidateProxyURLString ¶
ValidateProxyURLString validates the proxy URL string for scheme and host:port.
func Verbose ¶
func Verbose() bool
Verbose checks for the verbose setting in the configuration and prompts the user to confirm it. If the verbose setting is not found or the user does not confirm it, the function will call updateVerbose() to update the setting. It logs the start and success of the verbose checking process and returns the confirmed verbose setting as a bool.
func VerifyDotfilesConfig ¶
VerifyDotfilesConfig checks for Repo URL, Branch, and Bare Repo Path. If all are present, it offers a single multi-select to update them. If any are missing, it falls back to sequential mandatory prompts.
func WorktreePath ¶
func WorktreePath() string
WorktreePath checks for the worktree path in the configuration and returns it.
Types ¶
type ProxyConfig ¶
ProxyConfig represents a single proxy configuration.
func AddOrUpdateProxy ¶
func AddOrUpdateProxy() ([]ProxyConfig, int)
AddOrUpdateProxy adds a new proxy or updates an existing one.
func AddOrUpdateProxyWithValues ¶
func AddOrUpdateProxyWithValues(title, value, noProxy string) ([]ProxyConfig, int, error)
AddOrUpdateProxyWithValues adds or updates a proxy using provided values (non-interactive). Returns updated proxies, the affected index, or an error.
func EnableProxy ¶
func EnableProxy(index int, proxies []ProxyConfig) ([]ProxyConfig, error)
EnableProxy enables the proxy at the given index and disables all others.
func GetProxyConfigs ¶
func GetProxyConfigs() ([]ProxyConfig, int)
GetProxyConfigs checks for proxy settings in the configuration and returns the current proxies and the index of the active proxy (-1 if none are active).
type SaveProxyConfigsFunc ¶
type SaveProxyConfigsFunc func(proxies []ProxyConfig) error
SaveProxyConfigsFunc defines the function type for saving proxy configs.
Source Files
Directories