Skip to content

Conversation

@shenxianpeng
Copy link
Contributor

@shenxianpeng shenxianpeng commented Dec 29, 2025

Add --color never flag to the cargo tree command to fix garbled characters like m├───⣿[0m to appear in the dependency names.

Summary by CodeRabbit

  • Chores
    • Updated output configuration to ensure consistent formatting in generated documentation files.

✏️ Tip: You can customize this high-level summary in your review settings.

@shenxianpeng shenxianpeng added the bug Something isn't working label Dec 29, 2025
@shenxianpeng
Copy link
Contributor Author

Before

image

After

image

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 29, 2025

Walkthrough

Modified docs/license_gen.py to add --color never flag to the cargo tree invocation in TreeGetter.__init__, disabling colored output. No behavior changes or modifications to control flow or output parsing logic.

Changes

Cohort / File(s) Summary
Command-line argument modification
docs/license_gen.py
Added --color and never arguments to cargo tree invocation, disabling colored output in command execution

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: adding a --color never flag to prevent garbled characters in output.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix-mess-characters

📜 Recent review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cbe77a2 and 83fb12a.

📒 Files selected for processing (1)
  • docs/license_gen.py
🔇 Additional comments (1)
docs/license_gen.py (1)

53-54: LGTM! This correctly prevents ANSI escape codes in the output.

The addition of --color never properly disables colored output from cargo tree, which eliminates the garbled characters (e.g., m├───⣿[0m) mentioned in the PR description. The flag is correctly placed as separate list elements in the args array, and cargo tree natively supports this syntax.

Minor note: The commit message mentions --no-color, but the implementation correctly uses --color never, which is the standard form for cargo tools.


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 and usage tips.

@shenxianpeng
Copy link
Contributor Author

@2bndy5 sorry, I made another change 38ab160 to update the contributing guide, but forgot to check out a branch : (

Copy link
Collaborator

@2bndy5 2bndy5 left a comment

Choose a reason for hiding this comment

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

I thought I was using an env var to resolve this, but this makes sense.

@2bndy5
Copy link
Collaborator

2bndy5 commented Dec 29, 2025

@2bndy5 sorry, I made another change 38ab160 to update the contributing guide, but forgot to check out a branch : (

All good. Its is accurate and uses a conventional commit title. 🚀💯 Thanks!

@shenxianpeng shenxianpeng merged commit 36317f7 into main Dec 29, 2025
12 checks passed
@shenxianpeng shenxianpeng deleted the fix-mess-characters branch December 29, 2025 18:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants