gohugoio-hugo/commands/genautocomplete.go

// 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 or fish
	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.

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

	$ sudo hugo gen autocomplete

Add ` + "`--completionfile=/path/to/file`" + ` flag to set alternative
file-path and name.

Add ` + "`--type={bash, zsh or fish}`" + ` 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 "zsh":
				err = cmd.Root().GenZshCompletion(target)
			case "bash":
				err = cmd.Root().GenBashCompletion(target)
			case "fish":
				err = cmd.Root().GenFishCompletion(target, true)
			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 (zsh, bash or fish)")

	return cc
}