git-bug/commands/root.go

98 lines
2.4 KiB
Go
Raw Normal View History

2018-09-16 14:50:53 +03:00
// Package commands contains the CLI commands
package commands
import (
"fmt"
2018-08-13 19:32:11 +03:00
"os"
"github.com/MichaelMure/git-bug/bug"
2019-02-23 15:01:46 +03:00
"github.com/MichaelMure/git-bug/identity"
"github.com/MichaelMure/git-bug/repository"
"github.com/spf13/cobra"
)
2018-07-20 16:46:14 +03:00
const rootCommandName = "git-bug"
// package scoped var to hold the repo after the PreRun execution
var repo repository.ClockedRepo
2018-07-20 16:46:14 +03:00
// RootCmd represents the base command when called without any subcommands
var RootCmd = &cobra.Command{
Use: rootCommandName,
Short: "A bug tracker embedded in Git.",
2018-09-21 14:37:22 +03:00
Long: `git-bug is a bug tracker embedded in git.
git-bug use git objects to store the bug tracking separated from the files
history. As bugs are regular git objects, they can be pushed and pulled from/to
the same git remote your are already using to collaborate with other peoples.
`,
2018-09-11 20:28:32 +03:00
// For the root command, force the execution of the PreRun
// even if we just display the help. This is to make sure that we check
// the repository and give the user early feedback.
Run: func(cmd *cobra.Command, args []string) {
2018-09-13 13:43:47 +03:00
if err := cmd.Help(); err != nil {
os.Exit(1)
}
},
DisableAutoGenTag: true,
2018-09-11 20:28:32 +03:00
// Custom bash code to connect the git completion for "git bug" to the
// git-bug completion for "git-bug"
BashCompletionFunction: `
_git_bug() {
__start_git-bug "$@"
}
`,
}
func Execute() {
2018-07-20 16:46:14 +03:00
if err := RootCmd.Execute(); err != nil {
os.Exit(1)
}
}
2019-02-23 15:01:46 +03:00
// loadRepo is a pre-run function that load the repository for use in a command
func loadRepo(cmd *cobra.Command, args []string) error {
cwd, err := os.Getwd()
if err != nil {
return fmt.Errorf("Unable to get the current working directory: %q\n", err)
}
repo, err = repository.NewGitRepo(cwd, bug.Witnesser)
if err == repository.ErrNotARepo {
return fmt.Errorf("%s must be run from within a git repo.\n", rootCommandName)
}
if err != nil {
return err
}
return nil
}
2019-02-23 15:01:46 +03:00
// loadRepoEnsureUser is the same as loadRepo, but also ensure that the user has configured
// an identity. Use this pre-run function when an error after using the configured user won't
// do.
func loadRepoEnsureUser(cmd *cobra.Command, args []string) error {
err := loadRepo(cmd, args)
if err != nil {
return err
}
set, err := identity.IsUserIdentitySet(repo)
if err != nil {
return err
}
if !set {
// Print the error directly to not confuse a user
_, _ = fmt.Fprintln(os.Stderr, identity.ErrNoIdentitySet.Error())
os.Exit(-1)
2019-02-23 15:01:46 +03:00
}
return nil
}