Merge pull request #740 from lbdemv/update-docstring-bash-completion

khos2ow · web-flow · commit 77d395af54ff · 2024-03-23T14:39:53.000-04:00
Fixed binary name in description output of bash completion generation cli command
diff --git a/cmd/completion/completion.go b/cmd/completion/completion.go
@@ -35,20 +35,28 @@ func NewCommand() *cobra.Command {
 	return cmd
 }
 
-const longDescription = `Outputs terraform-doc shell completion for the given shell (bash, zsh, fish)
+const longDescription = `Outputs terraform-docs 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
-	$ source ~/.terraform-doc-completion
+	$ terraform-docs completion bash > ~/.terraform-docs-completion
+	$ source ~/.terraform-docs-completion
+
+	# or the one-liner below
+
+	$ source <(terraform-docs completion bash)
 
 # for zsh users
-	% terraform-doc completion zsh > /usr/local/share/zsh/site-functions/_terraform-doc
+	% terraform-docs completion zsh > /usr/local/share/zsh/site-functions/_terraform-docs
 	% autoload -U compinit && compinit
 # or if zsh-completion is installed via homebrew
-    % terraform-doc completion zsh > "${fpath[1]}/_terraform-doc"
+	% terraform-docs completion zsh > "${fpath[1]}/_terraform-docs"
+
+# for ohmyzsh
+	$ terraform-docs completion zsh > ~/.oh-my-zsh/completions/_terraform-docs
+	$ omz reload
 
 # for fish users
-	$ terraform-doc completion fish > ~/.config/fish/completions/terraform-docs.fish
+	$ terraform-docs completion fish > ~/.config/fish/completions/terraform-docs.fish
 
 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/docs/user-guide/installation.md b/docs/user-guide/installation.md
@@ -153,7 +153,7 @@ omz reload
 ### fish
 
 ```fish
-terraform-doc completion fish > ~/.config/fish/completions/terraform-docs.fish
+terraform-docs completion fish > ~/.config/fish/completions/terraform-docs.fish
 ```
 
 To make this change permanent, the above commands can be added to `~/.profile` file.
diff --git a/internal/cli/run.go b/internal/cli/run.go
@@ -214,7 +214,7 @@ func (r *Runtime) bindFlags(v *viper.Viper) {
 		switch f.Name {
 		case "show", "hide":
 			// If '--show' or '--hide' CLI flag is used, explicitly override and remove
-			// all items from 'show' and 'hide' set in '.terraform-doc.yml'.
+			// all items from 'show' and 'hide' set in '.terraform-docs.yml'.
 			if !sectionsCleared {
 				v.Set("sections.show", []string{})
 				v.Set("sections.hide", []string{})
