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.

Sign up for GitHub

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

Feat: Add zsh, fish and PowerShell completion support #8122

Merged
merged 3 commits into from
Feb 4, 2021
Merged

Feat: Add zsh, fish and PowerShell completion support #8122

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f45dfc2
Feat: Add zsh, fish and powershell completion support
benmezger Jan 6, 2021
e014523
Refactor: Remove powershell support
benmezger Feb 2, 2021
e97f661
Refactor: Write to stdout by default
benmezger Feb 2, 2021
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
30 changes: 19 additions & 11 deletions commands/genautocomplete.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ var _ cmder = (*genautocompleteCmd)(nil)
type genautocompleteCmd struct {
autocompleteTarget string

// bash for now (zsh and others will come)
// bash or zsh
autocompleteType string

*baseCmd
Expand All @@ -37,9 +37,6 @@ func newGenautocompleteCmd() *genautocompleteCmd {
Short: "Generate shell autocompletion script for Hugo",
Long: `Generates a shell autocompletion script for Hugo.

NOTE: The current version supports Bash only.
This should work for *nix systems with Bash installed.

By default, the file is written directly to /etc/bash_completion.d
for convenience, and the command may need superuser rights, e.g.:

Expand All @@ -48,29 +45,40 @@ for convenience, and the command may need superuser rights, e.g.:
Add ` + "`--completionfile=/path/to/file`" + ` flag to set alternative
file-path and name.

Add ` + "`--type={bash, zsh, fish or powershell}`" + ` flag to set alternative
shell type.

Logout and in again to reload the completion scripts,
or just source them in directly:

$ . /etc/bash_completion`,
$ . /etc/bash_completion or /path/to/file`,

RunE: func(cmd *cobra.Command, args []string) error {
if cc.autocompleteType != "bash" {
return newUserError("Only Bash is supported for now")
var err error
switch cc.autocompleteType {
case "zsh":
err = cmd.Root().GenZshCompletionFile(cc.autocompleteTarget)
case "bash":
err = cmd.Root().GenBashCompletionFile(cc.autocompleteTarget)
case "fish":
err = cmd.Root().GenFishCompletionFile(cc.autocompleteTarget, true)
case "powershell":
err = cmd.Root().GenFishCompletionFile(cc.autocompleteTarget, true)
default:
return newUserError("Unsupported completion type")
}

err := cmd.Root().GenBashCompletionFile(cc.autocompleteTarget)
if err != nil {
return err
}

jww.FEEDBACK.Println("Bash completion file for Hugo saved to", cc.autocompleteTarget)

jww.FEEDBACK.Println(cc.autocompleteType+" completion file for Hugo saved to", cc.autocompleteTarget)
return nil
},
})

cc.cmd.PersistentFlags().StringVarP(&cc.autocompleteTarget, "completionfile", "", "/etc/bash_completion.d/hugo.sh", "autocompletion file")
cc.cmd.PersistentFlags().StringVarP(&cc.autocompleteType, "type", "", "bash", "autocompletion type (currently only bash supported)")
cc.cmd.PersistentFlags().StringVarP(&cc.autocompleteType, "type", "", "bash", "autocompletion type (zsh, bash, fish or powershell)")

// For bash-completion
cc.cmd.PersistentFlags().SetAnnotation("completionfile", cobra.BashCompFilenameExt, []string{})
Expand Down
14 changes: 7 additions & 7 deletions docs/content/en/commands/hugo_gen_autocomplete.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2020-09-13
date: 2021-01-06
title: "hugo gen autocomplete"
slug: hugo_gen_autocomplete
url: /commands/hugo_gen_autocomplete/
Expand All @@ -12,9 +12,6 @@ Generate shell autocompletion script for Hugo

Generates a shell autocompletion script for Hugo.

NOTE: The current version supports Bash only.
This should work for *nix systems with Bash installed.

By default, the file is written directly to /etc/bash_completion.d
for convenience, and the command may need superuser rights, e.g.:

Expand All @@ -23,10 +20,13 @@ for convenience, and the command may need superuser rights, e.g.:
Add `--completionfile=/path/to/file` flag to set alternative
file-path and name.

Add `--type={bash, zsh, fish or powershell}` flag to set alternative
shell type.

Logout and in again to reload the completion scripts,
or just source them in directly:

$ . /etc/bash_completion
$ . /etc/bash_completion or /path/to/file

```
hugo gen autocomplete [flags]
Expand All @@ -37,7 +37,7 @@ hugo gen autocomplete [flags]
```
--completionfile string autocompletion file (default "/etc/bash_completion.d/hugo.sh")
-h, --help help for autocomplete
--type string autocompletion type (currently only bash supported) (default "bash")
--type string autocompletion type (zsh, bash, fish or powershell) (default "bash")
```

### Options inherited from parent commands
Expand All @@ -62,4 +62,4 @@ hugo gen autocomplete [flags]

* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.

###### Auto generated by spf13/cobra on 13-Sep-2020
###### Auto generated by spf13/cobra on 6-Jan-2021