feat: vcs, color, and message format native completion #15322

nooma-42 · 2025-03-18T08:34:25Z

What does this PR try to resolve?

Related to #14520

This PR introduces auto-completion for following options:

--color option with values: auto, always, never
--vcs option with values: git, hg, pijul, fossil, none
--message-format option with values: human, short, json, json-diagnostic-short, json-diagnostic-rendered

Take --color as an example, when a user types cargo build --color <TAB>the system will automatically suggest auto, always, never

How should we test and review this PR?

To verify this feature, follow these steps:

In the terminal, type cargo build --color <TAB> or cargo new my_project --vcs <TAB> or cargo check --message-format <TAB>
Press the TAB key.
You should see option suggestions

2025-03-18.4.29.14.mov

rustbot · 2025-03-18T08:34:29Z

r? @epage

rustbot has assigned @epage.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

src/cargo/util/command_prelude.rs

src/bin/cargo/commands/locate_project.rs

src/bin/cargo/commands/config.rs

src/bin/cargo/cli.rs

epage · 2025-03-19T12:04:52Z

Please keep commits atomic which includes test passing in each commit

weihanglo

It is unfortunate that --message-format in cargo build has too many possible values and couldn't fit in one line.

Anyway this PR on its own is good to merge. Thank you!

weihanglo · 2025-03-20T15:07:37Z

We could do a check-up for other places that might leverage possible values and delimiters API from clap

Update cargo 14 commits in 6cf8267012570f63d6b86e85a2ae5627de52df9e..307cbfda3119f06600e43cd38283f4a746fe1f8b 2025-03-14 15:25:36 +0000 to 2025-03-20 20:00:39 +0000 - feat: Add custom completer for cargo <TAB> to complete aliases defined in config.toml (rust-lang/cargo#15319) - fix(build-dir): Renamed workspace-manifest-path-hash to workspace-path-hash (rust-lang/cargo#15334) - feat: vcs, color, and message format native completion (rust-lang/cargo#15322) - Fix `[env]` `relative` description in reference (rust-lang/cargo#15332) - chore: fix some typos (rust-lang/cargo#15329) - Cleanup for rustc-link-arg-cdylib (rust-lang/cargo#15326) - fix(toml): Report '<target>.edition' deprecation to users (rust-lang/cargo#15321) - test(build-std): address overly-matched snapshot (rust-lang/cargo#15325) - Added `build.build_dir` templating support (rust-lang/cargo#15236) - docs: make it clearer that `rust_version` is enforced during compile (rust-lang/cargo#15303) - feat: Add custom completer for cargo +<TAB> to complete toolchain name (rust-lang/cargo#15301) - chore: fix some typos (rust-lang/cargo#15316) - fix: deduplicate crate types in cargo rustc command (rust-lang/cargo#15314) - docs: mention wrong URLs as a cause of git authentication errors (rust-lang/cargo#15304) r? ghost

rustbot assigned epage Mar 18, 2025

rustbot added A-cli Area: Command-line interface, option parsing, etc. Command-locate-project S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Mar 18, 2025