This repository was archived by the owner on Jan 22, 2025. It is now read-only.
Auto-generate shell completions for solana-cli (issue #8879 and #14005) #18931
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…and solana-labs#14005) Implement `completion` SubCommand for solana-cli, which outputs completion script to stdout and exits the process. The script generation handled completely by clap. In order to implement the generation, one minor design change was necessary regarding the creation of clap `App`. Previously: One part of App initialization was in the `app` function, and some other arguments and subcommands were added later directly in the `main` function. Now: The whole construction of App was moved to `get_clap_app` function. P.S. I wasn't sure if constructing App separately had visual importance, so both constructing parts are still separate in `base_clap_app` and `final_clap_app` functions. But they sure could be in one single function.
Contributor
CriesofCarrots
left a comment
CriesofCarrots
left a comment
There was a problem hiding this comment.
Thanks! I've been wanting this for a while.
I actually don't think there's a strong reason the base_ and finalize_ parts of the App have to remain separate anymore. Wdyt about adding a separate module to hold the app-construction function?
@t-nelson , can you take a look at this as well?
t-nelson
previously approved these changes
Jul 28, 2021
Contributor
t-nelson
left a comment
t-nelson
left a comment
There was a problem hiding this comment.
Looks great! I've been wanting these for awhile too
Contributor
Agreed. Let's tie these up while they're getting shuffled around anyway |
Also join two parts of the construction into a single function
Codecov Report
@@ Coverage Diff @@
## master #18931 +/- ##
=========================================
- Coverage 82.8% 82.8% -0.1%
=========================================
Files 444 445 +1
Lines 126716 126846 +130
=========================================
+ Hits 104971 105063 +92
- Misses 21745 21783 +38 |
CriesofCarrots
approved these changes
Jul 28, 2021
Contributor
CriesofCarrots
left a comment
CriesofCarrots
left a comment
There was a problem hiding this comment.
Looks great, thank you so much!
mergify bot
pushed a commit
that referenced
this pull request
Jul 28, 2021
… (#18931) * Auto-generate shell completions for solana-cli (issue #8879 and #14005) Implement `completion` SubCommand for solana-cli, which outputs completion script to stdout and exits the process. The script generation handled completely by clap. In order to implement the generation, one minor design change was necessary regarding the creation of clap `App`. Previously: One part of App initialization was in the `app` function, and some other arguments and subcommands were added later directly in the `main` function. Now: The whole construction of App was moved to `get_clap_app` function. P.S. I wasn't sure if constructing App separately had visual importance, so both constructing parts are still separate in `base_clap_app` and `final_clap_app` functions. But they sure could be in one single function. * Dereplicode match expr, fix clippy warning. * Move clap App construction into separate module Also join two parts of the construction into a single function * Fix tests * Apply rustfmt lints (cherry picked from commit 9d0a937)
mergify bot
added a commit
that referenced
this pull request
Jul 28, 2021
… (#18931) (#18945) * Auto-generate shell completions for solana-cli (issue #8879 and #14005) Implement `completion` SubCommand for solana-cli, which outputs completion script to stdout and exits the process. The script generation handled completely by clap. In order to implement the generation, one minor design change was necessary regarding the creation of clap `App`. Previously: One part of App initialization was in the `app` function, and some other arguments and subcommands were added later directly in the `main` function. Now: The whole construction of App was moved to `get_clap_app` function. P.S. I wasn't sure if constructing App separately had visual importance, so both constructing parts are still separate in `base_clap_app` and `final_clap_app` functions. But they sure could be in one single function. * Dereplicode match expr, fix clippy warning. * Move clap App construction into separate module Also join two parts of the construction into a single function * Fix tests * Apply rustfmt lints (cherry picked from commit 9d0a937) Co-authored-by: theonekeyg <[email protected]>
Closed
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Implement
completionSubCommand for solana-cli, which outputscompletion script to stdout and exits the process. The script generation
handled completely by clap.
In order to implement the generation, one minor design change was
necessary regarding the creation of clap
App.Previously: One part of App initialization was in the
appfunction,and some other arguments and subcommands were added later directly in
the
mainfunction.Now: The whole construction of App was moved to
get_clap_appfunction.P.S. I wasn't sure if constructing App separately had visual importance,
so both constructing parts are still separate in
base_clap_appandfinalize_clap_appfunctions. But they sure could be one single function.Problem
Absence of shell completions in solana-cli. (#8879 and #14005)
Summary of Changes
completionsubcommand for solana-cli to generate completion scripts.Fixes #8879 and #14005