feat(cli): Add support for completing `--config` values in Bash by nspin · Pull Request #16245 · rust-lang/cargo

nspin · 2025-11-12T09:23:24Z

What does this PR try to resolve?

Currently, cargo.bashcomp.sh doesn't support completing the --config flag, let alone its value. This PR adds support for completing both the --config flag and a _filedir value for it. This support includes both cases where it appears before the cargo subcommand, and cases where it appears after. In the process of implementing the former, I also added support for completing values for --color before the cargo subcommand. Currently, completing values for --color is only supported after the cargo subcommand.

How to test and review this PR?

In a Bash shell, run:

source src/etc/cargo.bashcomp.sh

Then, observe that the following completions behave as expected:

cargo --co<tab>
cargo --config <tab>
cargo --color <tab>
cargo build --co<tab>
cargo build --config <tab>

Adds support for completing --config values with _filedir, but only when they appear after the cargo subcommand.

rustbot · 2025-11-12T09:23: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

epage · 2025-11-12T14:46:42Z

The first commit, I would be fine merging immediately. The second commit, I don't quite feel qualified to review. If you want to split this PR, then we can get that first commit merged.

Note: overall our focused has shifted towards stabilizing https://doc.rust-lang.org/nightly/cargo/reference/unstable.html#native-completions

nspin · 2025-11-13T00:34:10Z

The first commit, I would be fine merging immediately. The second commit, I don't quite feel qualified to review. If you want to split this PR, then we can get that first commit merged.

I've removed the second commit from this PR, leaving only the first.

The second commit depends on the first, so I'll open that PR after this is merged.

Note: overall our focused has shifted towards stabilizing https://doc.rust-lang.org/nightly/cargo/reference/unstable.html#native-completions

Thanks for the heads up, I'll look into adding this feature over there too.

weihanglo

Thanks!

View changes since this review

nspin · 2025-11-13T01:00:31Z

I've opened #16249, which adds this feature for native-completions.

Update cargo submodule 13 commits in 2d4fa139552ebdd5f091a1401ed03f7dc62cb43f..5c0343317ce45d2ec17ecf41eaa473a02d73e29c 2025-11-12 15:56:06 +0000 to 2025-11-18 19:05:44 +0000 - feat: emit a warning when both `package.publish` and `--index` are specified (rust-lang/cargo#16268) - docs(cargo-yank): clarify yank behavior with leaked credentials (rust-lang/cargo#16274) - feat(generate-lockfile): Add unstable --publish-time flag (rust-lang/cargo#16265) - Do not lock the artifact-dir for check builds (rust-lang/cargo#16230) - fix(fingerprint): force update mtime of cargo-check artifacts (rust-lang/cargo#16262) - fix(manifest): Point out when a key belongs to config (rust-lang/cargo#16256) - Use raw false during cfg test (rust-lang/cargo#16261) - Suppress metadata warnings for non–crates.io publishable packages (rust-lang/cargo#16241) - feat(tree): Support long forms for --format variables (rust-lang/cargo#16204) - fix(config): Fallback to non-canonical path for workspace-path-hash (rust-lang/cargo#16248) - fix: update mtime for generated files after unpacking (rust-lang/cargo#16250) - feat(cli): Add support for completing `--config` values in Bash (rust-lang/cargo#16245) - feat: Add a typos CI job (rust-lang/cargo#16122)

### What does this PR try to resolve? Split from #16245 (see #16245 (comment)). Currently, `cargo.bashcomp.sh` supports completing values for `--color` and `--config` only in cases where they appear after the subcommand. This PR add support for completing values for these two flags when they appear before the subcommand. ### How to test and review this PR? In a Bash shell, run: ``` source src/etc/cargo.bashcomp.sh ``` Before this patch, the following behaves as expected (suggests colors or paths): ``` cargo build --co<tab> cargo build --config <tab> ``` but the following does not behave as expected (colors or paths are not suggested): ``` cargo --config <tab> cargo --color <tab> ``` With this patch applied, all of the following behave as expected: ``` cargo --config <tab> cargo --color <tab> cargo build --co<tab> cargo build --config <tab> ```

… `native-completions` (#16249) Add `value_hint` for the global `--config` argument to allow completing its value. The related #16245 (comment) adds partial support to `src/etc/cargo.bashcomp.sh`. ### What does this PR try to resolve? Currently, `native-completions` supports completing the `--config` flag itself, but not its argument value. This PR adds support for completing its value with a file path (`clap::ValueHint::FilePath`). ### How to test and review this PR? In a shell supported by `native-completions`, run: ``` source <(CARGO_COMPLETE=bash cargo run) ``` Then, observe that the following completion behaves as expected. That is, the user is prompted with files paths. ``` cargo --config <tab> ```

feat(cli): complete --config after command

35c827a

Adds support for completing --config values with _filedir, but only when they appear after the cargo subcommand.

rustbot assigned epage Nov 12, 2025

rustbot added A-completions Area: shell completions S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Nov 12, 2025

nspin force-pushed the pr/bash-completion-config branch from 87566e1 to 35c827a Compare November 13, 2025 00:28

weihanglo approved these changes Nov 13, 2025

View reviewed changes

weihanglo enabled auto-merge November 13, 2025 00:45

nspin mentioned this pull request Nov 13, 2025

feat(cli): Add support for completing --config argument values with native-completions #16249

Merged

weihanglo added this pull request to the merge queue Nov 13, 2025

Merged via the queue into rust-lang:master with commit bffbb60 Nov 13, 2025
39 of 52 checks passed

rustbot removed the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Nov 13, 2025

weihanglo mentioned this pull request Nov 19, 2025

Update cargo submodule rust-lang/rust#149073

Merged

rustbot added this to the 1.93.0 milestone Nov 20, 2025

nspin mentioned this pull request Mar 22, 2026

feat(cli): complete --config and --color before command #16780

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(cli): Add support for completing `--config` values in Bash#16245

feat(cli): Add support for completing `--config` values in Bash#16245
weihanglo merged 1 commit intorust-lang:masterfrom
nspin:pr/bash-completion-config

nspin commented Nov 12, 2025

Uh oh!

rustbot commented Nov 12, 2025

Uh oh!

epage commented Nov 12, 2025

Uh oh!

nspin commented Nov 13, 2025

Uh oh!

weihanglo left a comment •

edited by rustbot

Loading

Uh oh!

nspin commented Nov 13, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

nspin commented Nov 12, 2025

What does this PR try to resolve?

How to test and review this PR?

Uh oh!

rustbot commented Nov 12, 2025

Uh oh!

epage commented Nov 12, 2025

Uh oh!

nspin commented Nov 13, 2025

Uh oh!

weihanglo left a comment • edited by rustbot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nspin commented Nov 13, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

weihanglo left a comment •

edited by rustbot

Loading