-
Notifications
You must be signed in to change notification settings - Fork 234
feat: migrate static examples to use color.command() - part 4 (final) #3493
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+330
−281
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is the final batch of command files being migrated to use the semantic color.command() function in their static example/examples properties. This completes the command examples migration across the entire codebase. Changes: - Updated 29 command files to wrap CLI command examples with color.command() - Added color imports where missing - Fixed nested quote issues in addons/index and telemetry/add - Fixed heredoc issues in various files Files updated: - accounts/* (5 files: add, current, index, remove, set) - addons/* (4 files: create, destroy, index, upgrade) - apps/leave.ts - domains/* (4 files: add, clear, remove, update) - drains/remove.ts - logs.ts - pg/upgrade/* (2 files: run, wait) - releases/* (2 files: index, retry) - run/inside.ts - spaces/peerings/destroy.ts - spaces/rename.ts - spaces/vpn/* (3 files: config, connections, info, update) - telemetry/* (2 files: add, update) This completes the migration of all 118 command files with static examples to use the new semantic color.command() function.
84b8f34 to
2233479
Compare
k80bowman
requested changes
Jan 27, 2026
Contributor
k80bowman
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a couple of questions and comments.
Co-authored-by: Katy Bowman <katy.bowman@salesforce.com> Signed-off-by: Eric <eablack@gmail.com>
k80bowman
approved these changes
Jan 27, 2026
Contributor
k80bowman
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great! Thanks for all the fixes!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR is the final batch of the migration to use semantic
color.command()for CLI command examples in static example/examples properties. This completes the command examples migration from@heroku-cli/colorto@heroku/heroku-cli-utilacross the entire codebase.Updates 29 command files to wrap CLI command examples with
color.command()using template literals, enabling semantic coloring of command examples in help text.This PR completes the migration of all 118 command files with static examples.
Changes
exampleandexamplesproperties to use${color.command('...')}patterncolorimports to files that were missing themaddons/index.tsandtelemetry/add.tsType of Change
Feature Additions (minor semver update)
Testing
Notes:
This change affects how command examples are displayed in help text, using semantic color functions instead of direct strings. This is the final part of a 4-part migration.
Steps:
color.command()functionRelated Issues
Part of the ongoing color system migration to
@heroku/heroku-cli-util.Related to PR #3488 (part 1), PR #3490 (part 2), PR #3491 (part 3), and PR #3485 (command color migration).
This PR completes the command examples migration across all 118 files.