-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Provide a cli option to enable and disable completion command
Signed-off-by: Adrian Orive <adrian.orive.oneca@gmail.com>
- Loading branch information
Showing
5 changed files
with
126 additions
and
74 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
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
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,108 @@ | ||
/* | ||
Copyright 2020 The Kubernetes Authors. | ||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
http://www.apache.org/licenses/LICENSE-2.0 | ||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
*/ | ||
|
||
package cli | ||
|
||
import ( | ||
"fmt" | ||
"os" | ||
|
||
"github.com/spf13/cobra" | ||
) | ||
|
||
func (c *cli) newBashCmd() *cobra.Command { | ||
return &cobra.Command{ | ||
Use: "bash", | ||
Short: "Load bash completions", | ||
Example: fmt.Sprintf(`# To load completion for this session, execute: | ||
$ source <(%[1]s completion bash) | ||
# To load completions for each session, execute once: | ||
Linux: | ||
$ %[1]s completion bash > /etc/bash_completion.d/%[1]s | ||
MacOS: | ||
$ %[1]s completion bash > /usr/local/etc/bash_completion.d/%[1]s | ||
`, c.commandName), | ||
RunE: func(cmd *cobra.Command, cmdArgs []string) error { | ||
return cmd.Root().GenBashCompletion(os.Stdout) | ||
}, | ||
} | ||
} | ||
|
||
func (c *cli) newZshCmd() *cobra.Command { | ||
return &cobra.Command{ | ||
Use: "zsh", | ||
Short: "Load zsh completions", | ||
Example: fmt.Sprintf(`# If shell completion is not already enabled in your environment you will need | ||
# to enable it. You can execute the following once: | ||
$ echo "autoload -U compinit; compinit" >> ~/.zshrc | ||
# To load completions for each session, execute once: | ||
$ %[1]s completion zsh > "${fpath[1]}/_%[1]s" | ||
# You will need to start a new shell for this setup to take effect. | ||
`, c.commandName), | ||
RunE: func(cmd *cobra.Command, cmdArgs []string) error { | ||
return cmd.Root().GenZshCompletion(os.Stdout) | ||
}, | ||
} | ||
} | ||
|
||
/* TODO: support fish code completion | ||
At the time this comment is written, the imported spf13.cobra version does not support fish completion. | ||
However, fish completion has been added to new spf13.cobra versions. When a new spf13.cobra version that | ||
supports it is used, uncomment this command and add it to the base completion command. | ||
func (c *cli) newFishCmd() *cobra.Command { | ||
return &cobra.Command{ | ||
Use: "fish", | ||
Short: "Load fish completions", | ||
Example: fmt.Sprintf(`# To load completion for this session, execute: | ||
$ %[1]s completion fish | source | ||
# To load completions for each session, execute once: | ||
$ %[1]s completion fish > ~/.config/fish/completions/%[1]s.fish`, c.commandName), | ||
RunE: func(cmd *cobra.Command, cmdArgs []string) error { | ||
return cmd.Root().GenFishCompletion(os.Stdout) | ||
}, | ||
} | ||
} | ||
*/ | ||
|
||
func (c *cli) newPowerShellCmd() *cobra.Command { | ||
return &cobra.Command{ | ||
Use: "powershell", | ||
Short: "Load powershell completions", | ||
RunE: func(cmd *cobra.Command, cmdArgs []string) error { | ||
return cmd.Root().GenPowerShellCompletion(os.Stdout) | ||
}, | ||
} | ||
} | ||
|
||
func (c *cli) newCompletionCmd() *cobra.Command { | ||
cmd := &cobra.Command{ | ||
Use: "completion", | ||
Short: "Load completions for the specified shell", | ||
Long: fmt.Sprintf(`Output shell completion code for the specified shell. | ||
The shell code must be evaluated to provide interactive completion of %[1]s commands. | ||
Detailed instructions on how to do this for each shell are provided in their own commands. | ||
`, c.commandName), | ||
} | ||
cmd.AddCommand(c.newBashCmd()) | ||
cmd.AddCommand(c.newZshCmd()) | ||
// cmd.AddCommand(c.newFishCmd()) // TODO: uncomment when adding fish completion | ||
cmd.AddCommand(c.newPowerShellCmd()) | ||
return cmd | ||
} |