hub/commands/pr.go

405 строки
9.7 KiB
Go

package commands
import (
"fmt"
"strconv"
"strings"
"github.com/github/hub/git"
"github.com/github/hub/github"
"github.com/github/hub/ui"
"github.com/github/hub/utils"
)
var (
cmdPr = &Command{
Run: printHelp,
Usage: `
pr list [-s <STATE>] [-h <HEAD>] [-b <BASE>] [-o <SORT_KEY> [-^]] [-f <FORMAT>] [-L <LIMIT>]
pr checkout <PR-NUMBER> [<BRANCH>]
pr show [-uc] [-h <HEAD>]
pr show [-uc] <PR-NUMBER>
`,
Long: `Manage GitHub Pull Requests for the current repository.
## Commands:
* _list_:
List pull requests in the current repository.
* _checkout_:
Check out the head of a pull request in a new branch.
* _show_:
Open a pull request page in a web browser.
## Options:
-s, --state <STATE>
Filter pull requests by <STATE>. Supported values are: "open" (default),
"closed", "merged", or "all".
-h, --head <BRANCH>
Show pull requests started from the specified head <BRANCH>. The
"OWNER:BRANCH" format must be used for pull requests from forks.
-b, --base <BRANCH>
Show pull requests based off the specified <BRANCH>.
-f, --format <FORMAT>
Pretty print the list of pull requests using format <FORMAT> (default:
"%pC%>(8)%i%Creset %t% l%n"). See the "PRETTY FORMATS" section of
git-log(1) for some additional details on how placeholders are used in
format. The available placeholders are:
%I: pull request number
%i: pull request number prefixed with "#"
%U: the URL of this pull request
%S: state ("open" or "closed")
%pS: pull request state ("open", "draft", "merged", or "closed")
%sC: set color to red or green, depending on state
%pC: set color according to pull request state
%t: title
%l: colored labels
%L: raw, comma-separated labels
%b: body
%B: base branch
%sB: base commit SHA
%H: head branch
%sH: head commit SHA
%sm: merge commit SHA
%au: login name of author
%as: comma-separated list of assignees
%rs: comma-separated list of requested reviewers
%Mn: milestone number
%Mt: milestone title
%cD: created date-only (no time of day)
%cr: created date, relative
%ct: created date, UNIX timestamp
%cI: created date, ISO 8601 format
%uD: updated date-only (no time of day)
%ur: updated date, relative
%ut: updated date, UNIX timestamp
%uI: updated date, ISO 8601 format
%mD: merged date-only (no time of day)
%mr: merged date, relative
%mt: merged date, UNIX timestamp
%mI: merged date, ISO 8601 format
%n: newline
%%: a literal %
--color[=<WHEN>]
Enable colored output even if stdout is not a terminal. <WHEN> can be one
of "always" (default for '--color'), "never", or "auto" (default).
-o, --sort <KEY>
Sort displayed issues by "created" (default), "updated", "popularity", or "long-running".
-^, --sort-ascending
Sort by ascending dates instead of descending.
-L, --limit <LIMIT>
Display only the first <LIMIT> issues.
-u, --url
Print the pull request URL instead of opening it.
-c, --copy
Put the pull request URL to clipboard instead of opening it.
## See also:
hub-issue(1), hub-pull-request(1), hub(1)
`,
}
cmdCheckoutPr = &Command{
Key: "checkout",
Run: checkoutPr,
KnownFlags: "\n",
}
cmdListPulls = &Command{
Key: "list",
Run: listPulls,
Long: cmdPr.Long,
}
cmdShowPr = &Command{
Key: "show",
Run: showPr,
KnownFlags: `
-h, --head HEAD
-u, --url
-c, --copy
`,
}
)
func init() {
cmdPr.Use(cmdListPulls)
cmdPr.Use(cmdCheckoutPr)
cmdPr.Use(cmdShowPr)
CmdRunner.Use(cmdPr)
}
func printHelp(command *Command, args *Args) {
utils.Check(command.UsageError(""))
}
func listPulls(cmd *Command, args *Args) {
localRepo, err := github.LocalRepo()
utils.Check(err)
project, err := localRepo.MainProject()
utils.Check(err)
gh := github.NewClient(project.Host)
args.NoForward()
if args.Noop {
ui.Printf("Would request list of pull requests for %s\n", project)
return
}
filters := map[string]interface{}{}
if args.Flag.HasReceived("--state") {
filters["state"] = args.Flag.Value("--state")
}
if args.Flag.HasReceived("--sort") {
filters["sort"] = args.Flag.Value("--sort")
}
if args.Flag.HasReceived("--base") {
filters["base"] = args.Flag.Value("--base")
}
if args.Flag.HasReceived("--head") {
head := args.Flag.Value("--head")
if !strings.Contains(head, ":") {
head = fmt.Sprintf("%s:%s", project.Owner, head)
}
filters["head"] = head
}
if args.Flag.Bool("--sort-ascending") {
filters["direction"] = "asc"
} else {
filters["direction"] = "desc"
}
onlyMerged := false
if filters["state"] == "merged" {
filters["state"] = "closed"
onlyMerged = true
}
flagPullRequestLimit := args.Flag.Int("--limit")
flagPullRequestFormat := args.Flag.Value("--format")
if !args.Flag.HasReceived("--format") {
flagPullRequestFormat = "%pC%>(8)%i%Creset %t% l%n"
}
pulls, err := gh.FetchPullRequests(project, filters, flagPullRequestLimit, func(pr *github.PullRequest) bool {
return !(onlyMerged && pr.MergedAt.IsZero())
})
utils.Check(err)
colorize := colorizeOutput(args.Flag.HasReceived("--color"), args.Flag.Value("--color"))
for _, pr := range pulls {
ui.Print(formatPullRequest(pr, flagPullRequestFormat, colorize))
}
}
func checkoutPr(command *Command, args *Args) {
words := args.Words()
var newBranchName string
if len(words) == 0 {
utils.Check(fmt.Errorf("Error: No pull request number given"))
} else if len(words) > 1 {
newBranchName = words[1]
}
prNumberString := words[0]
_, err := strconv.Atoi(prNumberString)
utils.Check(err)
// Figure out the PR URL
localRepo, err := github.LocalRepo()
utils.Check(err)
baseProject, err := localRepo.MainProject()
utils.Check(err)
host, err := github.CurrentConfig().PromptForHost(baseProject.Host)
utils.Check(err)
client := github.NewClientWithHost(host)
pr, err := client.PullRequest(baseProject, prNumberString)
utils.Check(err)
newArgs, err := transformCheckoutArgs(args, pr, newBranchName)
utils.Check(err)
args.Replace(args.Executable, "checkout", newArgs...)
}
func showPr(command *Command, args *Args) {
localRepo, err := github.LocalRepo()
utils.Check(err)
baseProject, err := localRepo.MainProject()
utils.Check(err)
words := args.Words()
openUrl := ""
if len(words) > 0 {
if prNumber, err := strconv.Atoi(words[0]); err == nil {
openUrl = baseProject.WebURL("", "", fmt.Sprintf("pull/%d", prNumber))
} else {
utils.Check(fmt.Errorf("invalid pull request number: '%s'", words[0]))
}
} else {
pr, err := findCurrentPullRequest(localRepo, baseProject, args.Flag.Value("--head"))
utils.Check(err)
openUrl = pr.HtmlUrl
}
args.NoForward()
printUrl := args.Flag.Bool("--url")
copyUrl := args.Flag.Bool("--copy")
printBrowseOrCopy(args, openUrl, !printUrl && !copyUrl, copyUrl)
}
func findCurrentPullRequest(localRepo *github.GitHubRepo, baseProject *github.Project, headArg string) (*github.PullRequest, error) {
host, err := github.CurrentConfig().PromptForHost(baseProject.Host)
utils.Check(err)
gh := github.NewClientWithHost(host)
filterParams := map[string]interface{}{
"state": "open",
}
headWithOwner := ""
if headArg != "" {
headWithOwner = headArg
if !strings.Contains(headWithOwner, ":") {
headWithOwner = fmt.Sprintf("%s:%s", baseProject.Owner, headWithOwner)
}
} else {
currentBranch, err := localRepo.CurrentBranch()
utils.Check(err)
if headBranch, headProject, err := findPushTarget(currentBranch); err == nil {
headWithOwner = fmt.Sprintf("%s:%s", headProject.Owner, headBranch.ShortName())
} else if headProject, err := deducePushTarget(currentBranch, host.User); err == nil {
headWithOwner = fmt.Sprintf("%s:%s", headProject.Owner, currentBranch.ShortName())
} else {
headWithOwner = fmt.Sprintf("%s:%s", baseProject.Owner, currentBranch.ShortName())
}
}
filterParams["head"] = headWithOwner
pulls, err := gh.FetchPullRequests(baseProject, filterParams, 1, nil)
if err != nil {
return nil, err
} else if len(pulls) == 1 {
return &pulls[0], nil
} else {
return nil, fmt.Errorf("no open pull requests found for branch '%s'", headWithOwner)
}
}
func branchTrackingInformation(branch *github.Branch) (string, *github.Branch, error) {
branchRemote, err := git.Config(fmt.Sprintf("branch.%s.remote", branch.ShortName()))
if branchRemote == "." {
err = fmt.Errorf("branch is tracking another local branch")
}
if err != nil {
return "", nil, err
}
branchMerge, err := git.Config(fmt.Sprintf("branch.%s.merge", branch.ShortName()))
if err != nil {
return "", nil, err
}
trackingBranch := &github.Branch{
Repo: branch.Repo,
Name: branchMerge,
}
return branchRemote, trackingBranch, nil
}
func findPushTarget(branch *github.Branch) (*github.Branch, *github.Project, error) {
branchRemote, headBranch, err := branchTrackingInformation(branch)
if err != nil {
return nil, nil, err
}
if headRemote, err := branch.Repo.RemoteByName(branchRemote); err == nil {
headProject, err := headRemote.Project()
if err != nil {
return nil, nil, err
}
return headBranch, headProject, nil
}
remoteUrl, err := git.ParseURL(branchRemote)
if err != nil {
return nil, nil, err
}
headProject, err := github.NewProjectFromURL(remoteUrl)
if err != nil {
return nil, nil, err
}
return headBranch, headProject, nil
}
func deducePushTarget(branch *github.Branch, owner string) (*github.Project, error) {
remote := branch.Repo.RemoteForBranch(branch, owner)
if remote == nil {
return nil, fmt.Errorf("no remote found for branch %s", branch.ShortName())
}
return remote.Project()
}
func formatPullRequest(pr github.PullRequest, format string, colorize bool) string {
placeholders := formatIssuePlaceholders(github.Issue(pr), colorize)
delete(placeholders, "NC")
delete(placeholders, "Nc")
for key, value := range formatPullRequestPlaceholders(pr, colorize) {
placeholders[key] = value
}
return ui.Expand(format, placeholders, colorize)
}