Skip to content

Conversation

@eablack
Copy link
Contributor

@eablack eablack commented Jan 26, 2026

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/color to @heroku/heroku-cli-util across 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

  • Updated static example and examples properties to use ${color.command('...')} pattern
  • Added color imports to files that were missing them
  • Fixed nested quote issues in addons/index.ts and telemetry/add.ts
  • Fixed template literal syntax issues in various files

Type of Change

Feature Additions (minor semver update)

  • feat: Introduces a new feature to the codebase

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:

  1. Build passes successfully (npm run build)
  2. Help text for updated commands displays correctly with color formatting
  3. Examples use the new semantic color.command() function

Related 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.

@eablack eablack requested a review from a team as a code owner January 26, 2026 20:23
@eablack eablack temporarily deployed to AcceptanceTests January 26, 2026 21:03 — with GitHub Actions Inactive
@eablack eablack temporarily deployed to AcceptanceTests January 26, 2026 21:03 — with GitHub Actions Inactive
@eablack eablack temporarily deployed to AcceptanceTests January 26, 2026 21:03 — with GitHub Actions Inactive
@eablack eablack temporarily deployed to AcceptanceTests January 26, 2026 21:03 — with GitHub Actions Inactive
@eablack eablack temporarily deployed to AcceptanceTests January 26, 2026 22:10 — with GitHub Actions Inactive
@eablack eablack temporarily deployed to AcceptanceTests January 26, 2026 22:10 — with GitHub Actions Inactive
@eablack eablack temporarily deployed to AcceptanceTests January 26, 2026 22:10 — with GitHub Actions Inactive
@eablack eablack temporarily deployed to AcceptanceTests January 26, 2026 22:10 — with GitHub Actions Inactive
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.
@eablack eablack force-pushed the eb/color-migration-command-examples-4 branch from 84b8f34 to 2233479 Compare January 26, 2026 22:22
@eablack eablack temporarily deployed to AcceptanceTests January 26, 2026 22:22 — with GitHub Actions Inactive
@eablack eablack temporarily deployed to AcceptanceTests January 26, 2026 22:22 — with GitHub Actions Inactive
@eablack eablack temporarily deployed to AcceptanceTests January 26, 2026 22:22 — with GitHub Actions Inactive
@eablack eablack temporarily deployed to AcceptanceTests January 26, 2026 22:22 — with GitHub Actions Inactive
Copy link
Contributor

@k80bowman k80bowman left a 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>
@eablack eablack temporarily deployed to AcceptanceTests January 27, 2026 17:24 — with GitHub Actions Inactive
Copy link
Contributor

@k80bowman k80bowman left a 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!

@eablack eablack merged commit cde20ed into v11.0.0 Jan 27, 2026
13 checks passed
@eablack eablack deleted the eb/color-migration-command-examples-4 branch January 27, 2026 18:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants