feat: add completions for install --path #15266

nooma-42 · 2025-03-05T08:06:55Z

What does this PR try to resolve?

Related to #14520

This PR introduces auto-completion for the cargo install --path option. When a user types cargo install --path and presses the TAB key, the system will automatically detect directories in the current path and suggestion prioritizes directory containing a Cargo.toml file.

How should we test and review this PR?

To verify this feature, follow these steps:

In the terminal, type cargo install --path
Press the TAB key.
You should see suggestions only for directories in the current path that contain a Cargo.toml file being prioritized, such as ./src/ (if ./src/Cargo.toml exists).

2025-03-08.1.08.06.mov

Additional information

There's a discussion in Zulip and here're some relevant information from it

directories are always shown so that a completer doesn't have to recurse through a directory tree to determine what directories may be relevant. The difference marking a directory as accepted does it sorts it first.
A user / config setting might override a sort order over native completion. Try disable it manually if native completion is not there.

rustbot · 2025-03-05T08:06:59Z

r? @weihanglo

rustbot has assigned @weihanglo.
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/bin/cargo/commands/install.rs

nooma-42 · 2025-03-06T06:32:25Z

@epage @weihanglo
Thanks for your review :) This is my first time contributing to Cargo, so I'm not very familiar with it. Please bear with me if this is a dumb question.
I wanted to ask if cargo native-completion can print debug messages. I followed the instructions here and added some environment variables, but nothing got logged to a file or printed in the terminal.

https://doc.crates.io/contrib/implementation/debugging.html

weihanglo · 2025-03-06T14:26:12Z

I wanted to ask if cargo native-completion can print debug messages. I followed the instructions here and added some environment variables, but nothing got logged to a file or printed in the terminal.

If you're adding tracing log like tracing::info!, try exporting CARGO_LOG environment variable, so your subsequent cargo call can see the variable. For example,

# zsh
export CARGO_LOG=info
cargo install --path <tab>

If you feel logging too hassle to use, use dbg! or just panic! so you'll see it without setting any env var.

epage · 2025-03-06T14:51:04Z

Anything written to stdout will be read by the completion shim and interpreted as completions to report to the user
https://github.com/clap-rs/clap/blob/fdbbf66e77c83688f52b7a206d64102582af40d3/clap_complete/src/env/shells.rs#L40-L46

Unsure what else a shell's completion system may do on top of what we're doing.

You can also directly invoke the completer so nothing gets captured. You can run CARGO_COMPLETE=zsh cargo +nightly, see how cargo is invoked and do similar.

weihanglo

Mind fixing up the commits for how you prefer them to get merged?

src/bin/cargo/commands/install.rs

epage · 2025-03-07T17:40:27Z

Feel free to squash your commits for how you would like them to be merged

epage

Thanks!

Update cargo 22 commits in 2622e844bc1e2e6123e54e94e4706f7b6195ce3d..ab1463d632528e39daf35f263e10c14cbe590ce8 2025-02-28 12:33:57 +0000 to 2025-03-08 01:45:05 +0000 - test: redact host target when comparing CARGO_ENV path (rust-lang/cargo#15279) - feat: add completions for install --path (rust-lang/cargo#15266) - fix(package): report lockfile / workspace manifest is dirty (rust-lang/cargo#15276) - feat(tree): Add `--depth public` behind `-Zunstable-options` (rust-lang/cargo#15243) - Don't use `$CARGO_BUILD_TARGET` in `cargo metadata` (rust-lang/cargo#15271) - feat: show extra build description from bootstrap (rust-lang/cargo#15269) - Upgrade to `rustc-stable-hash v0.1.2` (rust-lang/cargo#15268) - fix: Respect --frozen everywhere --offline or --locked is accepted (rust-lang/cargo#15263) - feat(tree): Color the output (rust-lang/cargo#15242) - fix(vendor): dont remove non-cached source (rust-lang/cargo#15260) - docs: lockfile is always included since 1.84 (rust-lang/cargo#15257) - Remove `Cargo.toml` from `package.include` in example (rust-lang/cargo#15253) - Small cleanup: remove unneeded result (rust-lang/cargo#15256) - Fix typo in build-scripts.md (rust-lang/cargo#15254) - chore(deps): update rust crate pulldown-cmark to 0.13.0 (rust-lang/cargo#15250) - chore(deps): update compatible (rust-lang/cargo#15249) - feat(cli): forward bash completions of third party subcommands (rust-lang/cargo#15247) - feat: add completions for `--lockfile-path` (rust-lang/cargo#15238) - fix: reset $CARGO if the running program is real `cargo[.exe]` (rust-lang/cargo#15208) - Get all members as `available targets` even though default-members was specified. (rust-lang/cargo#15199) - refactor: control byte display precision with std::fmt options (rust-lang/cargo#15246) - fix(package): Ensure we can package directories ending with '.rs' (rust-lang/cargo#15240)

rustbot assigned weihanglo Mar 5, 2025

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

epage reviewed Mar 5, 2025

View reviewed changes

src/bin/cargo/commands/install.rs Outdated Show resolved Hide resolved

weihanglo reviewed Mar 5, 2025

View reviewed changes

src/bin/cargo/commands/install.rs Show resolved Hide resolved

nooma-42 force-pushed the install-path-completion branch 3 times, most recently from e4a8a59 to 57e76a4 Compare March 7, 2025 17:33

weihanglo reviewed Mar 7, 2025

View reviewed changes

src/bin/cargo/commands/install.rs Outdated Show resolved Hide resolved

epage reviewed Mar 7, 2025

View reviewed changes

src/bin/cargo/commands/install.rs Outdated Show resolved Hide resolved

feat: add completions for install --path

cb278bc

nooma-42 force-pushed the install-path-completion branch from 57e76a4 to cb278bc Compare March 7, 2025 17:53

epage approved these changes Mar 7, 2025

View reviewed changes

epage enabled auto-merge March 7, 2025 18:08

epage added this pull request to the merge queue Mar 7, 2025

Merged via the queue into rust-lang:master with commit aecb765 Mar 7, 2025
21 checks passed

weihanglo mentioned this pull request Mar 8, 2025

Update cargo rust-lang/rust#138200

Merged

rustbot added this to the 1.87.0 milestone Mar 10, 2025

weihanglo mentioned this pull request Mar 10, 2025

Tracking Issue for native-completion #14520

Open

27 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add completions for install --path #15266

feat: add completions for install --path #15266

nooma-42 commented Mar 5, 2025 •

edited

Loading

rustbot commented Mar 5, 2025

nooma-42 commented Mar 6, 2025 •

edited

Loading

weihanglo commented Mar 6, 2025

epage commented Mar 6, 2025

weihanglo left a comment

epage commented Mar 7, 2025

epage left a comment

feat: add completions for install --path #15266

feat: add completions for install --path #15266

Conversation

nooma-42 commented Mar 5, 2025 • edited Loading

What does this PR try to resolve?

How should we test and review this PR?

Additional information

rustbot commented Mar 5, 2025

nooma-42 commented Mar 6, 2025 • edited Loading

weihanglo commented Mar 6, 2025

epage commented Mar 6, 2025

weihanglo left a comment

Choose a reason for hiding this comment

epage commented Mar 7, 2025

epage left a comment

Choose a reason for hiding this comment

nooma-42 commented Mar 5, 2025 •

edited

Loading

nooma-42 commented Mar 6, 2025 •

edited

Loading