feat(completions): Offer Nushell completions #6366
Open
+53
−8
Conversation
This file contains 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
Kissaki
force-pushed
the
feat/completions-nushell
branch
from
71411f2
to
283392e
Compare
Clap offers Nushell completions in a crate clap_complete_nushell separate from the crate clap_complete. clap_complete::Shell and clap_complete_nushell::Nushell share the clap_complete::Generator trait. I'm not too familiar with Rust, and all attempts to use a more direct match to common trait and call generate in one place only failed. 1. Introduce enum `CompletionShell` to unify the options for our command line across these 2. On command, match CompletionShell to their respective counterparts and call generate with them --- The completions can be used in Nushell with: ```nu mkdir $nu.cache-dir starship completions nushell | save -f $'($nu.cache-dir)/starship-completions.nu' use $'($nu.cache-dir)/starship-completions.nu' * ``` and can be set up in the env.nu and config.nu for automatic loading respectively.
Kissaki
force-pushed
the
feat/completions-nushell
branch
from
283392e
to
cadac77
Compare
Corrects display order in command help shell list
Kissaki
added a commit
to Kissaki/nushell-config
that referenced
this pull request
Nov 15, 2024
Open PR, starship/starship#6366, no response/feedback for two weeks yet
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Clap offers Nushell completions in a crate clap_complete_nushell separate from the crate clap_complete.
clap_complete::Shell and clap_complete_nushell::Nushell share the clap_complete::Generator trait.
I'm not too familiar with Rust, and all attempts to use a more direct match to common trait and call generate in one place only failed.
CompletionShellto unify the options for our command line across theseThe completions can be used in Nushell with:
and can be set up in the env.nu and config.nu for automatic loading respectively.
Motivation and Context
Nushell can offer extensive, typed command completion, including external commands.
Starship already offers completions generation through the
completionscommand, implemented through the clap library. The clap library also natively, but as a separate crate, offers to generate Nushell completions.Screenshots (if appropriate):
How Has This Been Tested?
cargo build, nutshell commands as described above, and checking that the Nushell completions show up as expectedstarship completions -hstarship completions nushellstarship completions bashstarship completions fishChecklist:
I have updated the documentation accordingly.- I don't see any docs about completionsI have updated the tests accordingly.- I don't see any tests about completions