Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Nov 13, 2025
Merged

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

merged 1 commit into from
Nov 13, 2025
+5 −1

Conversation

@nspin
Copy link
Contributor

@nspin nspin commented Nov 12, 2025

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>

@nspin
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 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
@rustbot
Copy link
Collaborator

rustbot commented Nov 12, 2025

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
Copy link
Contributor

epage commented Nov 12, 2025

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 nspin force-pushed the pr/bash-completion-config branch from 87566e1 to 35c827a Compare November 13, 2025 00:28
@nspin
Copy link
Contributor Author

nspin commented Nov 13, 2025

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
weihanglo approved these changes Nov 13, 2025
View reviewed changes
Copy link
Member

@weihanglo weihanglo left a comment •
edited by rustbot
Loading

Choose a reason for hiding this comment

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

Thanks!

View changes since this review

@weihanglo weihanglo enabled auto-merge November 13, 2025 00:45
@nspin nspin mentioned this pull request Nov 13, 2025
Open
@nspin
Copy link
Contributor Author

nspin commented Nov 13, 2025

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

@weihanglo 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 rustbot removed the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Nov 13, 2025
@weihanglo weihanglo mentioned this pull request Nov 19, 2025
Merged
bors added a commit to rust-lang/rust that referenced this pull request Nov 19, 2025
@bors
Auto merge of #149073 - weihanglo:update-cargo, r=weihanglo
392f5ec 
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)
bors added a commit to rust-lang/rust that referenced this pull request Nov 19, 2025
@bors
Auto merge of #149073 - weihanglo:update-cargo, r=weihanglo
c1f6e19 
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)
bors added a commit to rust-lang/rust that referenced this pull request Nov 19, 2025
@bors
Auto merge of #149073 - weihanglo:update-cargo, r=weihanglo
d2f8873 
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)
@rustbot rustbot added this to the 1.93.0 milestone Nov 20, 2025
github-actions bot pushed a commit to rust-lang/miri that referenced this pull request Nov 20, 2025
@bors
Auto merge of #149073 - weihanglo:update-cargo, r=weihanglo
9d58c60 
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)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@weihanglo weihanglo weihanglo approved these changes

Assignees

@epage epage

Labels

A-completions Area: shell completions

Projects

None yet

Milestone

1.93.0

Development

Successfully merging this pull request may close these issues.

4 participants

@nspin @rustbot @epage @weihanglo