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

Check for terminal background color before starting pager

Browse source
This commit is contained in:
Sam Coe 2020-09-23 15:02:59 +02:00
parent f17d9672f5
commit ed4075517c
No known key found for this signature in database
GPG key ID: 8E322C20F811D086
10 changed files with 90 additions and 34 deletions
Download patch file Download diff file Expand all files Collapse all files

1
go.mod
View file

@ -18,6 +18,7 @@ require (
github.com/mattn/go-runewidth v0.0.9
github.com/mgutz/ansi v0.0.0-20200706080929-d51e80ef957d
github.com/mitchellh/go-homedir v1.1.0
github.com/muesli/termenv v0.6.0
github.com/rivo/uniseg v0.1.0
github.com/shurcooL/githubv4 v0.0.0-20200802174311-f27d2ca7f6d5
github.com/shurcooL/graphql v0.0.0-20181231061246-d48a9a75455f

3
pkg/cmd/gist/view/view.go
View file

@ -10,6 +10,7 @@ import (
"github.com/cli/cli/pkg/cmd/gist/shared"
"github.com/cli/cli/pkg/cmdutil"
"github.com/cli/cli/pkg/iostreams"
"github.com/cli/cli/pkg/markdown"
"github.com/cli/cli/utils"
"github.com/spf13/cobra"
)
@ -115,7 +116,7 @@ func viewRun(opts *ViewOptions) error {
}
content := gistFile.Content
if strings.Contains(gistFile.Type, "markdown") && !opts.Raw {
rendered, err := utils.RenderMarkdown(gistFile.Content)
rendered, err := markdown.Render(gistFile.Content, opts.IO.ResolveBgColor())
if err == nil {
content = rendered
}

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

@ -16,6 +16,7 @@ import (
prShared "github.com/cli/cli/pkg/cmd/pr/shared"
"github.com/cli/cli/pkg/cmdutil"
"github.com/cli/cli/pkg/iostreams"
"github.com/cli/cli/pkg/markdown"
"github.com/cli/cli/utils"
"github.com/spf13/cobra"
)
@ -89,6 +90,7 @@ func viewRun(opts *ViewOptions) error {
return utils.OpenInBrowser(openURL)
}
opts.IO.ResolveBgColor()
err = opts.IO.StartPager()
if err != nil {
return err
@ -96,7 +98,7 @@ func viewRun(opts *ViewOptions) error {
defer opts.IO.StopPager()
if opts.IO.IsStdoutTTY() {
return printHumanIssuePreview(opts.IO.Out, issue)
return printHumanIssuePreview(opts.IO, issue)
}
return printRawIssuePreview(opts.IO.Out, issue)
}
@ -122,7 +124,8 @@ func printRawIssuePreview(out io.Writer, issue *api.Issue) error {
return nil
}
func printHumanIssuePreview(out io.Writer, issue *api.Issue) error {
func printHumanIssuePreview(io *iostreams.IOStreams, issue *api.Issue) error {
out := io.Out
now := time.Now()
ago := now.Sub(issue.CreatedAt)
@ -158,7 +161,7 @@ func printHumanIssuePreview(out io.Writer, issue *api.Issue) error {
// Body
if issue.Body != "" {
fmt.Fprintln(out)
md, err := utils.RenderMarkdown(issue.Body)
md, err := markdown.Render(issue.Body, io.BgColor())
if err != nil {
return err
}

3
pkg/cmd/pr/review/review.go
View file

@ -14,6 +14,7 @@ import (
"github.com/cli/cli/pkg/cmd/pr/shared"
"github.com/cli/cli/pkg/cmdutil"
"github.com/cli/cli/pkg/iostreams"
"github.com/cli/cli/pkg/markdown"
"github.com/cli/cli/pkg/prompt"
"github.com/cli/cli/pkg/surveyext"
"github.com/cli/cli/utils"
@ -252,7 +253,7 @@ func reviewSurvey(io *iostreams.IOStreams, editorCommand string) (*api.PullReque
}
if len(bodyAnswers.Body) > 0 {
renderedBody, err := utils.RenderMarkdown(bodyAnswers.Body)
renderedBody, err := markdown.Render(bodyAnswers.Body, io.ResolveBgColor())
if err != nil {
return nil, err
}

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

@ -16,6 +16,7 @@ import (
"github.com/cli/cli/pkg/cmd/pr/shared"
"github.com/cli/cli/pkg/cmdutil"
"github.com/cli/cli/pkg/iostreams"
"github.com/cli/cli/pkg/markdown"
"github.com/cli/cli/utils"
"github.com/spf13/cobra"
)
@ -99,6 +100,7 @@ func viewRun(opts *ViewOptions) error {
return utils.OpenInBrowser(openURL)
}
opts.IO.ResolveBgColor()
err = opts.IO.StartPager()
if err != nil {
return err
@ -106,7 +108,7 @@ func viewRun(opts *ViewOptions) error {
defer opts.IO.StopPager()
if connectedToTerminal {
return printHumanPrPreview(opts.IO.Out, pr)
return printHumanPrPreview(opts.IO, pr)
}
return printRawPrPreview(opts.IO.Out, pr)
}
@ -134,7 +136,9 @@ func printRawPrPreview(out io.Writer, pr *api.PullRequest) error {
return nil
}
func printHumanPrPreview(out io.Writer, pr *api.PullRequest) error {
func printHumanPrPreview(io *iostreams.IOStreams, pr *api.PullRequest) error {
out := io.Out
// Header (Title and State)
fmt.Fprintln(out, utils.Bold(pr.Title))
fmt.Fprintf(out, "%s", shared.StateTitleWithColor(*pr))
@ -172,7 +176,7 @@ func printHumanPrPreview(out io.Writer, pr *api.PullRequest) error {
// Body
if pr.Body != "" {
fmt.Fprintln(out)
md, err := utils.RenderMarkdown(pr.Body)
md, err := markdown.Render(pr.Body, io.BgColor())
if err != nil {
return err
}

3
pkg/cmd/release/view/view.go
View file

@ -12,6 +12,7 @@ import (
"github.com/cli/cli/pkg/cmd/release/shared"
"github.com/cli/cli/pkg/cmdutil"
"github.com/cli/cli/pkg/iostreams"
"github.com/cli/cli/pkg/markdown"
"github.com/cli/cli/utils"
"github.com/spf13/cobra"
)
@ -122,7 +123,7 @@ func renderReleaseTTY(io *iostreams.IOStreams, release *shared.Release) error {
fmt.Fprintf(w, "%s\n", iofmt.Gray(fmt.Sprintf("%s released this %s", release.Author.Login, utils.FuzzyAgo(time.Since(release.PublishedAt)))))
}
renderedDescription, err := utils.RenderMarkdown(release.Body)
renderedDescription, err := markdown.Render(release.Body, io.ResolveBgColor())
if err != nil {
return err
}

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

@ -14,6 +14,7 @@ import (
"github.com/cli/cli/internal/ghrepo"
"github.com/cli/cli/pkg/cmdutil"
"github.com/cli/cli/pkg/iostreams"
"github.com/cli/cli/pkg/markdown"
"github.com/cli/cli/utils"
"github.com/enescakir/emoji"
"github.com/spf13/cobra"
@ -114,6 +115,8 @@ func viewRun(opts *ViewOptions) error {
return err
}
opts.IO.ResolveBgColor()
err = opts.IO.StartPager()
if err != nil {
return err
@ -153,7 +156,7 @@ func viewRun(opts *ViewOptions) error {
readmeContent = utils.Gray("This repository does not have a README")
} else if isMarkdownFile(readme.Filename) {
var err error
readmeContent, err = utils.RenderMarkdown(readme.Content)
readmeContent, err = markdown.Render(readme.Content, opts.IO.BgColor())
if err != nil {
return fmt.Errorf("error rendering markdown: %w", err)
}

28
pkg/iostreams/iostreams.go
View file

@ -15,6 +15,7 @@ import (
"github.com/google/shlex"
"github.com/mattn/go-colorable"
"github.com/mattn/go-isatty"
"github.com/muesli/termenv"
"golang.org/x/crypto/ssh/terminal"
)
@ -27,6 +28,7 @@ type IOStreams struct {
originalOut io.Writer
colorEnabled bool
is256enabled bool
bgColor string
progressIndicatorEnabled bool
progressIndicator *spinner.Spinner
@ -52,6 +54,32 @@ func (s *IOStreams) ColorSupport256() bool {
return s.is256enabled
}
func (s *IOStreams) ResolveBgColor() string {
style := os.Getenv("GLAMOUR_STYLE")
if (!s.ColorEnabled()) ||
(style != "" && style != "auto") ||
(s.pagerProcess != nil) {
s.bgColor = "none"
return "none"
}
if termenv.HasDarkBackground() {
s.bgColor = "dark"
return "dark"
}
s.bgColor = "light"
return "light"
}
func (s *IOStreams) BgColor() string {
if s.bgColor == "" {
return "none"
}
return s.bgColor
}
func (s *IOStreams) SetStdinTTY(isTTY bool) {
s.stdinTTYOverride = true
s.stdinIsTTY = isTTY

38
pkg/markdown/markdown.go Normal file
View file

@ -0,0 +1,38 @@
package markdown
import (
"os"
"strings"
"github.com/charmbracelet/glamour"
)
func Render(text string, bgColor string) (string, error) {
// Glamour rendering preserves carriage return characters in code blocks, but
// we need to ensure that no such characters are present in the output.
text = strings.ReplaceAll(text, "\r\n", "\n")
tr, err := glamour.NewTermRenderer(
glamour.WithStylePath(getEnvironmentStyle(bgColor)),
// glamour.WithBaseURL(""), // TODO: make configurable
// glamour.WithWordWrap(80), // TODO: make configurable
)
if err != nil {
return "", err
}
return tr.Render(text)
}
func getEnvironmentStyle(bgColor string) string {
style := os.Getenv("GLAMOUR_STYLE")
if style != "" && style != "auto" {
return style
}
if bgColor == "light" || bgColor == "dark" {
return bgColor
}
return "notty"
}

24
utils/utils.go
View file

@ -8,7 +8,6 @@ import (
"time"
"github.com/briandowns/spinner"
"github.com/charmbracelet/glamour"
"github.com/cli/cli/internal/run"
"github.com/cli/cli/pkg/browser"
)
@ -29,29 +28,6 @@ func OpenInBrowser(url string) error {
return err
}
func RenderMarkdown(text string) (string, error) {
// Glamour rendering preserves carriage return characters in code blocks, but
// we need to ensure that no such characters are present in the output.
text = strings.ReplaceAll(text, "\r\n", "\n")
renderStyle := glamour.WithStandardStyle("notty")
// TODO: make color an input parameter
if isColorEnabled() {
renderStyle = glamour.WithEnvironmentConfig()
}
tr, err := glamour.NewTermRenderer(
renderStyle,
// glamour.WithBaseURL(""), // TODO: make configurable
// glamour.WithWordWrap(80), // TODO: make configurable
)
if err != nil {
return "", err
}
return tr.Render(text)
}
func Pluralize(num int, thing string) string {
if num == 1 {
return fmt.Sprintf("%d %s", num, thing)