Skip to content

feat: migrate color.cmd() to color.command() - part 1 #3485

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.

Sign up for GitHub

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

Jump to bottom
Merged
eablack merged 5 commits into from
Jan 23, 2026
Merged

feat: migrate color.cmd() to color.command() - part 1 #3485

eablack merged 5 commits into from
Jan 23, 2026

Conversation

@eablack
Copy link
Contributor

@eablack eablack commented Jan 23, 2026 •
edited
Loading

Summary

This PR migrates from color.cmd() to color.command() for CLI command references in user-facing messages. This is part 1 of the command migration (PR 14) in the systematic migration from @heroku-cli/color to @heroku/heroku-cli-util with semantic color functions.

This PR focuses on files that were already using @heroku/heroku-cli-util or had straightforward migrations. Additional PRs will follow for the remaining changes.

Changes Made

  • Replace color.cmd() with color.command() for command examples in messages
  • Replace color.cmd() with color.code() for code snippets that aren't commands
  • Update imports from @heroku-cli/color to @heroku/heroku-cli-util

Test Files:

  • test/unit/commands/container/push.unit.test.ts
  • test/unit/commands/container/release.unit.test.ts

Type of Change

Breaking Changes (major semver update)

  • Add a ! after your change type to denote a change that breaks current behavior

Feature Additions (minor semver update)

  • feat: Introduces a new feature to the codebase

Patch Updates (patch semver update)

  • fix: Bug fix
  • perf: Performance improvement
  • deps: Dependency upgrade
  • revert: Revert a previous commit
  • docs: Documentation change
  • style: Styling update
  • chore: Change that does not affect production code
  • refactor: Refactoring existing code without changing behavior
  • tests: Add/update/remove tests
  • build: Change to the build system
  • ci: Continuous integration workflow update

Testing

Notes:
This PR updates command reference formatting in user-facing messages. The color.command() function displays commands with a white-on-gray background and bold text for better visibility.

Steps:

  1. Build completes successfully ✅
  2. Manual testing of affected commands to verify command examples display correctly
  3. Verify code snippets use color.code() appropriately
  4. Passing CI suffices for regression testing

Related Issues

https://gus.lightning.force.com/lightning/r/ADM_Work__c/a07EE00002T2hvTYAR/view

@eablack eablack requested a review from a team as a code owner January 23, 2026 01:00
@eablack eablack changed the base branch from main to v11.0.0 January 23, 2026 01:00
@eablack eablack temporarily deployed to AcceptanceTests January 23, 2026 01:13 — with GitHub Actions Inactive
@eablack eablack temporarily deployed to AcceptanceTests January 23, 2026 01:13 — with GitHub Actions Inactive
@eablack eablack temporarily deployed to AcceptanceTests January 23, 2026 01:13 — with GitHub Actions Inactive
@eablack eablack temporarily deployed to AcceptanceTests January 23, 2026 01:13 — with GitHub Actions Inactive
@eablack eablack temporarily deployed to AcceptanceTests January 23, 2026 16:59 — with GitHub Actions Inactive
@eablack eablack temporarily deployed to AcceptanceTests January 23, 2026 16:59 — with GitHub Actions Inactive
@eablack eablack temporarily deployed to AcceptanceTests January 23, 2026 16:59 — with GitHub Actions Inactive
@eablack eablack temporarily deployed to AcceptanceTests January 23, 2026 16:59 — with GitHub Actions Inactive
@eablack eablack temporarily deployed to AcceptanceTests January 23, 2026 17:28 — with GitHub Actions Inactive
@eablack eablack temporarily deployed to AcceptanceTests January 23, 2026 17:28 — with GitHub Actions Inactive
@eablack eablack temporarily deployed to AcceptanceTests January 23, 2026 17:28 — with GitHub Actions Inactive
@eablack eablack temporarily deployed to AcceptanceTests January 23, 2026 17:28 — with GitHub Actions Inactive
tlowrimore-heroku
tlowrimore-heroku approved these changes Jan 23, 2026
View reviewed changes
Copy link
Contributor

@tlowrimore-heroku tlowrimore-heroku left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@eablack eablack temporarily deployed to AcceptanceTests January 23, 2026 18:37 — with GitHub Actions Inactive
@eablack eablack temporarily deployed to AcceptanceTests January 23, 2026 18:37 — with GitHub Actions Inactive
@eablack eablack temporarily deployed to AcceptanceTests January 23, 2026 18:37 — with GitHub Actions Inactive
@eablack eablack temporarily deployed to AcceptanceTests January 23, 2026 18:37 — with GitHub Actions Inactive
@eablack
feat: migrate color.cmd() to color.command() - part 1
82681b4 
This PR migrates from color.cmd() to color.command() for CLI
command references in user-facing messages.

Changes:
- Replace color.cmd() with color.command() for command examples
- Replace color.cmd() with color.code() for code snippets (non-commands)
- Update imports from @heroku-cli/color to @heroku/heroku-cli-util
- Replace color.configVar() with color.code() for config variable names

Files updated (27 total):
- commands/accounts/current.ts - Auth token command examples
- commands/apps/stacks/set.ts - Stack migration commands
- commands/auth/token.ts - Token display commands
- commands/certs/index.ts - Certificate management commands
- commands/container/* (pull, push, release, rm, run) - Container commands
- commands/domains/add.ts, commands/domains/index.ts - Domain commands
- commands/pg/backups/capture.ts - Backup commands
- commands/ps/restart.ts, commands/ps/stop.ts - Process commands
- commands/releases/retry.ts - Release commands
- commands/run/detached.ts - Run commands
- commands/spaces/create.ts, commands/spaces/vpn/connect.ts - Space commands
- commands/teams/index.ts - Team commands
- lib/addons/create_addon.ts, lib/addons/destroy_addon.ts - Addon commands
- lib/container/helpers.ts - Container helper commands
- lib/pg/backups.ts, lib/pg/push_pull.ts, lib/pg/util.ts - PG commands
- test/unit/commands/container/push.unit.test.ts - Test updates
- test/unit/commands/container/release.unit.test.ts - Test updates
@eablack
fix current account output and push test
6d71f54
@eablack
fix test
92afe11
@eablack
fix test with correct color import
2a6bd67
@eablack
fix test
b0a445b
@eablack eablack force-pushed the eb/color-migration-command branch from 67f1205 to b0a445b Compare January 23, 2026 18:37
@eablack eablack temporarily deployed to AcceptanceTests January 23, 2026 18:38 — with GitHub Actions Inactive
@eablack eablack temporarily deployed to AcceptanceTests January 23, 2026 18:38 — with GitHub Actions Inactive
@eablack eablack temporarily deployed to AcceptanceTests January 23, 2026 18:38 — with GitHub Actions Inactive
@eablack eablack temporarily deployed to AcceptanceTests January 23, 2026 18:38 — with GitHub Actions Inactive
@eablack eablack merged commit 96ee048 into v11.0.0 Jan 23, 2026
13 checks passed
@eablack eablack deleted the eb/color-migration-command branch January 23, 2026 19:00
This was referenced Jan 23, 2026
Merged
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@tlowrimore-heroku tlowrimore-heroku tlowrimore-heroku approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@eablack @tlowrimore-heroku