Skip to content

feat: colorize CLI help output#22

Merged
chenjiahan merged 4 commits into
mainfrom
chenjiahan/feat-help-colors
Jul 11, 2026
Merged

feat: colorize CLI help output#22
chenjiahan merged 4 commits into
mainfrom
chenjiahan/feat-help-colors

Conversation

@chenjiahan

Copy link
Copy Markdown
Member

This PR improves the visual hierarchy of CLI help output to make sections and usage examples easier to scan. It uses rslog colors for rs --help and rs staged -h, while preserving plain output when colors are unavailable. ANSI regression coverage is included for both help paths.

@coderabbitai

coderabbitai Bot commented Jul 10, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@chenjiahan, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 33 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: d75bd74d-34f3-45c8-b301-5131f3f2c0c5

📥 Commits

Reviewing files that changed from the base of the PR and between 9b2706d and 6399da0.

📒 Files selected for processing (1)
  • packages/rstack/rstack.config.ts
📝 Walkthrough

Walkthrough

CLI help formatting now uses rslog color helpers for the main and staged commands. Tests were updated to strip ANSI sequences for plain assertions and to verify colorized output when FORCE_COLOR=1 is enabled.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely summarizes the main change: colorizing CLI help output.
Description check ✅ Passed The description accurately matches the changes, including colorized help for both CLI paths and ANSI regression coverage.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chenjiahan/feat-help-colors

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@chenjiahan chenjiahan merged commit ca764e3 into main Jul 11, 2026
4 checks passed
@chenjiahan chenjiahan deleted the chenjiahan/feat-help-colors branch July 11, 2026 00:56

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 6399da030c

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

},
define.test(() => {
// Disable color in test
process.env.NO_COLOR = '1';

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Clear FORCE_COLOR when disabling test colors

In environments that already export FORCE_COLOR=1, setting only NO_COLOR does not actually disable the new rslog color calls because Node's util.styleText gives FORCE_COLOR precedence. Since the CLI test helper inherits process.env into spawned rs processes, those help commands still emit ANSI escapes and the existing plain substring assertions such as Usage:\n $ rs staged [options] fail; clear FORCE_COLOR as well or strip ANSI in the assertions.

Useful? React with 👍 / 👎.

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.

1 participant