Add supports for terminal hyperlinks in output

mislav · mislav · commit ca3f730a01af · 2021-03-26T19:02:22.000+01:00
In supporting terminals (e.g. iTerm), the identifier field of
table-based output like `issue/pr list` and `pr checks` is now a link
that can be followed in a browser by Cmd-clicking it.
diff --git a/pkg/cmd/gist/view/view_test.go b/pkg/cmd/gist/view/view_test.go
@@ -443,7 +443,7 @@ func Test_promptGists(t *testing.T) {
 	}
 
 	io, _, _, _ := iostreams.Test()
-	cs := iostreams.NewColorScheme(io.ColorEnabled(), io.ColorSupport256())
+	cs := io.ColorScheme()
 
 	for _, tt := range tests {
 		reg := &httpmock.Registry{}
diff --git a/pkg/cmd/issue/shared/display.go b/pkg/cmd/issue/shared/display.go
@@ -28,7 +28,11 @@ func PrintIssues(io *iostreams.IOStreams, prefix string, totalCount int, issues
 		}
 		now := time.Now()
 		ago := now.Sub(issue.UpdatedAt)
-		table.AddField(issueNum, nil, cs.ColorFromString(prShared.ColorForState(issue.State)))
+		colorFunc := cs.ColorFromString(prShared.ColorForState(issue.State))
+		issueURL := issue.URL
+		table.AddField(issueNum, nil, func(t string) string {
+			return colorFunc(cs.Hyperlink(t, issueURL))
+		})
 		if !table.IsTTY() {
 			table.AddField(issue.State, nil, nil)
 		}
diff --git a/pkg/cmd/pr/checks/checks.go b/pkg/cmd/pr/checks/checks.go
@@ -190,9 +190,18 @@ func checksRun(opts *ChecksOptions) error {
 	for _, o := range outputs {
 		if isTerminal {
 			tp.AddField(o.mark, nil, o.markColor)
-			tp.AddField(o.name, nil, nil)
+			var linkFunc func(string) string
+			if opts.IO.IsLinkEnabled() {
+				url := o.link
+				linkFunc = func(t string) string {
+					return cs.Hyperlink(t, url)
+				}
+			}
+			tp.AddField(o.name, nil, linkFunc)
 			tp.AddField(o.elapsed, nil, nil)
-			tp.AddField(o.link, nil, nil)
+			if !opts.IO.IsLinkEnabled() {
+				tp.AddField(o.link, nil, nil)
+			}
 		} else {
 			tp.AddField(o.name, nil, nil)
 			tp.AddField(o.bucket, nil, nil)
diff --git a/pkg/cmd/pr/list/list.go b/pkg/cmd/pr/list/list.go
@@ -131,7 +131,11 @@ func listRun(opts *ListOptions) error {
 		if table.IsTTY() {
 			prNum = "#" + prNum
 		}
-		table.AddField(prNum, nil, cs.ColorFromString(shared.ColorForPR(pr)))
+		prURL := pr.URL
+		colorFunc := cs.ColorFromString(shared.ColorForPR(pr))
+		table.AddField(prNum, nil, func(t string) string {
+			return colorFunc(cs.Hyperlink(t, prURL))
+		})
 		table.AddField(text.ReplaceExcessiveWhitespace(pr.Title), nil, nil)
 		table.AddField(pr.HeadLabel(), nil, cs.Cyan)
 		if !table.IsTTY() {
diff --git a/pkg/iostreams/color.go b/pkg/iostreams/color.go
@@ -44,16 +44,18 @@ func Is256ColorSupported() bool {
 		strings.Contains(colorterm, "truecolor")
 }
 
-func NewColorScheme(enabled, is256enabled bool) *ColorScheme {
+func NewColorScheme(enabled, is256enabled, isLinkEnabled bool) *ColorScheme {
 	return &ColorScheme{
 		enabled:      enabled,
 		is256enabled: is256enabled,
+		linkEnabled:  isLinkEnabled,
 	}
 }
 
 type ColorScheme struct {
 	enabled      bool
 	is256enabled bool
+	linkEnabled  bool
 }
 
 func (c *ColorScheme) Bold(t string) string {
@@ -202,3 +204,11 @@ func (c *ColorScheme) ColorFromString(s string) func(string) string {
 
 	return fn
 }
+
+func (c *ColorScheme) Hyperlink(text, url string) string {
+	if !c.linkEnabled {
+		return text
+	}
+	// https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda
+	return fmt.Sprintf("\x1b]8;;%s\x1b\\%s\x1b]8;;\x1b\\", url, text)
+}
diff --git a/pkg/iostreams/iostreams.go b/pkg/iostreams/iostreams.go
@@ -30,6 +30,7 @@ type IOStreams struct {
 	colorEnabled  bool
 	is256enabled  bool
 	terminalTheme string
+	linkEnabled   bool
 
 	progressIndicatorEnabled bool
 	progressIndicator        *spinner.Spinner
@@ -91,6 +92,10 @@ func (s *IOStreams) TerminalTheme() string {
 	return s.terminalTheme
 }
 
+func (s *IOStreams) IsLinkEnabled() bool {
+	return s.linkEnabled
+}
+
 func (s *IOStreams) SetStdinTTY(isTTY bool) {
 	s.stdinTTYOverride = true
 	s.stdinIsTTY = isTTY
@@ -252,7 +257,7 @@ func (s *IOStreams) TerminalWidth() int {
 }
 
 func (s *IOStreams) ColorScheme() *ColorScheme {
-	return NewColorScheme(s.ColorEnabled(), s.ColorSupport256())
+	return NewColorScheme(s.ColorEnabled(), s.ColorSupport256(), s.IsLinkEnabled())
 }
 
 func (s *IOStreams) ReadUserFile(fn string) ([]byte, error) {
@@ -295,6 +300,7 @@ func System() *IOStreams {
 		ErrOut:       colorable.NewColorable(os.Stderr),
 		colorEnabled: EnvColorForced() || (!EnvColorDisabled() && stdoutIsTTY),
 		is256enabled: Is256ColorSupported(),
+		linkEnabled:  os.Getenv("GH_HYPERLINK") != "",
 		pagerCommand: pagerCommand,
 	}
 
diff --git a/utils/table_printer.go b/utils/table_printer.go
@@ -109,15 +109,15 @@ func (t *ttyTablePrinter) Render() error {
 				}
 			}
 			truncVal := field.TruncateFunc(colWidths[col], field.Text)
+			if field.ColorFunc != nil {
+				truncVal = field.ColorFunc(truncVal)
+			}
 			if col < numCols-1 {
 				// pad value with spaces on the right
 				if padWidth := colWidths[col] - text.DisplayWidth(field.Text); padWidth > 0 {
 					truncVal += strings.Repeat(" ", padWidth)
 				}
 			}
-			if field.ColorFunc != nil {
-				truncVal = field.ColorFunc(truncVal)
-			}
 			_, err := fmt.Fprint(t.out, truncVal)
 			if err != nil {
 				return err

Original file line number	Diff line number	Diff line change
`@@ -443,7 +443,7 @@ func Test_promptGists(t *testing.T) {`
`443`	`443`	`}`
`444`	`444`
`445`	`445`	`io, _, _, _ := iostreams.Test()`
`446`		`- cs := iostreams.NewColorScheme(io.ColorEnabled(), io.ColorSupport256())`
	`446`	`+ cs := io.ColorScheme()`
`447`	`447`
`448`	`448`	`for _, tt := range tests {`
`449`	`449`	`reg := &httpmock.Registry{}`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,11 @@ func PrintIssues(io *iostreams.IOStreams, prefix string, totalCount int, issues`
`28`	`28`	`}`
`29`	`29`	`now := time.Now()`
`30`	`30`	`ago := now.Sub(issue.UpdatedAt)`
`31`		`- table.AddField(issueNum, nil, cs.ColorFromString(prShared.ColorForState(issue.State)))`
	`31`	`+ colorFunc := cs.ColorFromString(prShared.ColorForState(issue.State))`
	`32`	`+ issueURL := issue.URL`
	`33`	`+ table.AddField(issueNum, nil, func(t string) string {`
	`34`	`+ return colorFunc(cs.Hyperlink(t, issueURL))`
	`35`	`+ })`
`32`	`36`	`if !table.IsTTY() {`
`33`	`37`	`table.AddField(issue.State, nil, nil)`
`34`	`38`	`}`
Original file line number	Diff line number	Diff line change
`@@ -44,16 +44,18 @@ func Is256ColorSupported() bool {`
`44`	`44`	`strings.Contains(colorterm, "truecolor")`
`45`	`45`	`}`
`46`	`46`
`47`		`-func NewColorScheme(enabled, is256enabled bool) *ColorScheme {`
	`47`	`+func NewColorScheme(enabled, is256enabled, isLinkEnabled bool) *ColorScheme {`
`48`	`48`	`return &ColorScheme{`
`49`	`49`	`enabled: enabled,`
`50`	`50`	`is256enabled: is256enabled,`
	`51`	`+ linkEnabled: isLinkEnabled,`
`51`	`52`	`}`
`52`	`53`	`}`
`53`	`54`
`54`	`55`	`type ColorScheme struct {`
`55`	`56`	`enabled bool`
`56`	`57`	`is256enabled bool`
	`58`	`+ linkEnabled bool`
`57`	`59`	`}`
`58`	`60`
`59`	`61`	`func (c *ColorScheme) Bold(t string) string {`
`@@ -202,3 +204,11 @@ func (c *ColorScheme) ColorFromString(s string) func(string) string {`
`202`	`204`
`203`	`205`	`return fn`
`204`	`206`	`}`
	`207`	`+`
	`208`	`+func (c *ColorScheme) Hyperlink(text, url string) string {`
	`209`	`+ if !c.linkEnabled {`
	`210`	`+ return text`
	`211`	`+ }`
	`212`	`+ // https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda`
	`213`	`+ return fmt.Sprintf("\x1b]8;;%s\x1b\\%s\x1b]8;;\x1b\\", url, text)`
	`214`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -109,15 +109,15 @@ func (t *ttyTablePrinter) Render() error {`
`109`	`109`	`}`
`110`	`110`	`}`
`111`	`111`	`truncVal := field.TruncateFunc(colWidths[col], field.Text)`
	`112`	`+ if field.ColorFunc != nil {`
	`113`	`+ truncVal = field.ColorFunc(truncVal)`
	`114`	`+ }`
`112`	`115`	`if col < numCols-1 {`
`113`	`116`	`// pad value with spaces on the right`
`114`	`117`	`if padWidth := colWidths[col] - text.DisplayWidth(field.Text); padWidth > 0 {`
`115`	`118`	`truncVal += strings.Repeat(" ", padWidth)`
`116`	`119`	`}`
`117`	`120`	`}`
`118`		`- if field.ColorFunc != nil {`
`119`		`- truncVal = field.ColorFunc(truncVal)`
`120`		`- }`
`121`	`121`	`_, err := fmt.Fprint(t.out, truncVal)`
`122`	`122`	`if err != nil {`
`123`	`123`	`return err`