cfg

Documentation

Index

• Constants
• Variables
• func Add(key string, value string) error
• func AddCoAuthors(aa ...authors.Author) error
• func AddGlobal(key string, value string) error
• func Get(key string) string
• func GetAll(key string) ([]string, error)
• func GetCoAuthors() ([]authors.Author, error)
• func GetUser() (*authors.Author, error)
• func Has(key string) bool
• func HasGlobal(key string) bool
• func ReadAllCoAuthorsFromFile() (map[string]authors.Author, error)
• func Remove(key string) error
• func RemoveAll(key string) error
• func RemoveAllGlobal(key string) error
• func RemoveGlobal(key string) error
• func RemoveSection(key string) error
• func RemoveSectionGlobal(key string) error
• func Set(key string, value string) error
• func SetCoAuthors() error
• func SetGlobal(key string, value string) error
• func ShortLogAuthorSummary() (map[string]authors.Author, error)

Constants

const (
	EnvKeyCoauthorsPath = "GITMOB_COAUTHORS_PATH"
)

Variables

var (
	GlobalConfigFilePath string
)

Functions

func Add

func Add(key string, value string) error

Add adds a new line to the option without altering any existing values.

func AddCoAuthors

func AddCoAuthors(aa ...authors.Author) error

func AddGlobal

func AddGlobal(key string, value string) error

AddGlobal adds a new line to the global option without altering any existing values.

func Get

func Get(key string) string

Get gets the (last) value for the given option key.

func GetAll

func GetAll(key string) ([]string, error)

GetAll gets all values for a multi-valued option key.

func GetCoAuthors

func GetCoAuthors() ([]authors.Author, error)

GetCoAuthors gets the current list of co-authors from git config

func GetUser

func GetUser() (*authors.Author, error)

GetUser builds an authors.Author from the current configured user

func Has

func Has(key string) bool

Has checks if the given option exists in the configuration.

func HasGlobal

func HasGlobal(key string) bool

HasGlobal checks if the given option exists in the global configuration.

func ReadAllCoAuthorsFromFile

func ReadAllCoAuthorsFromFile() (map[string]authors.Author, error)

func Remove

func Remove(key string) error

Remove removes the given key from the configuration.

func RemoveAll

func RemoveAll(key string) error

RemoveAll removes all the given keys from the configuration.

func RemoveAllGlobal

func RemoveAllGlobal(key string) error

RemoveAllGlobal removes all the given keys from the configuration.

func RemoveGlobal

func RemoveGlobal(key string) error

RemoveGlobal removes the given key from the configuration.

func RemoveSection

func RemoveSection(key string) error

RemoveSection removes the given section from the configuration.

func RemoveSectionGlobal

func RemoveSectionGlobal(key string) error

RemoveSectionGlobal removes the given section from the global configuration.

func Set

func Set(key string, value string) error

Set sets the option, overwriting the existing value if one exists.

func SetCoAuthors

func SetCoAuthors() error

func SetGlobal

func SetGlobal(key string, value string) error

SetGlobal sets the global option, overwriting the existing value if one exists.

func ShortLogAuthorSummary

func ShortLogAuthorSummary() (map[string]authors.Author, error)