feat(tree): Control --charset via auto-detecting config value
#13337
Conversation
|
r? @weihanglo (rustbot has picked a reviewer for you, use r? to override) |
rustbot
added
A-cli
src/doc/src/reference/config.md
Outdated
| #### `term.charset` | ||
| * Type: string | ||
| * Default: auto-detect | ||
| * Environment: `CARGO_TERM_CHARSET` | ||
|
|
||
| Sets what characters can be used when rendering cargo output. Possible values: | ||
|
|
||
| * `utf8`: Use the full set of UTF-8 characters for drawing | ||
| * `ascii`: Only use 7-bit ASCII characters for drawing |
There was a problem hiding this comment.
My main concern is the future possibilities. If we later add emoji or devicon fonts, how would we represent this? A separate field, hierarchical values, or a list?
There was a problem hiding this comment.
One possible way: default to "auto" (I sympathize this word after cargo meeting today), and remove the utf8 option. This could maximize our future compatibility.
There was a problem hiding this comment.
The downside is that doesn't allow forcing of utf8 if our auto is being overly selective. Granted, maybe thats not too bad for now? It would mean we'd need separate enums for config from internal / CLI to support cargo tree --charset utf8.
Thoughts?
There was a problem hiding this comment.
Do we have any incoming feature going to use Unicode tables? If not, I feel like stabilizing fewer things buys us more time to deal with future changes.
BTW, I was about to convince myself an “auto” option is more aligned to other term configs, until I saw term.hyperlinks.
It would mean we'd need separate enums for config from internal / CLI to support cargo tree --charset utf8.
Yeah. Sounds like it 😞.
There was a problem hiding this comment.
Yes, there isn't something using this yet. Overall, this is part of a slow roll out of features to unblock user control over more complex progress bars so we have cleaner command output.
I also don't see us evaluating devicons any time soon. Emoji is hit or miss. I don't see an immediate use of it but personally not a big emoji person.
Maybe we can at least hold off on this until I get a little further into the progress bar implementation research? That way if emoji somehow looks useful in that time we re-evaluate?
There was a problem hiding this comment.
I just re-worked this PR to instead have a term.unicode field. This would allow us to add more fields in the future like term.emoji without worrying about the specifics of what we might need in the future.
Thoughts?
src/doc/src/reference/config.md
Outdated
| #### `term.charset` | ||
| * Type: string | ||
| * Default: auto-detect | ||
| * Environment: `CARGO_TERM_CHARSET` | ||
|
|
||
| Sets what characters can be used when rendering cargo output. Possible values: | ||
|
|
||
| * `utf8`: Use the full set of UTF-8 characters for drawing | ||
| * `ascii`: Only use 7-bit ASCII characters for drawing |
There was a problem hiding this comment.
One possible way: default to "auto" (I sympathize this word after cargo meeting today), and remove the utf8 option. This could maximize our future compatibility.
|
☔ The latest upstream changes (presumably #13463) made this pull request unmergeable. Please resolve the merge conflicts. |
This is preparation for rust-lang#13337 and covers hot spots I found as well as areas currently covered by `profile::start(...)`. This is split out to avoid conflicts while working through the remaining issues for rust-lang#13337. Maybe it will also serve to help debugging...
|
@rfcbot fcp merge This adds a new config field,
|
|
Team member @epage has proposed to merge this. The next step is review by the rest of the tagged team members: No concerns currently listed. Once a majority of reviewers approve (and at most 2 approvals are outstanding), this will enter its final comment period. If you spot a major issue that hasn't been raised at any point in this process, please speak up! See this document for info about what commands tagged team members can give me. |
rfcbot
added
the
proposed-final-comment-period
rfcbot
added
final-comment-period
|
🔔 This is now entering its final comment period, as per the review above. 🔔 |
|
I don't think this needs a full 10-day FCP. Merge this now. @bors r+ |
bors
added
S-waiting-on-bors
|
☀️ Test successful - checks-actions |
Update cargo 6 commits in 7065f0ef4aa267a7455e1c478b5ccacb7baea59c..2fe739fcf16c5bf8c2064ab9d357f4a0e6c8539b 2024-03-12 13:25:15 +0000 to 2024-03-15 21:39:18 +0000 - feat: Add 'open-namespaces' feature (rust-lang/cargo#13591) - refactor: Expose source/spans to Manifest for emitting lints (rust-lang/cargo#13593) - feat(tree): Control `--charset` via auto-detecting config value (rust-lang/cargo#13337) - refactor(toml): Flatten manifest parsing (rust-lang/cargo#13589) - fix: strip feature dep when dep is dev dep (rust-lang/cargo#13518) - fix(ci): bump check error when PR is behind master (rust-lang/cargo#13581) r? ghost
rfcbot
added
finished-final-comment-period
What does this PR try to resolve?
This tries to generalize
cargo tree --charsetso any part of cargo's output can use it. For example,cargo searchcould use this for fancier tablescargo addcould use this for fancier feature listsThis builds on the idea from #12889 that we can use fancier terminal features so long as we have good auto-detection and provide users an escape hatch until the auto-detection is improved or in case they disagree.
As a side benefit
cargo treewill auto-detect when the prior default of--charset utf8is a good choicecargo tree --charsetvia.cargo/config.tomlHow should we test and review this PR?
This is gradually introduced through the individual commits.
Additional information