mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-07 20:30:36 -05:00
parent
5ca40c8f7c
commit
3336762939
7 changed files with 5 additions and 156 deletions
|
@ -274,11 +274,14 @@ func TestCommandsExecute(t *testing.T) {
|
||||||
// no args = hugo build
|
// no args = hugo build
|
||||||
{nil, []string{sourceFlag}, ""},
|
{nil, []string{sourceFlag}, ""},
|
||||||
{nil, []string{sourceFlag, "--renderToMemory"}, ""},
|
{nil, []string{sourceFlag, "--renderToMemory"}, ""},
|
||||||
|
{[]string{"completion", "bash"}, nil, ""},
|
||||||
|
{[]string{"completion", "fish"}, nil, ""},
|
||||||
|
{[]string{"completion", "powershell"}, nil, ""},
|
||||||
|
{[]string{"completion", "zsh"}, nil, ""},
|
||||||
{[]string{"config"}, []string{sourceFlag}, ""},
|
{[]string{"config"}, []string{sourceFlag}, ""},
|
||||||
{[]string{"convert", "toTOML"}, []string{sourceFlag, "-o=" + filepath.Join(dirOut, "toml")}, ""},
|
{[]string{"convert", "toTOML"}, []string{sourceFlag, "-o=" + filepath.Join(dirOut, "toml")}, ""},
|
||||||
{[]string{"convert", "toYAML"}, []string{sourceFlag, "-o=" + filepath.Join(dirOut, "yaml")}, ""},
|
{[]string{"convert", "toYAML"}, []string{sourceFlag, "-o=" + filepath.Join(dirOut, "yaml")}, ""},
|
||||||
{[]string{"convert", "toJSON"}, []string{sourceFlag, "-o=" + filepath.Join(dirOut, "json")}, ""},
|
{[]string{"convert", "toJSON"}, []string{sourceFlag, "-o=" + filepath.Join(dirOut, "json")}, ""},
|
||||||
{[]string{"gen", "autocomplete"}, []string{"--completionfile=" + filepath.Join(dirOut, "autocomplete.txt")}, ""},
|
|
||||||
{[]string{"gen", "chromastyles"}, []string{"--style=manni"}, ""},
|
{[]string{"gen", "chromastyles"}, []string{"--style=manni"}, ""},
|
||||||
{[]string{"gen", "doc"}, []string{"--dir=" + filepath.Join(dirOut, "doc")}, ""},
|
{[]string{"gen", "doc"}, []string{"--dir=" + filepath.Join(dirOut, "doc")}, ""},
|
||||||
{[]string{"gen", "man"}, []string{"--dir=" + filepath.Join(dirOut, "man")}, ""},
|
{[]string{"gen", "man"}, []string{"--dir=" + filepath.Join(dirOut, "man")}, ""},
|
||||||
|
|
|
@ -31,7 +31,6 @@ func newGenCmd() *genCmd {
|
||||||
})
|
})
|
||||||
|
|
||||||
cc.cmd.AddCommand(
|
cc.cmd.AddCommand(
|
||||||
newGenautocompleteCmd().getCommand(),
|
|
||||||
newGenDocCmd().getCommand(),
|
newGenDocCmd().getCommand(),
|
||||||
newGenManCmd().getCommand(),
|
newGenManCmd().getCommand(),
|
||||||
createGenDocsHelper().getCommand(),
|
createGenDocsHelper().getCommand(),
|
||||||
|
|
|
@ -1,93 +0,0 @@
|
||||||
// Copyright 2015 The Hugo Authors. All rights reserved.
|
|
||||||
//
|
|
||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
||||||
// you may not use this file except in compliance with the License.
|
|
||||||
// You may obtain a copy of the License at
|
|
||||||
// http://www.apache.org/licenses/LICENSE-2.0
|
|
||||||
//
|
|
||||||
// Unless required by applicable law or agreed to in writing, software
|
|
||||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
||||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
||||||
// See the License for the specific language governing permissions and
|
|
||||||
// limitations under the License.
|
|
||||||
|
|
||||||
package commands
|
|
||||||
|
|
||||||
import (
|
|
||||||
"io"
|
|
||||||
"os"
|
|
||||||
|
|
||||||
"github.com/spf13/cobra"
|
|
||||||
jww "github.com/spf13/jwalterweatherman"
|
|
||||||
)
|
|
||||||
|
|
||||||
var _ cmder = (*genautocompleteCmd)(nil)
|
|
||||||
|
|
||||||
type genautocompleteCmd struct {
|
|
||||||
autocompleteTarget string
|
|
||||||
|
|
||||||
// bash, zsh, fish or powershell
|
|
||||||
autocompleteType string
|
|
||||||
|
|
||||||
*baseCmd
|
|
||||||
}
|
|
||||||
|
|
||||||
func newGenautocompleteCmd() *genautocompleteCmd {
|
|
||||||
cc := &genautocompleteCmd{}
|
|
||||||
|
|
||||||
cc.baseCmd = newBaseCmd(&cobra.Command{
|
|
||||||
Use: "autocomplete",
|
|
||||||
Short: "Generate shell autocompletion script for Hugo",
|
|
||||||
Long: `Generates a shell autocompletion script for Hugo.
|
|
||||||
|
|
||||||
The script is written to the console (stdout).
|
|
||||||
|
|
||||||
To write to file, add the ` + "`--completionfile=/path/to/file`" + ` flag.
|
|
||||||
|
|
||||||
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 or /path/to/file`,
|
|
||||||
|
|
||||||
RunE: func(cmd *cobra.Command, args []string) 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 {
|
|
||||||
case "bash":
|
|
||||||
err = cmd.Root().GenBashCompletion(target)
|
|
||||||
case "zsh":
|
|
||||||
err = cmd.Root().GenZshCompletion(target)
|
|
||||||
case "fish":
|
|
||||||
err = cmd.Root().GenFishCompletion(target, true)
|
|
||||||
case "powershell":
|
|
||||||
err = cmd.Root().GenPowerShellCompletion(target)
|
|
||||||
default:
|
|
||||||
return newUserError("Unsupported completion type")
|
|
||||||
}
|
|
||||||
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
if cc.autocompleteTarget != "" {
|
|
||||||
jww.FEEDBACK.Println(cc.autocompleteType+" completion file for Hugo saved to", cc.autocompleteTarget)
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
},
|
|
||||||
})
|
|
||||||
|
|
||||||
cc.cmd.PersistentFlags().StringVarP(&cc.autocompleteTarget, "completionfile", "f", "", "autocompletion file, defaults to stdout")
|
|
||||||
cc.cmd.PersistentFlags().StringVarP(&cc.autocompleteType, "type", "t", "bash", "autocompletion type (bash, zsh, fish, or powershell)")
|
|
||||||
|
|
||||||
return cc
|
|
||||||
}
|
|
|
@ -68,7 +68,6 @@ hugo [flags]
|
||||||
|
|
||||||
### SEE ALSO
|
### SEE ALSO
|
||||||
|
|
||||||
* [hugo check](/commands/hugo_check/) - Contains some verification checks
|
|
||||||
* [hugo completion](/commands/hugo_completion/) - generate the autocompletion script for the specified shell
|
* [hugo completion](/commands/hugo_completion/) - generate the autocompletion script for the specified shell
|
||||||
* [hugo config](/commands/hugo_config/) - Print the site configuration
|
* [hugo config](/commands/hugo_config/) - Print the site configuration
|
||||||
* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats
|
* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats
|
||||||
|
|
|
@ -33,7 +33,6 @@ A collection of several useful generators.
|
||||||
### SEE ALSO
|
### SEE ALSO
|
||||||
|
|
||||||
* [hugo](/commands/hugo/) - hugo builds your site
|
* [hugo](/commands/hugo/) - hugo builds your site
|
||||||
* [hugo gen autocomplete](/commands/hugo_gen_autocomplete/) - Generate shell autocompletion script for Hugo
|
|
||||||
* [hugo gen chromastyles](/commands/hugo_gen_chromastyles/) - Generate CSS stylesheet for the Chroma code highlighter
|
* [hugo gen chromastyles](/commands/hugo_gen_chromastyles/) - Generate CSS stylesheet for the Chroma code highlighter
|
||||||
* [hugo gen doc](/commands/hugo_gen_doc/) - Generate Markdown documentation for the Hugo CLI.
|
* [hugo gen doc](/commands/hugo_gen_doc/) - Generate Markdown documentation for the Hugo CLI.
|
||||||
* [hugo gen man](/commands/hugo_gen_man/) - Generate man pages for the Hugo CLI
|
* [hugo gen man](/commands/hugo_gen_man/) - Generate man pages for the Hugo CLI
|
||||||
|
|
|
@ -1,58 +0,0 @@
|
||||||
---
|
|
||||||
title: "hugo gen autocomplete"
|
|
||||||
slug: hugo_gen_autocomplete
|
|
||||||
url: /commands/hugo_gen_autocomplete/
|
|
||||||
---
|
|
||||||
## hugo gen autocomplete
|
|
||||||
|
|
||||||
Generate shell autocompletion script for Hugo
|
|
||||||
|
|
||||||
### Synopsis
|
|
||||||
|
|
||||||
Generates a shell autocompletion script for Hugo.
|
|
||||||
|
|
||||||
The script is written to the console (stdout).
|
|
||||||
|
|
||||||
To write to file, add the `--completionfile=/path/to/file` flag.
|
|
||||||
|
|
||||||
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 or /path/to/file
|
|
||||||
|
|
||||||
```
|
|
||||||
hugo gen autocomplete [flags]
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options
|
|
||||||
|
|
||||||
```
|
|
||||||
-f, --completionfile string autocompletion file, defaults to stdout
|
|
||||||
-h, --help help for autocomplete
|
|
||||||
-t, --type string autocompletion type (bash, zsh, fish, or powershell) (default "bash")
|
|
||||||
```
|
|
||||||
|
|
||||||
### Options inherited from parent commands
|
|
||||||
|
|
||||||
```
|
|
||||||
--config string config file (default is path/config.yaml|json|toml)
|
|
||||||
--configDir string config dir (default "config")
|
|
||||||
--debug debug output
|
|
||||||
-e, --environment string build environment
|
|
||||||
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
|
|
||||||
--log enable Logging
|
|
||||||
--logFile string log File path (if set, logging enabled automatically)
|
|
||||||
--quiet build in quiet mode
|
|
||||||
-s, --source string filesystem path to read files relative from
|
|
||||||
--themesDir string filesystem path to themes directory
|
|
||||||
-v, --verbose verbose output
|
|
||||||
--verboseLog verbose logging
|
|
||||||
```
|
|
||||||
|
|
||||||
### SEE ALSO
|
|
||||||
|
|
||||||
* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.
|
|
||||||
|
|
|
@ -65,7 +65,7 @@ parts:
|
||||||
ldd hugo || :
|
ldd hugo || :
|
||||||
|
|
||||||
echo " * Building shell completion..."
|
echo " * Building shell completion..."
|
||||||
./hugo gen autocomplete --completionfile=hugo-completion
|
./hugo completion bash > hugo-completion
|
||||||
|
|
||||||
echo " * Installing to ${SNAPCRAFT_PART_INSTALL}..."
|
echo " * Installing to ${SNAPCRAFT_PART_INSTALL}..."
|
||||||
install -d $SNAPCRAFT_PART_INSTALL/bin
|
install -d $SNAPCRAFT_PART_INSTALL/bin
|
||||||
|
|
Loading…
Reference in a new issue