Skip to content

feat(complete): Skeleton for Rust-driven completions #3656

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 23 commits into from
Apr 27, 2022
Merged

feat(complete): Skeleton for Rust-driven completions #3656

merged 23 commits into from
Apr 27, 2022

Conversation

epage
Copy link
Member

@epage epage commented Apr 22, 2022 •
edited
Loading

This implements the rudiments of completions within Rust.

What this can do for Bash

  • Nest into subcommands
  • Provide single-value positional value completions
    • PossibleValues
    • Some of ValueHint
  • Provide short and long flag completions
  • Provide subcommand completions

What this does not do

  • Flag values
  • Multiple values per argument
  • Removing options based on conflicts
  • Handle all of the random App and Arg settings
  • Correctly append spaces when needed
  • Shells other than Bash

Part of #3166

epage added 23 commits April 27, 2022 08:55
@epage
docs(complete): Clarify examples
89c2b3b
@epage
test(complete): Option to verify examples
3d64eba
@epage
fix(lex)!: Don't do prefix matching by default
f083ef9 
Finding this a pain in `clap_complete`; not offering the benefits I
expected.
@epage
clap(debug): More conflict details
d4ddc5f
@epage
fix(complete): Send debug statements to stderr
bbf6488
@epage
feat(complete): Minimal rust-completion
9f9e410 
Inspired by argcomplete, this provides Rust-implemented completions
- Only bash for now
- No subcommand support
- No flag value support
- No special settings support
- No handling of positions within positionals
- No prioritizing of required or removing of conflicts (including
  self-conflicts)
@epage
feat(complete): Basic subcommand support
5882e3d
@epage
feat(complete): Complete possible values
018b8bd
@epage
fix(complete): Detect which argument is being completed
2d70927
@epage
feat(complete): Only list for current positional
4444350
@epage
feat(complete): Escaped args are always positional
458b4ae
@epage
refactor(complete): Extract arg value completion
0112ad8
@epage
fix(complete): Don't count flags as positionals
63e0fd5
@epage
feat(complete): Look up partial matches
a574f22
@epage
fix(complete): Only use IFS between items
fe70fbc
@epage
fix(complete): Don't require IFS
2701f48 
This makes testing easier
@epage
fix(complete: Use correct value name for IFS
6895806
@epage
fix(complete): Allow subcommands in escaped arguments
f489284
@epage
fix(complete): Make short flags additive
ca4439a
@epage
test(complete): Cover subcommands
c9b6d62
@epage
test(complete): Cover long flags
4b9dd3f
@epage
feat(complete): Add debug aids
53ae382
@epage
fix(complete): Correctly detect positionals
1922b89
@epage epage marked this pull request as ready for review April 27, 2022 21:08
@epage epage mentioned this pull request Apr 27, 2022
Closed
@epage epage merged commit 9bf01e9 into clap-rs:master Apr 27, 2022
@epage epage deleted the complete branch April 27, 2022 21:24
@epage epage mentioned this pull request Apr 27, 2022
Open
23 tasks
@epage epage mentioned this pull request Jan 4, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@epage