config

Documentation

Index

• func AddRepoConfigFlags(flags *pflag.FlagSet)
• func AddUserConfigFlags(flags *pflag.FlagSet)
• func DefaultUserConfigPath() titanpath.AbsoluteSystemPath
• func GetRepoConfigPath(repoRoot titanpath.AbsoluteSystemPath) titanpath.AbsoluteSystemPath
• type RepoConfig
  • func ReadRepoConfigFile(path titanpath.AbsoluteSystemPath, flags *pflag.FlagSet) (*RepoConfig, error)
  • func (rc *RepoConfig) Delete() error
  • func (rc *RepoConfig) GetRemoteConfig(token string) client.RemoteConfig
  • func (rc *RepoConfig) LoginURL() string
  • func (rc *RepoConfig) SetTeamID(teamID string) error
• type UserConfig
  • func ReadUserConfigFile(path titanpath.AbsoluteSystemPath, flags *pflag.FlagSet) (*UserConfig, error)
  • func (uc *UserConfig) Delete() error
  • func (uc *UserConfig) SetToken(token string) error
  • func (uc *UserConfig) Token() string

Functions

func AddRepoConfigFlags

func AddRepoConfigFlags(flags *pflag.FlagSet)

AddRepoConfigFlags adds per-repository configuration items to the given flagset

func AddUserConfigFlags

func AddUserConfigFlags(flags *pflag.FlagSet)

AddUserConfigFlags adds per-user configuration item flags to the given flagset

func DefaultUserConfigPath

func DefaultUserConfigPath() titanpath.AbsoluteSystemPath

DefaultUserConfigPath returns the default platform-dependent place that we store the user-specific configuration.

func GetRepoConfigPath

func GetRepoConfigPath(repoRoot titanpath.AbsoluteSystemPath) titanpath.AbsoluteSystemPath

GetRepoConfigPath reads the user-specific configuration values

Types

type RepoConfig

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

RepoConfig is a configuration object for the logged-in titanrepo.com user

func ReadRepoConfigFile

func ReadRepoConfigFile(path titanpath.AbsoluteSystemPath, flags *pflag.FlagSet) (*RepoConfig, error)

ReadRepoConfigFile creates a RepoConfig using the specified path as the repo config file. Note that the path or its parents do not need to exist. On a write to this configuration, they will be created.

func (*RepoConfig) Delete

func (rc *RepoConfig) Delete() error

Delete deletes the config file. This repo config shouldn't be used afterwards, it needs to be re-initialized

func (*RepoConfig) GetRemoteConfig

func (rc *RepoConfig) GetRemoteConfig(token string) client.RemoteConfig

GetRemoteConfig produces the necessary values for an API client configuration

func (*RepoConfig) LoginURL

func (rc *RepoConfig) LoginURL() string

LoginURL returns the configured URL for authenticating the user

func (*RepoConfig) SetTeamID

func (rc *RepoConfig) SetTeamID(teamID string) error

SetTeamID sets the teamID and clears the slug, since it may have been from an old team

type UserConfig

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

UserConfig is a wrapper around the user-specific configuration values for Titanrepo.

func ReadUserConfigFile

func ReadUserConfigFile(path titanpath.AbsoluteSystemPath, flags *pflag.FlagSet) (*UserConfig, error)

ReadUserConfigFile creates a UserConfig using the specified path as the user config file. Note that the path or its parents do not need to exist. On a write to this configuration, they will be created.

func (*UserConfig) Delete

func (uc *UserConfig) Delete() error

Delete deletes the config file. This user config shouldn't be used afterwards, it needs to be re-initialized

func (*UserConfig) SetToken

func (uc *UserConfig) SetToken(token string) error

SetToken saves a Bearer token for this user, writing it to the user config file, creating it if necessary

func (*UserConfig) Token

func (uc *UserConfig) Token() string

Token returns the Bearer token for this user if it exists