Merge pull request cli#10709 from cli/andyfeller/table-datetime-contrast-github-cli-832

andyfeller · web-flow · commit b52c131d4c4b · 2025-04-02T17:20:15.000-04:00
Ensure table datetime columns have thematic, customizable muted text
diff --git a/pkg/cmd/cache/list/list.go b/pkg/cmd/cache/list/list.go
@@ -99,11 +99,12 @@ func listRun(opts *ListOptions) error {
 	}
 	client := api.NewClientFromHTTP(httpClient)
 
+	cs := opts.IO.ColorScheme()
 	opts.IO.StartProgressIndicator()
 	result, err := shared.GetCaches(client, repo, shared.GetCachesOptions{Limit: opts.Limit, Sort: opts.Sort, Order: opts.Order, Key: opts.Key, Ref: opts.Ref})
 	opts.IO.StopProgressIndicator()
 	if err != nil {
-		return fmt.Errorf("%s Failed to get caches: %w", opts.IO.ColorScheme().FailureIcon(), err)
+		return fmt.Errorf("%s Failed to get caches: %w", cs.FailureIcon(), err)
 	}
 
 	if len(result.ActionsCaches) == 0 && opts.Exporter == nil {
@@ -130,11 +131,11 @@ func listRun(opts *ListOptions) error {
 
 	tp := tableprinter.New(opts.IO, tableprinter.WithHeader("ID", "KEY", "SIZE", "CREATED", "ACCESSED"))
 	for _, cache := range result.ActionsCaches {
-		tp.AddField(opts.IO.ColorScheme().Cyan(fmt.Sprintf("%d", cache.Id)))
+		tp.AddField(cs.Cyanf("%d", cache.Id))
 		tp.AddField(cache.Key)
 		tp.AddField(humanFileSize(cache.SizeInBytes))
-		tp.AddTimeField(opts.Now, cache.CreatedAt, opts.IO.ColorScheme().Gray)
-		tp.AddTimeField(opts.Now, cache.LastAccessedAt, opts.IO.ColorScheme().Gray)
+		tp.AddTimeField(opts.Now, cache.CreatedAt, cs.Muted)
+		tp.AddTimeField(opts.Now, cache.LastAccessedAt, cs.Muted)
 		tp.EndRow()
 	}
 
diff --git a/pkg/cmd/codespace/list.go b/pkg/cmd/codespace/list.go
@@ -152,7 +152,7 @@ func (a *App) List(ctx context.Context, opts *listOptions, exporter cmdutil.Expo
 		case false:
 			nameColor = cs.Yellow
 		case true:
-			nameColor = cs.Gray
+			nameColor = cs.Muted
 		}
 
 		tp.AddField(formattedName, tableprinter.WithColor(nameColor))
@@ -172,7 +172,7 @@ func (a *App) List(ctx context.Context, opts *listOptions, exporter cmdutil.Expo
 		if err != nil {
 			return fmt.Errorf("error parsing date %q: %w", c.CreatedAt, err)
 		}
-		tp.AddTimeField(time.Now(), ct, cs.Gray)
+		tp.AddTimeField(time.Now(), ct, cs.Muted)
 
 		if hasNonProdVSCSTarget {
 			tp.AddField(c.VSCSTarget)
diff --git a/pkg/cmd/factory/default.go b/pkg/cmd/factory/default.go
@@ -19,6 +19,7 @@ import (
 	"github.com/cli/cli/v2/pkg/cmd/extension"
 	"github.com/cli/cli/v2/pkg/cmdutil"
 	"github.com/cli/cli/v2/pkg/iostreams"
+	xcolor "github.com/cli/go-gh/v2/pkg/x/color"
 )
 
 var ssoHeader string
@@ -292,6 +293,8 @@ func ioStreams(f *cmdutil.Factory) *iostreams.IOStreams {
 		io.SetPager(pager.Value)
 	}
 
+	io.SetAccessibleColorsEnabled(xcolor.IsAccessibleColorsEnabled())
+
 	return io
 }
 
diff --git a/pkg/cmd/gist/list/list.go b/pkg/cmd/gist/list/list.go
@@ -206,7 +206,7 @@ func printTable(io *iostreams.IOStreams, gists []shared.Gist, filter *regexp.Reg
 			tableprinter.WithColor(highlightFilesFunc(&gist)),
 		)
 		tp.AddField(visibility, tableprinter.WithColor(visColor))
-		tp.AddTimeField(time.Now(), gist.UpdatedAt, cs.Gray)
+		tp.AddTimeField(time.Now(), gist.UpdatedAt, cs.Muted)
 		tp.EndRow()
 	}
 
diff --git a/pkg/cmd/gist/list/list_test.go b/pkg/cmd/gist/list/list_test.go
@@ -487,8 +487,8 @@ func Test_listRun(t *testing.T) {
 			},
 			wantOut: heredoc.Docf(`
 				%[1]s[0;4;39mID  %[1]s[0m  %[1]s[0;4;39mDESCRIPTION                  %[1]s[0m  %[1]s[0;4;39mFILES  %[1]s[0m  %[1]s[0;4;39mVISIBILITY%[1]s[0m  %[1]s[0;4;39mUPDATED          %[1]s[0m
-				1234  %[1]s[0;30;43mocto%[1]s[0m%[1]s[0;1;39m match in the description%[1]s[0m  1 file   %[1]s[0;32mpublic    %[1]s[0m  %[1]s[38;5;242mabout 6 hours ago%[1]s[m
-				2345  %[1]s[0;1;39mmatch in the file name       %[1]s[0m  %[1]s[0;30;43m2 files%[1]s[0m  %[1]s[0;31msecret    %[1]s[0m  %[1]s[38;5;242mabout 6 hours ago%[1]s[m
+				1234  %[1]s[0;30;43mocto%[1]s[0m%[1]s[0;1;39m match in the description%[1]s[0m  1 file   %[1]s[0;32mpublic    %[1]s[0m  %[1]s[38;5;242mabout 6 hours ago%[1]s[0m
+				2345  %[1]s[0;1;39mmatch in the file name       %[1]s[0m  %[1]s[0;30;43m2 files%[1]s[0m  %[1]s[0;31msecret    %[1]s[0m  %[1]s[38;5;242mabout 6 hours ago%[1]s[0m
 			`, "\x1b"),
 		},
 		{
@@ -694,7 +694,7 @@ func Test_highlightMatch(t *testing.T) {
 
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			cs := iostreams.NewColorScheme(tt.color, false, false, iostreams.NoTheme)
+			cs := iostreams.NewColorScheme(tt.color, false, false, false, iostreams.NoTheme)
 
 			matched := false
 			got, err := highlightMatch(tt.input, regex, &matched, cs.Blue, cs.Highlight)
diff --git a/pkg/cmd/gpg-key/list/list.go b/pkg/cmd/gpg-key/list/list.go
@@ -78,7 +78,7 @@ func listRun(opts *ListOptions) error {
 		t.AddField(gpgKey.Emails.String())
 		t.AddField(gpgKey.KeyID)
 		t.AddField(gpgKey.PublicKey, tableprinter.WithTruncate(truncateMiddle))
-		t.AddTimeField(now, gpgKey.CreatedAt, cs.Gray)
+		t.AddTimeField(now, gpgKey.CreatedAt, cs.Muted)
 		expiresAt := gpgKey.ExpiresAt.Format(time.RFC3339)
 		if t.IsTTY() {
 			if gpgKey.ExpiresAt.IsZero() {
@@ -87,7 +87,7 @@ func listRun(opts *ListOptions) error {
 				expiresAt = gpgKey.ExpiresAt.Format("2006-01-02")
 			}
 		}
-		t.AddField(expiresAt, tableprinter.WithColor(cs.Gray))
+		t.AddField(expiresAt, tableprinter.WithColor(cs.Muted))
 		t.EndRow()
 	}
 
diff --git a/pkg/cmd/pr/list/list.go b/pkg/cmd/pr/list/list.go
@@ -224,7 +224,7 @@ func listRun(opts *ListOptions) error {
 		if !isTTY {
 			table.AddField(shared.PrStateWithDraft(&pr))
 		}
-		table.AddTimeField(opts.Now(), pr.CreatedAt, cs.Gray)
+		table.AddTimeField(opts.Now(), pr.CreatedAt, cs.Muted)
 		table.EndRow()
 	}
 	err = table.Render()
diff --git a/pkg/cmd/release/list/list.go b/pkg/cmd/release/list/list.go
@@ -88,7 +88,7 @@ func listRun(opts *ListOptions) error {
 	}
 
 	table := tableprinter.New(opts.IO, tableprinter.WithHeader("Title", "Type", "Tag name", "Published"))
-	iofmt := opts.IO.ColorScheme()
+	cs := opts.IO.ColorScheme()
 	for _, rel := range releases {
 		title := text.RemoveExcessiveWhitespace(rel.Name)
 		if title == "" {
@@ -100,13 +100,13 @@ func listRun(opts *ListOptions) error {
 		var badgeColor func(string) string
 		if rel.IsLatest {
 			badge = "Latest"
-			badgeColor = iofmt.Green
+			badgeColor = cs.Green
 		} else if rel.IsDraft {
 			badge = "Draft"
-			badgeColor = iofmt.Red
+			badgeColor = cs.Red
 		} else if rel.IsPrerelease {
 			badge = "Pre-release"
-			badgeColor = iofmt.Yellow
+			badgeColor = cs.Yellow
 		}
 		table.AddField(badge, tableprinter.WithColor(badgeColor))
 
@@ -116,7 +116,7 @@ func listRun(opts *ListOptions) error {
 		if rel.PublishedAt.IsZero() {
 			pubDate = rel.CreatedAt
 		}
-		table.AddTimeField(time.Now(), pubDate, iofmt.Gray)
+		table.AddTimeField(time.Now(), pubDate, cs.Muted)
 		table.EndRow()
 	}
 	err = table.Render()
diff --git a/pkg/cmd/repo/deploy-key/list/list.go b/pkg/cmd/repo/deploy-key/list/list.go
@@ -90,7 +90,7 @@ func listRun(opts *ListOptions) error {
 		}
 		t.AddField(sshType)
 		t.AddField(deployKey.Key, tableprinter.WithTruncate(truncateMiddle))
-		t.AddTimeField(now, deployKey.CreatedAt, cs.Gray)
+		t.AddTimeField(now, deployKey.CreatedAt, cs.Muted)
 		t.EndRow()
 	}
 
diff --git a/pkg/cmd/repo/list/list.go b/pkg/cmd/repo/list/list.go
@@ -181,7 +181,7 @@ func listRun(opts *ListOptions) error {
 	totalMatchCount := len(listResult.Repositories)
 	for _, repo := range listResult.Repositories {
 		info := repoInfo(repo)
-		infoColor := cs.Gray
+		infoColor := cs.Muted
 
 		if repo.IsPrivate {
 			infoColor = cs.Yellow
@@ -195,7 +195,7 @@ func listRun(opts *ListOptions) error {
 		tp.AddField(repo.NameWithOwner, tableprinter.WithColor(cs.Bold))
 		tp.AddField(text.RemoveExcessiveWhitespace(repo.Description))
 		tp.AddField(info, tableprinter.WithColor(infoColor))
-		tp.AddTimeField(opts.Now(), *t, cs.Gray)
+		tp.AddTimeField(opts.Now(), *t, cs.Muted)
 		tp.EndRow()
 	}
 
diff --git a/pkg/cmd/run/list/list.go b/pkg/cmd/run/list/list.go
@@ -176,7 +176,7 @@ func listRun(opts *ListOptions) error {
 		tp.AddField(string(run.Event))
 		tp.AddField(fmt.Sprintf("%d", run.ID), tableprinter.WithColor(cs.Cyan))
 		tp.AddField(run.Duration(opts.now).String())
-		tp.AddTimeField(opts.now, run.StartedTime(), cs.Gray)
+		tp.AddTimeField(opts.now, run.StartedTime(), cs.Muted)
 		tp.EndRow()
 	}
 
diff --git a/pkg/cmd/ssh-key/list/list.go b/pkg/cmd/ssh-key/list/list.go
@@ -89,11 +89,11 @@ func listRun(opts *ListOptions) error {
 			t.AddField(id)
 			t.AddField(sshKey.Key, tableprinter.WithTruncate(truncateMiddle))
 			t.AddField(sshKey.Type)
-			t.AddTimeField(now, sshKey.CreatedAt, cs.Gray)
+			t.AddTimeField(now, sshKey.CreatedAt, cs.Muted)
 		} else {
 			t.AddField(sshKey.Title)
 			t.AddField(sshKey.Key)
-			t.AddTimeField(now, sshKey.CreatedAt, cs.Gray)
+			t.AddTimeField(now, sshKey.CreatedAt, cs.Muted)
 			t.AddField(id)
 			t.AddField(sshKey.Type)
 		}
diff --git a/pkg/iostreams/color.go b/pkg/iostreams/color.go
@@ -30,32 +30,36 @@ var (
 	greenBold             = ansi.ColorFunc("green+b")
 	highlightStart        = ansi.ColorCode(highlightStyle)
 	highlight             = ansi.ColorFunc(highlightStyle)
+	darkThemeMuted        = ansi.ColorFunc("white+d")
 	darkThemeTableHeader  = ansi.ColorFunc("white+du")
+	lightThemeMuted       = ansi.ColorFunc("black+h")
 	lightThemeTableHeader = ansi.ColorFunc("black+hu")
 	noThemeTableHeader    = ansi.ColorFunc("default+u")
 
 	gray256 = func(t string) string {
-		return fmt.Sprintf("\x1b[%d;5;%dm%s\x1b[m", 38, 242, t)
+		return fmt.Sprintf("\x1b[%d;5;%dm%s\x1b[0m", 38, 242, t)
 	}
 )
 
 // NewColorScheme initializes color logic based on provided terminal capabilities.
 // Logic dealing with terminal theme detected, such as whether color is enabled, 8-bit color supported, true color supported,
 // and terminal theme detected.
-func NewColorScheme(enabled, is256enabled, trueColor bool, theme string) *ColorScheme {
+func NewColorScheme(enabled, is256enabled, trueColor, accessibleColors bool, theme string) *ColorScheme {
 	return &ColorScheme{
-		enabled:      enabled,
-		is256enabled: is256enabled,
-		hasTrueColor: trueColor,
-		theme:        theme,
+		enabled:          enabled,
+		is256enabled:     is256enabled,
+		hasTrueColor:     trueColor,
+		accessibleColors: accessibleColors,
+		theme:            theme,
 	}
 }
 
 type ColorScheme struct {
-	enabled      bool
-	is256enabled bool
-	hasTrueColor bool
-	theme        string
+	enabled          bool
+	is256enabled     bool
+	hasTrueColor     bool
+	accessibleColors bool
+	theme            string
 }
 
 func (c *ColorScheme) Enabled() bool {
@@ -73,6 +77,31 @@ func (c *ColorScheme) Boldf(t string, args ...interface{}) string {
 	return c.Bold(fmt.Sprintf(t, args...))
 }
 
+func (c *ColorScheme) Muted(t string) string {
+	// Fallback to previous logic if accessible colors preview is disabled.
+	if !c.accessibleColors {
+		return c.Gray(t)
+	}
+
+	// Muted text is only stylized if color is enabled.
+	if !c.enabled {
+		return t
+	}
+
+	switch c.theme {
+	case LightTheme:
+		return lightThemeMuted(t)
+	case DarkTheme:
+		return darkThemeMuted(t)
+	default:
+		return t
+	}
+}
+
+func (c *ColorScheme) Mutedf(t string, args ...interface{}) string {
+	return c.Muted(fmt.Sprintf(t, args...))
+}
+
 func (c *ColorScheme) Red(t string) string {
 	if !c.enabled {
 		return t
@@ -113,6 +142,7 @@ func (c *ColorScheme) GreenBold(t string) string {
 	return greenBold(t)
 }
 
+// Use Muted instead for thematically contrasting color.
 func (c *ColorScheme) Gray(t string) string {
 	if !c.enabled {
 		return t
@@ -123,6 +153,7 @@ func (c *ColorScheme) Gray(t string) string {
 	return gray(t)
 }
 
+// Use Mutedf instead for thematically contrasting color.
 func (c *ColorScheme) Grayf(t string, args ...interface{}) string {
 	return c.Gray(fmt.Sprintf(t, args...))
 }
diff --git a/pkg/iostreams/color_test.go b/pkg/iostreams/color_test.go
diff --git a/pkg/iostreams/iostreams.go b/pkg/iostreams/iostreams.go

Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,7 @@ import (`
`19`	`19`	`"github.com/cli/cli/v2/pkg/cmd/extension"`
`20`	`20`	`"github.com/cli/cli/v2/pkg/cmdutil"`
`21`	`21`	`"github.com/cli/cli/v2/pkg/iostreams"`
	`22`	`+ xcolor "github.com/cli/go-gh/v2/pkg/x/color"`
`22`	`23`	`)`
`23`	`24`
`24`	`25`	`var ssoHeader string`
`@@ -292,6 +293,8 @@ func ioStreams(f cmdutil.Factory) iostreams.IOStreams {`
`292`	`293`	`io.SetPager(pager.Value)`
`293`	`294`	`}`
`294`	`295`
	`296`	`+ io.SetAccessibleColorsEnabled(xcolor.IsAccessibleColorsEnabled())`
	`297`	`+`
`295`	`298`	`return io`
`296`	`299`	`}`
`297`	`300`
Original file line number	Diff line number	Diff line change
`@@ -206,7 +206,7 @@ func printTable(io iostreams.IOStreams, gists []shared.Gist, filter regexp.Reg`
`206`	`206`	`tableprinter.WithColor(highlightFilesFunc(&gist)),`
`207`	`207`	`)`
`208`	`208`	`tp.AddField(visibility, tableprinter.WithColor(visColor))`
`209`		`- tp.AddTimeField(time.Now(), gist.UpdatedAt, cs.Gray)`
	`209`	`+ tp.AddTimeField(time.Now(), gist.UpdatedAt, cs.Muted)`
`210`	`210`	`tp.EndRow()`
`211`	`211`	`}`
`212`	`212`
Original file line number	Diff line number	Diff line change
`@@ -78,7 +78,7 @@ func listRun(opts *ListOptions) error {`
`78`	`78`	`t.AddField(gpgKey.Emails.String())`
`79`	`79`	`t.AddField(gpgKey.KeyID)`
`80`	`80`	`t.AddField(gpgKey.PublicKey, tableprinter.WithTruncate(truncateMiddle))`
`81`		`- t.AddTimeField(now, gpgKey.CreatedAt, cs.Gray)`
	`81`	`+ t.AddTimeField(now, gpgKey.CreatedAt, cs.Muted)`
`82`	`82`	`expiresAt := gpgKey.ExpiresAt.Format(time.RFC3339)`
`83`	`83`	`if t.IsTTY() {`
`84`	`84`	`if gpgKey.ExpiresAt.IsZero() {`
`@@ -87,7 +87,7 @@ func listRun(opts *ListOptions) error {`
`87`	`87`	`expiresAt = gpgKey.ExpiresAt.Format("2006-01-02")`
`88`	`88`	`}`
`89`	`89`	`}`
`90`		`- t.AddField(expiresAt, tableprinter.WithColor(cs.Gray))`
	`90`	`+ t.AddField(expiresAt, tableprinter.WithColor(cs.Muted))`
`91`	`91`	`t.EndRow()`
`92`	`92`	`}`
`93`	`93`
Original file line number	Diff line number	Diff line change
`@@ -224,7 +224,7 @@ func listRun(opts *ListOptions) error {`
`224`	`224`	`if !isTTY {`
`225`	`225`	`table.AddField(shared.PrStateWithDraft(&pr))`
`226`	`226`	`}`
`227`		`- table.AddTimeField(opts.Now(), pr.CreatedAt, cs.Gray)`
	`227`	`+ table.AddTimeField(opts.Now(), pr.CreatedAt, cs.Muted)`
`228`	`228`	`table.EndRow()`
`229`	`229`	`}`
`230`	`230`	`err = table.Render()`
Original file line number	Diff line number	Diff line change
`@@ -90,7 +90,7 @@ func listRun(opts *ListOptions) error {`
`90`	`90`	`}`
`91`	`91`	`t.AddField(sshType)`
`92`	`92`	`t.AddField(deployKey.Key, tableprinter.WithTruncate(truncateMiddle))`
`93`		`- t.AddTimeField(now, deployKey.CreatedAt, cs.Gray)`
	`93`	`+ t.AddTimeField(now, deployKey.CreatedAt, cs.Muted)`
`94`	`94`	`t.EndRow()`
`95`	`95`	`}`
`96`	`96`