/
pr.go
427 lines (332 loc) · 10.5 KB
/
pr.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
package commands
import (
"fmt"
"strconv"
"strings"
"github.com/hilalisadev/hub/git"
"github.com/hilalisadev/hub/github"
"github.com/hilalisadev/hub/ui"
"github.com/hilalisadev/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] [-f <FORMAT>] [-h <HEAD>]
pr show [-uc] [-f <FORMAT>] <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. When no <PR-NUMBER> is
specified, <HEAD> is used to look up open pull requests and defaults to
the current branch name. With '--format', print information about the
pull request instead of opening it.
## 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 pull requests 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> pull requests.
-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
-f, --format FORMAT
--color
`,
}
)
func init() {
cmdPr.Use(cmdListPulls)
cmdPr.Use(cmdCheckoutPr)
cmdPr.Use(cmdShowPr)
CmdRunner.Use(cmdPr)
}
func printHelp(command *Command, args *Args) []byte {
utils.Check(command.UsageError(""))
return nil
}
func listPulls(cmd *Command, args *Args) []byte {
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 nil
}
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))
}
return nil
}
func checkoutPr(command *Command, args *Args) []byte {
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...)
return nil
}
func showPr(command *Command, args *Args) []byte {
localRepo, err := github.LocalRepo()
utils.Check(err)
baseProject, err := localRepo.MainProject()
utils.Check(err)
host, err := github.CurrentConfig().PromptForHost(baseProject.Host)
utils.Check(err)
gh := github.NewClientWithHost(host)
words := args.Words()
openUrl := ""
prNumber := 0
var pr *github.PullRequest
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, gh, baseProject, args.Flag.Value("--head"))
utils.Check(err)
openUrl = pr.HtmlUrl
}
args.NoForward()
if format := args.Flag.Value("--format"); format != "" {
if pr == nil {
pr, err = gh.PullRequest(baseProject, strconv.Itoa(prNumber))
utils.Check(err)
}
colorize := colorizeOutput(args.Flag.HasReceived("--color"), args.Flag.Value("--color"))
ui.Println(formatPullRequest(*pr, format, colorize))
return nil
}
printUrl := args.Flag.Bool("--url")
copyUrl := args.Flag.Bool("--copy")
printBrowseOrCopy(args, openUrl, !printUrl && !copyUrl, copyUrl)
return nil
}
func findCurrentPullRequest(localRepo *github.GitHubRepo, gh *github.Client, baseProject *github.Project, headArg string) (*github.PullRequest, error) {
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, gh.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)
}