Skip to content
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.

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

Add completion support for fish and PowerShell shells #1929

Merged
merged 1 commit into from
Mar 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/cmd/kn_completion.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ to provide interactive completion

Supported Shells:
- bash
- fish
- powershell
- zsh

```
Expand All @@ -23,6 +25,12 @@ kn completion SHELL
# Generate completion code for bash
source <(kn completion bash)

# Generate completion code for fish
kn completion fish | source

# Generate completion code for powershell
kn completion powershell | Out-String | Invoke-Expression

# Generate completion code for zsh
source <(kn completion zsh)
compdef _kn kn
Expand Down
18 changes: 15 additions & 3 deletions pkg/kn/commands/completion/completion.go
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,19 @@ to provide interactive completion

Supported Shells:
- bash
- fish
- powershell
- zsh`
eg = `
# Generate completion code for bash
source <(kn completion bash)

# Generate completion code for fish
kn completion fish | source

# Generate completion code for powershell
kn completion powershell | Out-String | Invoke-Expression

# Generate completion code for zsh
source <(kn completion zsh)
compdef _kn kn`
Expand All @@ -46,20 +54,24 @@ func NewCompletionCommand(p *commands.KnParams) *cobra.Command {
Use: "completion SHELL",
Short: "Output shell completion code",
Long: desc,
ValidArgs: []string{"bash", "zsh"},
ValidArgs: []string{"bash", "fish", "powershell", "zsh"},
Example: eg,
RunE: func(cmd *cobra.Command, args []string) error {
if len(args) == 1 {
switch args[0] {
case "bash":
return cmd.Root().GenBashCompletion(os.Stdout)
case "fish":
return cmd.Root().GenFishCompletion(os.Stdout, true)
case "powershell":
return cmd.Root().GenPowerShellCompletion(os.Stdout)
case "zsh":
return cmd.Root().GenZshCompletion(os.Stdout)
default:
return errors.New("'bash' or 'zsh' shell completion is supported")
return errors.New("'bash', 'fish', 'powershell' or 'zsh' shell completion is supported")
}
} else {
return errors.New("Only one argument can be provided, either 'bash' or 'zsh'")
return errors.New("Only one argument can be provided, either 'bash', 'fish', 'powershell' or 'zsh'")
}
},
}
Expand Down
6 changes: 3 additions & 3 deletions pkg/kn/commands/completion/completion_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ func TestCompletionUsage(t *testing.T) {
}

func TestCompletionGeneration(t *testing.T) {
for _, shell := range []string{"bash", "zsh"} {
for _, shell := range []string{"bash", "fish", "powershell", "zsh"} {
completionCmd := NewCompletionCommand(&commands.KnParams{})
c := test.CaptureOutput(t)
err := completionCmd.RunE(&cobra.Command{}, []string{shell})
Expand All @@ -48,11 +48,11 @@ func TestCompletionGeneration(t *testing.T) {
func TestCompletionNoArg(t *testing.T) {
completionCmd := NewCompletionCommand(&commands.KnParams{})
err := completionCmd.RunE(&cobra.Command{}, []string{})
assert.Assert(t, util.ContainsAll(err.Error(), "bash", "zsh", "one", "argument"))
assert.Assert(t, util.ContainsAll(err.Error(), "bash", "fish", "powershell", "zsh", "one", "argument"))
}

func TestCompletionWrongArg(t *testing.T) {
completionCmd := NewCompletionCommand(&commands.KnParams{})
err := completionCmd.RunE(&cobra.Command{}, []string{"sh"})
assert.Assert(t, util.ContainsAll(err.Error(), "bash", "zsh", "support"))
assert.Assert(t, util.ContainsAll(err.Error(), "bash", "fish", "powershell", "zsh", "support"))
}
Loading