gitconfig

package module

v0.2.0 Latest Latest Go to latest Published: Sep 3, 2022 License: MIT Imports: 14 Imported by: 10

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/Songmu/gitconfig

Links

Open Source Insights

README ¶

gitconfig

gitconfig is a package to get configuration values from gitconfig.

Synopsis

val, err := gitconfig.Get("section.value")
if err != nil && !gitconfig.IsNotFound(err) {
    return err
}

// detect GitHub username from various informations
u, err := gitconfig.GitHubUser("")

Description

Installation

% go get github.com/Songmu/gitconfig

Author

Songmu

Documentation ¶

Index ¶

func Bool(key string) (bool, error)
func Do(args ...string) (string, error)
func Email() (string, error)
func Get(args ...string) (string, error)
func GetAll(args ...string) ([]string, error)
func GitHubToken(host string) (string, error)
func GitHubUser(host string) (string, error)
func Int(key string) (int, error)
func IsNotFound(err error) bool
func Path(key string) (string, error)
func PathAll(key string) ([]string, error)
func User() (string, error)
func WithConfig(tb testing.TB, configContent string) func()
type Config

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Bool ¶

func Bool(key string) (bool, error)

Bool gets a value as bool

func Do ¶

func Do(args ...string) (string, error)

Do the git config

func Email ¶

func Email() (string, error)

Email takes git email

func Get ¶

func Get(args ...string) (string, error)

Get a value

func GetAll ¶

func GetAll(args ...string) ([]string, error)

GetAll values

func GitHubToken ¶

func GitHubToken(host string) (string, error)

GitHubToken takes API token for GitHub

func GitHubUser ¶

func GitHubUser(host string) (string, error)

GitHubUser detects user name of GitHub from various informations

func Int ¶

func Int(key string) (int, error)

Int get a value as int

func IsNotFound ¶

func IsNotFound(err error) bool

IsNotFound returns a boolean indicating whether the error is known to report that a value does not found.

func Path ¶

func Path(key string) (string, error)

Path gets a value as path

func PathAll ¶

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

PathAll get all values as paths

func User ¶

func User() (string, error)

User takes git user name

func WithConfig ¶

func WithConfig(tb testing.TB, configContent string) func()

WithConfig is test helper to replace gitconfig temporarily

Types ¶

type Config ¶

type Config struct {
	System, Global, Local bool
	File                  string
	Cd                    string
	GitPath               string
}

Config is for base setting for git config

func (*Config) Bool ¶

func (c *Config) Bool(key string) (bool, error)

Bool gets a value as bool

func (*Config) Do ¶

func (c *Config) Do(args ...string) (string, error)

Do the git config

func (*Config) Email ¶

func (c *Config) Email() (string, error)

Email takes git email

func (*Config) Get ¶

func (c *Config) Get(args ...string) (string, error)

Get a value

func (*Config) GetAll ¶

func (c *Config) GetAll(args ...string) ([]string, error)

GetAll values

func (*Config) GitHubToken ¶

func (c *Config) GitHubToken(host string) (string, error)

GitHubToken takes API token for GitHub

func (*Config) GitHubUser ¶

func (c *Config) GitHubUser(host string) (string, error)

GitHubUser detects user name of GitHub from various informations

func (*Config) Int ¶

func (c *Config) Int(key string) (int, error)

Int get a value as int

func (*Config) Path ¶

func (c *Config) Path(key string) (string, error)

Path gets a value as path

func (*Config) PathAll ¶

func (c *Config) PathAll(key string) ([]string, error)

PathAll get all values as paths

func (*Config) User ¶

func (c *Config) User() (string, error)

User takes git user name

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL