github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-11-07 20:30:36 -05:00
Code Issues Projects Releases Packages Wiki Activity

Refactor: Write to stdout by default

Browse source
This commit is contained in:
Ben Mezger 2021-02-02 20:03:31 -03:00 committed by Anthony Fok
parent a7c515e1b5
commit d36fd5b3ee
2 changed files with 24 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
commands/genautocomplete.go
View file

@ -14,6 +14,9 @@
package commands package commands
import ( import (
"io"
"os"
"github.com/spf13/cobra" "github.com/spf13/cobra"
jww "github.com/spf13/jwalterweatherman" jww "github.com/spf13/jwalterweatherman"
) )
@ -53,13 +56,21 @@ or just source them in directly:
RunE: func(cmd *cobra.Command, args []string) error { RunE: func(cmd *cobra.Command, args []string) error {
var err error var err error
var target io.Writer
if cc.autocompleteTarget == "" {
target = os.Stdout
} else {
target, _ = os.OpenFile(cc.autocompleteTarget, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0644)
}
switch cc.autocompleteType { switch cc.autocompleteType {
case "zsh": case "zsh":
err = cmd.Root().GenZshCompletionFile(cc.autocompleteTarget) err = cmd.Root().GenZshCompletion(target)
case "bash": case "bash":
err = cmd.Root().GenBashCompletionFile(cc.autocompleteTarget) err = cmd.Root().GenBashCompletion(target)
case "fish": case "fish":
err = cmd.Root().GenFishCompletionFile(cc.autocompleteTarget, true) err = cmd.Root().GenFishCompletion(target, true)
default: default:
return newUserError("Unsupported completion type") return newUserError("Unsupported completion type")
} }
@ -68,16 +79,15 @@ or just source them in directly:
return err return err
} }
jww.FEEDBACK.Println(cc.autocompleteType+" completion file for Hugo saved to", cc.autocompleteTarget) if cc.autocompleteTarget != "" {
jww.FEEDBACK.Println(cc.autocompleteType+" completion file for Hugo saved to", cc.autocompleteTarget)
}
return nil return nil
}, },
}) })
cc.cmd.PersistentFlags().StringVarP(&cc.autocompleteTarget, "completionfile", "", "/etc/bash_completion.d/hugo.sh", "autocompletion file") cc.cmd.PersistentFlags().StringVarP(&cc.autocompleteTarget, "completionfile", "f", "", "autocompletion file, defaults to stdout")
cc.cmd.PersistentFlags().StringVarP(&cc.autocompleteType, "type", "", "bash", "autocompletion type (zsh, bash, fish or powershell)") cc.cmd.PersistentFlags().StringVarP(&cc.autocompleteType, "type", "t", "bash", "autocompletion type (zsh, bash or fish)")
// For bash-completion
cc.cmd.PersistentFlags().SetAnnotation("completionfile", cobra.BashCompFilenameExt, []string{})
return cc return cc
} }

10
docs/content/en/commands/hugo_gen_autocomplete.md
View file

@ -12,10 +12,10 @@ Generate shell autocompletion script for Hugo
Generates a shell autocompletion script for Hugo. Generates a shell autocompletion script for Hugo.
By default, the file is written directly to /etc/bash_completion.d By default, the file is written directly to `stdout`
for convenience, and the command may need superuser rights, e.g.: for convenience, and the command may need superuser rights, e.g.:
$ sudo hugo gen autocomplete $ sudo hugo gen autocomplete
Add `--completionfile=/path/to/file` flag to set alternative Add `--completionfile=/path/to/file` flag to set alternative
file-path and name. file-path and name.
@ -26,7 +26,7 @@ shell type.
Logout and in again to reload the completion scripts, Logout and in again to reload the completion scripts,
or just source them in directly: or just source them in directly:
$ . /etc/bash_completion or /path/to/file $ . /path/to/file
``` ```
hugo gen autocomplete [flags] hugo gen autocomplete [flags]
@ -35,7 +35,7 @@ hugo gen autocomplete [flags]
### Options ### Options
``` ```
--completionfile string autocompletion file (default "/etc/bash_completion.d/hugo.sh") --completionfile string autocompletion file (defaults to stdout)
-h, --help help for autocomplete -h, --help help for autocomplete
--type string autocompletion type (zsh, bash or fish) (default "bash") --type string autocompletion type (zsh, bash or fish) (default "bash")
``` ```
@ -60,6 +60,6 @@ hugo gen autocomplete [flags]
### SEE ALSO ### SEE ALSO
* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators. - [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.
###### Auto generated by spf13/cobra on 6-Jan-2021 ###### Auto generated by spf13/cobra on 6-Jan-2021