Update configuration support for accessible colors by andyfeller · Pull Request #10820 · cli/cli

andyfeller · 2025-04-17T20:03:27Z

Fixes github/cli#857

added support for accessible_colors configuration setting in gh config commandset
updated default configuration file to contain accessible_colors: disabled
add GH_ACCESSIBLE_COLORS env var to gh environment
generated mocks via go generate ./... including previously missed prompter changes

Acceptance Criteria

When user executes gh config
Then new accessible_colors configuration setting is stated as taking enabled or disabled as values with default of disabled
Given user executes gh config set accessible_colors enabled
When user executes gh config list
Then accessible_colors=enabled is presented
Given user executes gh config set accessible_colors enabled
And Given user has color enabled
When user executes gh repo view andyfeller/markdown-lorem-ipsum
Then user can customize all colored text from rendered markdown through terminal preferences

acceptance-criteria-3-gh-repo-view.mp4
Given user executes gh config set accessible_colors enabled
And Given user has color enabled
When user executes gh repo list
Then user can customize table header and date time columns through terminal preferences

acceptance-criteria-4-gh-repo-list.mp4
Given user executes gh config set accessible_colors enabled
And Given user has color enabled
When user executes gh reference
Then user can customize command headers and content through terminal preferences

acceptance-criteria-5-gh-reference.mp4
Given user has no GitHub CLI configuration file
When user executes gh for the first time
Then the default GitHub CLI configuration file includes accessible_colors=disabled
When user executes gh help environment
Then new GH_ACCESSIBLE_COLORS environment variable is presented

- added support for `accessible_colors` configuration setting in `gh config` commandset - updated default configuration file to contain `accessible_colors: disabled` - add `GH_ACCESSIBLE_COLORS` env var to `gh environment` - generated mocks via `go generate ./...` including previously missed prompter changes

Copilot

Pull Request Overview

This PR updates configuration support to include an accessible colors option for GitHub CLI. Key changes include:

Adding a new Accessible Colors setting in the help text and configuration.
Updating the default configuration file and test cases to include accessible_colors.
Extending mocks and configuration interfaces to support the accessible_colors setting.

Reviewed Changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
pkg/cmd/root/help_topic.go	Added help text for GH_ACCESSIBLE_COLORS with a preview note.
pkg/cmd/config/list/list_test.go	Updated test to include accessible_colors configuration.
internal/prompter/prompter_mock.go	Refactored parameter names for improved clarity in mock methods.
internal/gh/mock/config.go	Added AccessibleColors mock method and tracking.
internal/gh/gh.go	Extended Config interface to declare AccessibleColors.
internal/config/stub.go & internal/config/config.go	Integrated accessible_colors support in configuration handling.

internal/config/config.go

BagToad

LGTM! ✨ Just one suggestion about a code comment, but that's non-blocking and I'll leave that to you to consider accepting or not.

This MR contains the following updates: | Package | Update | Change | |---|---|---| | [cli/cli](https://github.com/cli/cli) | minor | `v2.69.0` -> `v2.72.0` | MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot). **Proposed changes to behavior should be submitted there as MRs.** --- ### Release Notes <details> <summary>cli/cli (cli/cli)</summary> ### [`v2.72.0`](https://github.com/cli/cli/releases/tag/v2.72.0): GitHub CLI 2.72.0 [Compare Source](cli/cli@v2.71.2...v2.72.0) ####

Accessibility public preview This release marks the public preview of several accessibility improvements to the GitHub CLI that have been under development over the past year in partnership with our friends at [Charm](https://github.com/charmbracelet) including: - customizable and contrasting colors - non-interactive user input prompting - text-based spinners These new experiences are captured in a new `gh a11y` help topic command, which goes into greater detail into the motivation behind each of them as well as opt-in configuration settings / environment variables. We would like you to share your feedback and join us on this journey through one of [GitHub Accessibility feedback channels](https://accessibility.github.com/feedback)! 🙌 #### What's Changed ##### ✨ Features - Introduce `gh accessibility` help topic highlighting GitHub CLI accessibility experiences by [@andyfeller](https://github.com/andyfeller) in cli/cli#10890 - \[gh pr view] Support `closingIssuesReferences` JSON field by [@iamazeem](https://github.com/iamazeem) in cli/cli#10544 ##### 🐛 Fixes - Fix expected error output of `TestRepo/repo-set-default` by [@aconsuegra](https://github.com/aconsuegra) in cli/cli#10884 - Ensure accessible password and auth token prompters disable echo mode by [@andyfeller](https://github.com/andyfeller) in cli/cli#10885 - Fix: Accessible multiselect prompt respects default selections by [@BagToad](https://github.com/BagToad) in cli/cli#10901 #### New Contributors - [@aconsuegra](https://github.com/aconsuegra) made their first contribution in cli/cli#10884 **Full Changelog**: cli/cli@v2.71.2...v2.72.0 ### [`v2.71.2`](https://github.com/cli/cli/releases/tag/v2.71.2): GitHub CLI 2.71.2 [Compare Source](cli/cli@v2.71.1...v2.71.2) #### What's Changed - Fix pr create when push.default tracking and no merge ref by [@williammartin](https://github.com/williammartin) in cli/cli#10863 **Full Changelog**: cli/cli@v2.71.1...v2.71.2 ### [`v2.71.1`](https://github.com/cli/cli/releases/tag/v2.71.1): GitHub CLI 2.71.1 [Compare Source](cli/cli@v2.71.0...v2.71.1) #### What's Changed - Fix pr create when branch name contains slashes by [@williammartin](https://github.com/williammartin) in cli/cli#10859 **Full Changelog**: cli/cli@v2.71.0...v2.71.1 ### [`v2.71.0`](https://github.com/cli/cli/releases/tag/v2.71.0): GitHub CLI 2.71.0 [Compare Source](cli/cli@v2.70.0...v2.71.0) #### What's Changed ##### ✨ Features - `gh pr create`: Support Git's `@{push}` revision syntax for determining head ref by [@BagToad](https://github.com/BagToad) in cli/cli#10513 - Introduce option to opt-out of spinners by [@BagToad](https://github.com/BagToad) in cli/cli#10773 - Update configuration support for accessible colors by [@andyfeller](https://github.com/andyfeller) in cli/cli#10820 - `gh config`: add config settings for accessible prompter and disabling spinner by [@BagToad](https://github.com/BagToad) in cli/cli#10846 ##### 🐛 Fixes - Fix multi pages search for gh search by [@leudz](https://github.com/leudz) in cli/cli#10767 - Fix: `project` commands use shared progress indicator by [@BagToad](https://github.com/BagToad) in cli/cli#10817 - Issue commands should parse args early by [@williammartin](https://github.com/williammartin) in cli/cli#10811 - Feature detect v1 projects on `issue view` by [@williammartin](https://github.com/williammartin) in cli/cli#10813 - Feature detect v1 projects on non web-mode `issue create` by [@williammartin](https://github.com/williammartin) in cli/cli#10815 - Feature detect v1 projects on web mode issue create by [@williammartin](https://github.com/williammartin) in cli/cli#10818 - Feature detect v1 projects on issue edit by [@williammartin](https://github.com/williammartin) in cli/cli#10819 ##### 📚 Docs & Chores - Refactor Sigstore verifier logic by [@malancas](https://github.com/malancas) in cli/cli#10750 #####

Dependencies - chore(deps): bump github.com/sigstore/sigstore-go from 0.7.1 to 0.7.2 by [@dependabot](https://github.com/dependabot) in cli/cli#10787 - Bump google.golang.org/grpc from 1.71.0 to 1.71.1 by [@dependabot](https://github.com/dependabot) in cli/cli#10758 #### New Contributors - [@leudz](https://github.com/leudz) made their first contribution in cli/cli#10767 **Full Changelog**: cli/cli@v2.70.0...v2.71.0 ### [`v2.70.0`](https://github.com/cli/cli/releases/tag/v2.70.0): GitHub CLI 2.70.0 [Compare Source](cli/cli@v2.69.0...v2.70.0) #### Accessibility This release contains dark shipped changes that are part of a larger GitHub CLI accessibility preview still under development. More information about these will be announced later this month including various channels to work with GitHub and GitHub CLI maintainers on shaping these experiences. ##### Ensure table headers are thematically contrasting [#8292](cli/cli#8292) is a long time issue where table headers were difficult to see in terminals with light background. Ahead of the aforementioned preview, `v2.70.0` has shipped changes that improve the out-of-the-box experience based on terminal background detection. The following screenshots demonstrate the Mac Terminal using the Basic profile, which responds to user's appearance preferences: <img width="1512" alt="Screenshot of gh repo list in light background terminal" src="https://github.com/user-attachments/assets/87413dde-eec8-43eb-9c16-dc84f8249ddf" /> <img width="1512" alt="Screenshot of gh repo list in dark background terminal" src="https://github.com/user-attachments/assets/7430b42c-7267-402b-b565-a296beb4d5ea" /> For more information including demos from various official distributions, see [#10649](cli/cli#10649). #### What's Changed ##### ✨ Features - Update go-gh and document available sprig funcs by [@BagToad](https://github.com/BagToad) in cli/cli#10680 - Introducing experimental support for rendering markdown with customizable, accessible colors by [@andyfeller](https://github.com/andyfeller) [@jtmcg](https://github.com/jtmcg) in cli/cli#10680 - Ensure table datetime columns have thematic, customizable muted text by [@andyfeller](https://github.com/andyfeller) in cli/cli#10709 - Ensure table headers are thematically contrasting by [@andyfeller](https://github.com/andyfeller) in cli/cli#10649 - Introduce configuration setting for displaying issue and pull request labels in rich truecolor by [@andyfeller](https://github.com/andyfeller) in cli/cli#10720 - Ensure muted text is thematic and customizable by [@andyfeller](https://github.com/andyfeller) in cli/cli#10737 - \[gh repo create] Show host name in repo creation prompts by [@iamazeem](https://github.com/iamazeem) in cli/cli#10516 - Introduce accessible prompter for screen readers (preview) by [@BagToad](https://github.com/BagToad) in cli/cli#10710 ##### 🐛 Fixes - `run list`: do not fail on organization/enterprise ruleset imposed workflows by [@BagToad](https://github.com/BagToad) in cli/cli#10660 - Implement safeguard for `gh alias delete` test, prevent wiping out GitHub CLI configuration by [@andyfeller](https://github.com/andyfeller) in cli/cli#10683 - Pin third party actions to commit sha by [@BagToad](https://github.com/BagToad) in cli/cli#10731 - Fallback to job run logs when step logs are missing by [@babakks](https://github.com/babakks) in cli/cli#10740 - \[gh ext] Fix `GitKind` extension directory path by [@iamazeem](https://github.com/iamazeem) in cli/cli#10609 - Fix job log resolution to skip legacy logs in favour of normal/new ones by [@babakks](https://github.com/babakks) in cli/cli#10769 ##### 📚 Docs & Chores - `./script/sign` cleanup by [@iamazeem](https://github.com/iamazeem) in cli/cli#10599 - Fix typos in CONTRIBUTING.md by [@rylwin](https://github.com/rylwin) in cli/cli#10657 - Improve `gh at verify --help`, document json output by [@phillmv](https://github.com/phillmv) in cli/cli#10685 - Acceptance test issue/pr create/edit with project by [@williammartin](https://github.com/williammartin) in cli/cli#10707 - Escape dots in regexp pattern in `README.md` by [@babakks](https://github.com/babakks) in cli/cli#10742 - Simplify cosign verification example by not using a regex. by [@kommendorkapten](https://github.com/kommendorkapten) in cli/cli#10759 - Document UNKNOWN STEP in run view by [@williammartin](https://github.com/williammartin) in cli/cli#10770 #####

Dependencies - Update github.com/sigstore/sigstore-go to 0.7.1 and fix breaking function change by [@malancas](https://github.com/malancas) in cli/cli#10749 #### New Contributors - [@rylwin](https://github.com/rylwin) made their first contribution in cli/cli#10657 **Full Changelog**: cli/cli@v2.69.0...v2.70.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this MR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).

Copilot AI review requested due to automatic review settings April 17, 2025 20:03

andyfeller requested a review from a team as a code owner April 17, 2025 20:03

andyfeller requested a review from babakks April 17, 2025 20:03

andyfeller temporarily deployed to cli-automation April 17, 2025 20:03 — with GitHub Actions Inactive

cliAutomation assigned andyfeller Apr 17, 2025

Copilot AI reviewed Apr 17, 2025

View reviewed changes

BagToad self-requested a review April 21, 2025 15:10

BagToad reviewed Apr 21, 2025

View reviewed changes

internal/config/config.go Outdated Show resolved Hide resolved

BagToad approved these changes Apr 21, 2025

View reviewed changes

andyfeller added 2 commits April 21, 2025 14:04

PR feedback to improve config settings docs

486c589

Fix comment typo

ac95196

andyfeller merged commit e06a368 into trunk Apr 21, 2025
16 checks passed

andyfeller deleted the andyfeller/accessible-colors-config branch April 21, 2025 18:20

graelo mentioned this pull request Feb 7, 2026

Idea for improving visibility of labels #10400

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update configuration support for accessible colors#10820

Update configuration support for accessible colors#10820
andyfeller merged 3 commits intotrunkfrom
andyfeller/accessible-colors-config

andyfeller commented Apr 17, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

BagToad left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Comments

Conversation

andyfeller commented Apr 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Acceptance Criteria

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

BagToad left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Comments

andyfeller commented Apr 17, 2025 •

edited

Loading