Add fish shell completion

yutaro1985 · yutaro1985 · commit 38a327a66c08 · 2023-06-30T02:32:29.000+09:00
Signed-off-by: Yutaro Suzuki &lt;yutaro.suzuki@cloudys.dev&gt;
diff --git a/cmd/completion/completion.go b/cmd/completion/completion.go
@@ -14,6 +14,7 @@ import (
 	"github.com/spf13/cobra"
 
 	"github.com/terraform-docs/terraform-docs/cmd/completion/bash"
+	"github.com/terraform-docs/terraform-docs/cmd/completion/fish"
 	"github.com/terraform-docs/terraform-docs/cmd/completion/zsh"
 )
 
@@ -22,18 +23,19 @@ func NewCommand() *cobra.Command {
 	cmd := &cobra.Command{
 		Args:  cobra.NoArgs,
 		Use:   "completion SHELL",
-		Short: "Generate shell completion code for the specified shell (bash or zsh)",
+		Short: "Generate shell completion code for the specified shell (bash,zsh,fish)",
 		Long:  longDescription,
 	}
 
 	// subcommands
 	cmd.AddCommand(bash.NewCommand())
 	cmd.AddCommand(zsh.NewCommand())
+	cmd.AddCommand(fish.NewCommand())
 
 	return cmd
 }
 
-const longDescription = `Outputs terraform-doc shell completion for the given shell (bash or zsh)
+const longDescription = `Outputs terraform-doc shell completion for the given shell (bash,zsh,fish)
 This depends on the bash-completion binary.  Example installation instructions:
 # for bash users
 	$ terraform-doc completion bash > ~/.terraform-doc-completion
@@ -45,6 +47,9 @@ This depends on the bash-completion binary.  Example installation instructions:
 # or if zsh-completion is installed via homebrew
     % terraform-doc completion zsh > "${fpath[1]}/_terraform-doc"
 
+# for fish users
+	$ terraform-doc completion fish | source
+
 Additionally, you may want to output the completion to a file and source in your .bashrc
 Note for zsh users: [1] zsh completions are only supported in versions of zsh >= 5.2
 `
diff --git a/cmd/completion/fish/fish.go b/cmd/completion/fish/fish.go
@@ -0,0 +1,30 @@
+/*
+Copyright 2021 The terraform-docs Authors.
+
+Licensed under the MIT license (the "License"); you may not
+use this file except in compliance with the License.
+
+You may obtain a copy of the License at the LICENSE file in
+the root directory of this source tree.
+*/
+
+package fish
+
+import (
+	"os"
+
+	"github.com/spf13/cobra"
+)
+
+// NewCommand returns a new cobra.Command for 'completion fish' command
+func NewCommand() *cobra.Command {
+	cmd := &cobra.Command{
+		Args:  cobra.NoArgs,
+		Use:   "fish",
+		Short: "Generate shel completion for fish",
+		RunE: func(cmd *cobra.Command, args []string) error {
+			return cmd.Parent().Parent().GenFishCompletion(os.Stdout, true)
+		},
+	}
+	return cmd
+}
