README
¶
go-gitconfig
go-gitconfig is a pacakge to use gitconfig values in Golang.
Sometimes you want to extract username or its email address implicitly in your tool.
Now most of developer use git, so we can use its configuration variables. go-gitconfig is for that.
go-gitconfig is very small, so it may not be included what you want to use.
If you want to use more git specific variable, check Other.
Usage
If you want to use git user name defined in ~/.gitconfig:
username, err := gitconfig.Username()
Or git user email defined in ~/.gitconfig:
email, err := gitconfig.Email()
Or, if you want to extract origin url of current project (from .git/config):
url, err := gitconfig.OriginURL()
You can also extract value by key:
editor, err := gitconfig.Global("core.editor")
remote, err := gitconfig.Local("branch.master.remote")
See more details in document at https://godoc.org/github.com/tcnksm/go-gitconfig.
Install
To install, use go get:
$ go get -d github.com/tcnksm/go-gitconfig
VS.
These packages have many features to use git from golang. go-gitconfig is very simple alternative and focus to extract information from gitconfig. go-gitconfig is used in tcnksm/ghr.
Contribution
- Fork (https://github.com/tcnksm/go-gitconfig/fork)
- Create a feature branch
- Commit your changes
- Rebase your local changes against the master branch
- Run test suite with the
go test ./...command and confirm that it passes - Run
gofmt -s - Create new Pull Request
Author
Documentation
¶
Overview ¶
Package gitconfig enables you to use `~/.gitconfig` values in Golang.
For a full guide visit http://github.com/tcnksm/go-gitconfig
package main
import (
"github.com/tcnksm/go-gitconfig"
"fmt"
)
func main() {
user, err := gitconfig.Global("user.name")
if err == nil {
fmt.Println(user)
}
}
Index ¶
- Variables
- func Email() (string, error)
- func Entire(key string) (string, error)
- func GithubToken() (string, error)
- func GithubUser() (string, error)
- func Global(key string) (string, error)
- func Local(key string) (string, error)
- func OriginURL() (string, error)
- func Repository() (string, error)
- func Username() (string, error)
Constants ¶
This section is empty.
Variables ¶
var RepoNameRegexp = regexp.MustCompile(`.+/([^/]+)(\.git)?$`)
Functions ¶
func Email ¶
Email extracts git user email from `$HOME/.gitconfig` file or `$GIT_CONFIG`. This is same as Global("user.email")
func Entire ¶
Entire extracts configuration value from `$HOME/.gitconfig` file , `$GIT_CONFIG`, /etc/gitconfig or include.path files.
func GithubToken ¶
Github extracts github token from `Entire gitconfig`. This is same as Entire("github.token")
func GithubUser ¶
GithubUser extracts github.user name from `Entire gitconfig` This is same as Entire("github.user")
func OriginURL ¶
OriginURL extract remote origin url from current project repository. This is same as Local("remote.origin.url")
func Repository ¶
Repository extract repository name of current project repository.
Types ¶
This section is empty.
Source Files