mirror of
https://github.com/podman-container-tools/podman.git
synced 2026-08-28 11:17:59 +00:00
b5d1d89a37
Allow automatic generation for shell completion scripts with the internal cobra functions (requires v1.0.0+). This should replace the handwritten completion scripts and even adds support for fish. With this approach it is less likley that completions and code are out of sync. We can now create the scripts with - podman completion bash - podman completion zsh - podman completion fish To test the completion run: source <(podman completion bash) The same works for podman-remote and podman --remote and it will complete your remote containers/images with the correct endpoints values from --url/--connection. The completion logic is written in go and provided by the cobra library. The completion functions lives in `cmd/podman/completion/completion.go`. The unit test at cmd/podman/shell_completion_test.go checks if each command and flag has an autocompletion function set. This prevents that commands and flags have no shell completion set. This commit does not replace the current autocompletion scripts. Closes #6440 Signed-off-by: Paul Holzinger <paul.holzinger@web.de>
93 lines
2.2 KiB
Go
93 lines
2.2 KiB
Go
package completion
|
|
|
|
import (
|
|
"fmt"
|
|
"io"
|
|
"os"
|
|
"strings"
|
|
|
|
commonComp "github.com/containers/common/pkg/completion"
|
|
"github.com/containers/podman/v2/cmd/podman/registry"
|
|
"github.com/containers/podman/v2/pkg/domain/entities"
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
const (
|
|
completionDescription = `Generate shell autocompletions.
|
|
Valid arguments are bash, zsh, and fish.
|
|
Please refer to the man page to see how you can load these completions.`
|
|
)
|
|
|
|
var (
|
|
file string
|
|
noDesc bool
|
|
shells = []string{"bash", "zsh", "fish"}
|
|
completionCmd = &cobra.Command{
|
|
Use: fmt.Sprintf("completion [options] {%s}", strings.Join(shells, "|")),
|
|
Short: "Generate shell autocompletions",
|
|
Long: completionDescription,
|
|
ValidArgs: shells,
|
|
Args: cobra.ExactValidArgs(1),
|
|
RunE: completion,
|
|
Example: `podman completion bash
|
|
podman completion zsh -f _podman
|
|
podman completion fish --no-desc`,
|
|
//dont show this command to users
|
|
Hidden: true,
|
|
}
|
|
)
|
|
|
|
func init() {
|
|
registry.Commands = append(registry.Commands, registry.CliCommand{
|
|
Mode: []entities.EngineMode{entities.ABIMode, entities.TunnelMode},
|
|
Command: completionCmd,
|
|
})
|
|
flags := completionCmd.Flags()
|
|
fileFlagName := "file"
|
|
flags.StringVarP(&file, fileFlagName, "f", "", "Output the completion to file rather than stdout.")
|
|
_ = completionCmd.RegisterFlagCompletionFunc(fileFlagName, commonComp.AutocompleteDefault)
|
|
|
|
flags.BoolVar(&noDesc, "no-desc", false, "Don't include descriptions in the completion output.")
|
|
}
|
|
|
|
func completion(cmd *cobra.Command, args []string) error {
|
|
var w io.Writer
|
|
|
|
if file != "" {
|
|
file, err := os.Create(file)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
defer file.Close()
|
|
w = file
|
|
} else {
|
|
w = os.Stdout
|
|
}
|
|
|
|
var err error
|
|
switch args[0] {
|
|
case "bash":
|
|
if noDesc {
|
|
err = cmd.Root().GenBashCompletion(w)
|
|
} else {
|
|
err = cmd.Root().GenBashCompletionWithDesc(w)
|
|
}
|
|
case "zsh":
|
|
if noDesc {
|
|
err = cmd.Root().GenZshCompletionNoDesc(w)
|
|
} else {
|
|
err = cmd.Root().GenZshCompletion(w)
|
|
}
|
|
case "fish":
|
|
err = cmd.Root().GenFishCompletion(w, !noDesc)
|
|
}
|
|
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
_, err = io.WriteString(w, fmt.Sprintf(
|
|
"\n# This file is generated with %q; see: podman-completion(1)\n", cmd.CommandPath(),
|
|
))
|
|
return err
|
|
}
|