mirror of
https://github.com/gopasspw/gopass.git
synced 2025-12-08 19:24:54 +00:00
This change adds GoDoc comments to many of the public symbols in the `pkg/` directory. It also includes various improvements to the documentation in `README.md` and other markdown files in the `docs/` directory. This is a partial documentation effort, as requested by the user, to get a pull request submitted quickly. Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>
80 lines
1.6 KiB
Go
80 lines
1.6 KiB
Go
package termio
|
|
|
|
import (
|
|
"context"
|
|
"os"
|
|
|
|
"github.com/gopasspw/gitconfig"
|
|
"github.com/gopasspw/gopass/pkg/ctxutil"
|
|
"github.com/urfave/cli/v2"
|
|
)
|
|
|
|
var (
|
|
// NameVars are the env vars checked for a valid name.
|
|
NameVars = []string{
|
|
"GIT_AUTHOR_NAME",
|
|
"DEBFULLNAME",
|
|
"USER",
|
|
}
|
|
// EmailVars are the env vars checked for a valid email.
|
|
EmailVars = []string{
|
|
"GIT_AUTHOR_EMAIL",
|
|
"DEBEMAIL",
|
|
"EMAIL",
|
|
}
|
|
)
|
|
|
|
// DetectName tries to guess the name of the logged in user.
|
|
// It checks the context, the command line flags, environment variables,
|
|
// and the git config.
|
|
func DetectName(ctx context.Context, c *cli.Context) string {
|
|
cand := make([]string, 0, 10)
|
|
cand = append(cand, ctxutil.GetUsername(ctx))
|
|
|
|
if c != nil {
|
|
cand = append(cand, c.String("name"))
|
|
}
|
|
|
|
for _, k := range NameVars {
|
|
cand = append(cand, os.Getenv(k))
|
|
}
|
|
|
|
cfg := gitconfig.New().LoadAll(GetWorkdir(ctx))
|
|
cand = append(cand, cfg.Get("user.name"))
|
|
|
|
for _, e := range cand {
|
|
if e != "" {
|
|
return e
|
|
}
|
|
}
|
|
|
|
return ""
|
|
}
|
|
|
|
// DetectEmail tries to guess the email of the logged in user.
|
|
// It checks the context, the command line flags, environment variables,
|
|
// and the git config.
|
|
func DetectEmail(ctx context.Context, c *cli.Context) string {
|
|
cand := make([]string, 0, 10)
|
|
cand = append(cand, ctxutil.GetEmail(ctx))
|
|
|
|
if c != nil {
|
|
cand = append(cand, c.String("email"))
|
|
}
|
|
|
|
for _, k := range EmailVars {
|
|
cand = append(cand, os.Getenv(k))
|
|
}
|
|
|
|
cfg := gitconfig.New().LoadAll(GetWorkdir(ctx))
|
|
cand = append(cand, cfg.Get("user.email"))
|
|
|
|
for _, e := range cand {
|
|
if e != "" {
|
|
return e
|
|
}
|
|
}
|
|
|
|
return ""
|
|
}
|