Initial commit with working code and release flow

Author: Martin Simango

.gitignore

@@ -0,0 +1,4 @@
+releases/
+dist/
+.token
+.DS_STORE

.goreleaser.yaml

@@ -0,0 +1,56 @@
+before:
+  hooks:
+    - go mod tidy
+    - go generate ./...
+builds:
+  - id: kubectl-plugin_completion
+    binary: kubectl-plugin_completion
+    env:
+      - CGO_ENABLED=0
+    goos:
+      - linux
+      - windows
+      - darwin
+    goarch:
+      - amd64
+      - arm64
+    ignore:
+    - goos: windows
+      goarch: arm64
+archives:
+  - builds:
+    - kubectl-plugin_completion
+    name_template: "{{ .ProjectName }}_{{ .Tag }}_{{ .Os }}_{{ .Arch }}{{ if .Arm }}v{{ .Arm }}{{ end }}"
+    wrap_in_directory: false
+    format: tar.gz
+    files:
+    - LICENSE
+    format_overrides:
+      - goos: windows
+        format: zip
+    id: kubectl-plugin_completion
+checksum:
+  name_template: 'checksums.txt'
+snapshot:
+  name_template: "{{ .Version }}"
+changelog:
+  sort: asc
+  filters:
+    exclude:
+      - '^docs:'
+      - '^test:'
+krews:
+  -
+    name: plugin_completion
+    ids:
+    - kubectl-plugin_completion
+    homepage: "https://github.com/MartinSimango/kubectl-plugin_completion"
+    description: "This plugin allows for the creation of completion scripts"
+    short_description: "Allow shell completion for kubectl plugins"
+
+    url_template: "https://github.com/MartinSimango/kubectl-plugin_completion/releases/download/{{ .Tag }}/{{ .ArtifactName }}"
+    skip_upload: true
+
+release:
+  extra_files:
+    - glob: ./dist/plugin_completion.yaml

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Martin Simango
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Makefile

@@ -0,0 +1,12 @@
+ifeq (,$(wildcard /.token))
+	include .token
+endif
+
+install:
+	go build && go install
+
+release:
+	goreleaser release --rm-dist
+
+release-local:
+	goreleaser release --snapshot --rm-dist

README.md

@@ -0,0 +1,89 @@
+# kubectl-plugin_completion
+
+Auto completion saves a lot of time when typing in commands. The kubectl tool has a way to allow for completion for it's sub-commands,
+however it doesn't not accomodate for when these sub-commands are plugin commands. This repo contains the code for a kubectl plugin that generates scripts for extending the kubectl tool in order to accomodate for completions for kubectl plugin sub-commands.
+
+## Sections
+* [Install plugin](https://github.com/MartinSimango/kubectl-plugin-autocompletion#install-plugin)
+* [How it works](https://github.com/MartinSimango/kubectl-plugin-autocompletion#how-it-works)
+* [How to use](https://github.com/MartinSimango/kubectl-plugin-autocompletion#how-to-use)
+* [Example](https://github.com/MartinSimango/kubectl-plugin-autocompletion#example)
+
+
+## Install plugin
+
+Plugin can be installed in 3 ways:
+
+1. Via krew
+ ```sh 
+$ kubectl krew install --manifest-url https://github.com/MartinSimango/kubectl-plugin_completion/releases/download/v0.1.0/plugin_completion.yaml
+``` 
+2. Zip file containing binary can be download on the [release page](https://github.com/MartinSimango/kubectl-plugin-autocompletion/releases)
+
+3. Manually by cloning the repo and running make install - (This requires you having go installed)
+
+
+## How it works
+
+The plugin works by reading config files for specfic shells (so far only bash and zsh). These config files in a folder located at `$HOME/.kube/plugin-completion-config` and are named `$SHELL_NAME.yaml`. So for example the zsh config file will be located at `$HOME/.kube/plugin-completion-config/zsh.yaml`. 
+
+The config files contain information about the available kubectl plugins along with some additional information such as plugin's description and the plugin's completion function name. Below is an example of what a config file for a zsh terminal will look like:
+
+```yaml
+shell: zsh
+shellLocation: /bin/zsh
+plugins:
+- name: krew
+  completionFunctionName: _krew
+  description: A kubectl plugin called krew
+- name: hello
+  completionFunctionName: ""
+  description: A kubectl plugin called hello
+- name: plugin_completion
+  completionFunctionName: _plugin_completion
+  description: A kubectl plugin called plugin_completion
+```
+
+The above file can be generated by running: 
+``` sh
+$ kubectl plugin_completion config generate 
+```
+This will generate config files for all supported shells (zsh and bash). For plugins that were created using [cobra](https://github.com/spf13/cobra) the `completionFunctionName` field will automatically be field in. The description for each plugin will default to: "A kubectl plugin called $plugin_name". 
+
+If a plugin was not created by using [cobra](https://github.com/spf13/cobra) it will be up to you to manually edit the config file and provide the name of the plugin's completion function name. This can also be done by running the `kubectl plugin_completion config edit` command as shown below:
+
+```sh
+$ kubectl plugin_completion config edit zsh --plugin-name=custom_plugin --completion-function="_completion_function_name"
+```
+
+The plugin_completion uses config files to generate completions specific shells in order to allow for completions for kubectl plugins. The generated completion scripts overwrite the behaviour of the completion function for the kubectl tool and extend it to allow for kubectl plugin completions.
+
+## How to use
+
+To start of you will need to generate your shell plugin config files. This can be done by running the below command:
+``` sh
+$ kubectl plugin_completion config generate 
+```
+
+Once the config files are generated you can source the plugin completion script by running:
+
+```sh
+$ source <(kubectl plugin_completion plugin-completion $SHELL)
+```
+
+where `$SHELL` is the shell you want to generate the completion script for. 
+
+To make the changes permanent you can add  `source <(kubectl plugin_completion plugin-completion zsh)` to your `~/.zshrc` file or `source <(kubectl plugin_completion plugin-completion bash)` to your `~/.bashrc (or ~/.bash_profile)` file. 
+
+Please note if you change the config files for a shell you will need to rerun the `source <(kubectl plugin_completion plugin-completion $SHELL)` command as the plugin completion script is generated from using information from the config files. 
+
+Once the above is done completions for your plugins should work as displayed in the below Example section.
+
+
+## Example
+<p align="center">
+<img src="https://github.com/MartinSimango/kubectl-plugin-autocompletion/blob/main/kub-plugin.gif" style="width:600px;height=1000px"/>
+</p>
+<!-- ![Alt Text](https://github.com/MartinSimango/kubectl-plugin-autocompletion/blob/main/kub-plugin.gif) -->
+
+

cmd/clean.go

@@ -0,0 +1,30 @@
+/*
+Copyright © 2022 Martin Simango <shukomango@gmail.com>
+
+*/
+package cmd
+
+import (
+	"os"
+
+	"github.com/spf13/cobra"
+)
+
+// cleanCmd represents the clean command
+var cleanCmd = &cobra.Command{
+	Use:   "clean",
+	Short: "Clear config files for specified shell (bash or zsh) or for all shells (by specifying all instead of a shell name)",
+	Long: `Clear config files for specified shell (bash or zsh) or for all shells (by specifying all instead of a shell name).
+
+	To clean the config file for the zsh terminal, you can enter the following command: 
+	"kubectl plugin_completion clean zsh"`,
+	Run: func(cmd *cobra.Command, args []string) {
+		cmd.Help()
+		os.Exit(1)
+	},
+}
+
+func init() {
+	configCmd.AddCommand(cleanCmd)
+
+}

cmd/cleanAll.go

@@ -0,0 +1,24 @@
+/*
+Copyright © 2022 Martin Simango <shukomango@gmail.com>
+
+*/
+package cmd
+
+import (
+	"github.com/spf13/cobra"
+)
+
+// cleanAllCmd represents the cleanAll command
+var cleanAllCmd = &cobra.Command{
+	Use:   "all",
+	Short: "Clear plugin config file for all shells",
+	Long:  `Clear plugin config file for all shells`,
+	Run: func(cmd *cobra.Command, args []string) {
+		NewBashPluginConfigImpl().WriteCleanConfig()
+		NewZshPluginConfigImpl().WriteCleanConfig()
+	},
+}
+
+func init() {
+	cleanCmd.AddCommand(cleanAllCmd)
+}

cmd/cleanBash.go

@@ -0,0 +1,23 @@
+/*
+Copyright © 2022 Martin Simango <shukomango@gmail.com>
+
+*/
+package cmd
+
+import (
+	"github.com/spf13/cobra"
+)
+
+// cleanBashCmd represents the cleanBash command
+var cleanBashCmd = &cobra.Command{
+	Use:   "bash",
+	Short: "Clear the bash config plugin file",
+	Long:  `Clear the bash config plugin file`,
+	Run: func(cmd *cobra.Command, args []string) {
+		NewBashPluginConfigImpl().WriteCleanConfig()
+	},
+}
+
+func init() {
+	cleanCmd.AddCommand(cleanBashCmd)
+}

cmd/cleanZsh.go

@@ -0,0 +1,24 @@
+/*
+Copyright © 2022 Martin Simango <shukomango@gmail.com>
+
+*/
+package cmd
+
+import (
+	"github.com/spf13/cobra"
+)
+
+// cleanZshCmd represents the cleanZsh command
+var cleanZshCmd = &cobra.Command{
+	Use:   "zsh",
+	Short: "Clear the zsh config plugin file",
+	Long:  `Clear the zsh config plugin file`,
+	Run: func(cmd *cobra.Command, args []string) {
+		NewZshPluginConfigImpl().WriteCleanConfig()
+	},
+}
+
+func init() {
+	cleanCmd.AddCommand(cleanZshCmd)
+
+}

cmd/completion.go

@@ -0,0 +1,32 @@
+package cmd
+
+import (
+	"os"
+
+	"github.com/spf13/cobra"
+)
+
+var CompletionCmd = &cobra.Command{
+	Use:                   "completion",
+	Short:                 "Generate completion script",
+	Long:                  "To load completions",
+	DisableFlagsInUseLine: true,
+	ValidArgs:             []string{"bash", "zsh", "fish", "powershell"},
+	Args:                  cobra.ExactValidArgs(1),
+	Run: func(cmd *cobra.Command, args []string) {
+		switch args[0] {
+		case "bash":
+			cmd.Root().GenBashCompletion(os.Stdout)
+		case "zsh":
+			cmd.Root().GenZshCompletion(os.Stdout)
+		case "fish":
+			cmd.Root().GenFishCompletion(os.Stdout, true)
+		case "powershell":
+			cmd.Root().GenPowerShellCompletionWithDesc(os.Stdout)
+		}
+	},
+}
+
+func init() {
+	rootCmd.AddCommand(CompletionCmd)
+}