STACKITGit/cli
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Standardize pager output across commands (#5141)

Browse source 
Add pager functionality to the following commands:
- gist list
- pr checks
- release list
- run list
- run view
- secret list
- workflow list
- workflow view

Additionally, normalize error handling when starting the pager has
failed: only print a non-fatal notice to stderr instead of aborting the
whole command.
This commit is contained in:
Mislav Marohnić 2022-02-01 08:36:51 +01:00 • committed by GitHub
parent 1ec2c0807e
commit 4a3ef50d2d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
13 changed files with 81 additions and 57 deletions
Download patch file Download diff file Expand all files Collapse all files

8
pkg/cmd/api/api.go
View file

@ -279,11 +279,11 @@ func apiRun(opts *ApiOptions) error {
if opts.Silent {
opts.IO.Out = ioutil.Discard
} else {
err := opts.IO.StartPager()
if err != nil {
return err
if err := opts.IO.StartPager(); err == nil {
defer opts.IO.StopPager()
} else {
fmt.Fprintf(opts.IO.ErrOut, "failed to start pager: %v\n", err)
}
defer opts.IO.StopPager()
}
cfg, err := opts.Config()

7
pkg/cmd/gist/list/list.go
View file

@ -1,6 +1,7 @@
package list
import (
"fmt"
"net/http"
"strings"
"time"
@ -84,6 +85,12 @@ func listRun(opts *ListOptions) error {
return err
}
if err := opts.IO.StartPager(); err == nil {
defer opts.IO.StopPager()
} else {
fmt.Fprintf(opts.IO.ErrOut, "failed to start pager: %v\n", err)
}
cs := opts.IO.ColorScheme()
tp := utils.NewTablePrinter(opts.IO)

8
pkg/cmd/issue/list/list.go
View file

@ -160,11 +160,11 @@ func listRun(opts *ListOptions) error {
return err
}
err = opts.IO.StartPager()
if err != nil {
return err
if err := opts.IO.StartPager(); err == nil {
defer opts.IO.StopPager()
} else {
fmt.Fprintf(opts.IO.ErrOut, "failed to start pager: %v\n", err)
}
defer opts.IO.StopPager()
if opts.Exporter != nil {
return opts.Exporter.Write(opts.IO, listResult.Issues)

6
pkg/cmd/pr/checks/checks.go
View file

@ -193,6 +193,12 @@ func checksRun(opts *ChecksOptions) error {
return (b0 == "fail") || (b0 == "pending" && b1 == "success")
})
if err := opts.IO.StartPager(); err == nil {
defer opts.IO.StopPager()
} else {
fmt.Fprintf(opts.IO.ErrOut, "failed to start pager: %v\n", err)
}
tp := utils.NewTablePrinter(opts.IO)
for _, o := range outputs {

8
pkg/cmd/pr/diff/diff.go
View file

@ -104,11 +104,11 @@ func diffRun(opts *DiffOptions) error {
}
defer diff.Close()
err = opts.IO.StartPager()
if err != nil {
return err
if err := opts.IO.StartPager(); err == nil {
defer opts.IO.StopPager()
} else {
fmt.Fprintf(opts.IO.ErrOut, "failed to start pager: %v\n", err)
}
defer opts.IO.StopPager()
if !opts.UseColor {
_, err = io.Copy(opts.IO.Out, diff)

9
pkg/cmd/pr/view/view.go
View file

@ -109,12 +109,11 @@ func viewRun(opts *ViewOptions) error {
}
opts.IO.DetectTerminalTheme()
err = opts.IO.StartPager()
if err != nil {
return err
if err := opts.IO.StartPager(); err == nil {
defer opts.IO.StopPager()
} else {
fmt.Fprintf(opts.IO.ErrOut, "failed to start pager: %v\n", err)
}
defer opts.IO.StopPager()
if opts.Exporter != nil {
return opts.Exporter.Write(opts.IO, pr)

6
pkg/cmd/release/list/list.go
View file

@ -63,6 +63,12 @@ func listRun(opts *ListOptions) error {
return err
}
if err := opts.IO.StartPager(); err == nil {
defer opts.IO.StopPager()
} else {
fmt.Fprintf(opts.IO.ErrOut, "failed to start pager: %v\n", err)
}
now := time.Now()
table := utils.NewTablePrinter(opts.IO)
iofmt := opts.IO.ColorScheme()

7
pkg/cmd/repo/view/view.go
View file

@ -142,10 +142,11 @@ func viewRun(opts *ViewOptions) error {
}
opts.IO.DetectTerminalTheme()
if err := opts.IO.StartPager(); err != nil {
return err
if err := opts.IO.StartPager(); err == nil {
defer opts.IO.StopPager()
} else {
fmt.Fprintf(opts.IO.ErrOut, "failed to start pager: %v\n", err)
}
defer opts.IO.StopPager()
if opts.Exporter != nil {
return opts.Exporter.Write(opts.IO, repo)

6
pkg/cmd/run/list/list.go
View file

@ -107,6 +107,12 @@ func listRun(opts *ListOptions) error {
return fmt.Errorf("failed to get runs: %w", err)
}
if err := opts.IO.StartPager(); err == nil {
defer opts.IO.StopPager()
} else {
fmt.Fprintf(opts.IO.ErrOut, "failed to start pager: %v\n", err)
}
if opts.Exporter != nil {
return opts.Exporter.Write(opts.IO, runs)
}

18
pkg/cmd/run/view/view.go
View file

@ -230,6 +230,12 @@ func runView(opts *ViewOptions) error {
}
}
if err := opts.IO.StartPager(); err == nil {
defer opts.IO.StopPager()
} else {
fmt.Fprintf(opts.IO.ErrOut, "failed to start pager: %v\n", err)
}
if opts.Exporter != nil {
return opts.Exporter.Write(opts.IO, run)
}
@ -276,7 +282,7 @@ func runView(opts *ViewOptions) error {
attachRunLog(runLogZip, jobs)
return displayRunLog(opts.IO, jobs, opts.LogFailed)
return displayRunLog(opts.IO.Out, jobs, opts.LogFailed)
}
prNumber := ""
@ -502,13 +508,7 @@ func attachRunLog(rlz *zip.ReadCloser, jobs []shared.Job) {
}
}
func displayRunLog(io *iostreams.IOStreams, jobs []shared.Job, failed bool) error {
err := io.StartPager()
if err != nil {
return err
}
defer io.StopPager()
func displayRunLog(w io.Writer, jobs []shared.Job, failed bool) error {
for _, job := range jobs {
steps := job.Steps
sort.Sort(steps)
@ -526,7 +526,7 @@ func displayRunLog(io *iostreams.IOStreams, jobs []shared.Job, failed bool) erro
}
scanner := bufio.NewScanner(f)
for scanner.Scan() {
fmt.Fprintf(io.Out, "%s%s\n", prefix, scanner.Text())
fmt.Fprintf(w, "%s%s\n", prefix, scanner.Text())
}
f.Close()
}

6
pkg/cmd/secret/list/list.go
View file

@ -122,6 +122,12 @@ func listRun(opts *ListOptions) error {
return fmt.Errorf("failed to get secrets: %w", err)
}
if err := opts.IO.StartPager(); err == nil {
defer opts.IO.StopPager()
} else {
fmt.Fprintf(opts.IO.ErrOut, "failed to start pager: %v\n", err)
}
tp := utils.NewTablePrinter(opts.IO)
for _, secret := range secrets {
tp.AddField(secret.Name, nil, nil)

6
pkg/cmd/workflow/list/list.go
View file

@ -88,6 +88,12 @@ func listRun(opts *ListOptions) error {
return nil
}
if err := opts.IO.StartPager(); err == nil {
defer opts.IO.StopPager()
} else {
fmt.Fprintf(opts.IO.ErrOut, "failed to start pager: %v\n", err)
}
tp := utils.NewTablePrinter(opts.IO)
cs := opts.IO.ColorScheme()

43
pkg/cmd/workflow/view/view.go
View file

@ -123,10 +123,17 @@ func runView(opts *ViewOptions) error {
return opts.Browser.Browse(address)
}
if opts.YAML {
err = viewWorkflowContent(opts, client, workflow)
opts.IO.DetectTerminalTheme()
if err := opts.IO.StartPager(); err == nil {
defer opts.IO.StopPager()
} else {
err = viewWorkflowInfo(opts, client, workflow)
fmt.Fprintf(opts.IO.ErrOut, "failed to start pager: %v\n", err)
}
if opts.YAML {
err = viewWorkflowContent(opts, client, repo, workflow, opts.Ref)
} else {
err = viewWorkflowInfo(opts, client, repo, workflow)
}
if err != nil {
return err
@ -135,19 +142,12 @@ func runView(opts *ViewOptions) error {
return nil
}
func viewWorkflowContent(opts *ViewOptions, client *api.Client, workflow *shared.Workflow) error {
repo, err := opts.BaseRepo()
if err != nil {
return fmt.Errorf("could not determine base repo: %w", err)
}
opts.IO.StartProgressIndicator()
yamlBytes, err := shared.GetWorkflowContent(client, repo, *workflow, opts.Ref)
opts.IO.StopProgressIndicator()
func viewWorkflowContent(opts *ViewOptions, client *api.Client, repo ghrepo.Interface, workflow *shared.Workflow, ref string) error {
yamlBytes, err := shared.GetWorkflowContent(client, repo, *workflow, ref)
if err != nil {
if s, ok := err.(api.HTTPError); ok && s.StatusCode == 404 {
if opts.Ref != "" {
return fmt.Errorf("could not find workflow file %s on %s, try specifying a different ref", workflow.Base(), opts.Ref)
if ref != "" {
return fmt.Errorf("could not find workflow file %s on %s, try specifying a different ref", workflow.Base(), ref)
}
return fmt.Errorf("could not find workflow file %s, try specifying a branch or tag using `--ref`", workflow.Base())
}
@ -156,12 +156,6 @@ func viewWorkflowContent(opts *ViewOptions, client *api.Client, workflow *shared
yaml := string(yamlBytes)
opts.IO.DetectTerminalTheme()
if err := opts.IO.StartPager(); err != nil {
fmt.Fprintf(opts.IO.ErrOut, "starting pager failed: %v\n", err)
}
defer opts.IO.StopPager()
if !opts.Raw {
cs := opts.IO.ColorScheme()
out := opts.IO.Out
@ -191,15 +185,8 @@ func viewWorkflowContent(opts *ViewOptions, client *api.Client, workflow *shared
return nil
}
func viewWorkflowInfo(opts *ViewOptions, client *api.Client, workflow *shared.Workflow) error {
repo, err := opts.BaseRepo()
if err != nil {
return fmt.Errorf("could not determine base repo: %w", err)
}
opts.IO.StartProgressIndicator()
func viewWorkflowInfo(opts *ViewOptions, client *api.Client, repo ghrepo.Interface, workflow *shared.Workflow) error {
wr, err := getWorkflowRuns(client, repo, workflow)
opts.IO.StopProgressIndicator()
if err != nil {
return fmt.Errorf("failed to get runs: %w", err)
}