mirror of
https://github.com/podman-container-tools/podman.git
synced 2026-08-07 09:25:43 +00:00
84da70a0f3
The new cobra v1.2.0 release brings a number of bug fixes for shell completion scripts. Regenerate the scripts with `make completions` to sync them with the upstream version, currently we have some custom ones to avoid some upstream bugs. Because the new cobra version has all fixes we should use the upstream scripts. Add a check to CI to ensure we always use the up to date scripts. [NO TESTS NEEDED] Signed-off-by: Paul Holzinger <pholzing@redhat.com>
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/v3/cmd/podman/registry"
|
|
"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", "powershell"}
|
|
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`,
|
|
//don't show this command to users
|
|
Hidden: true,
|
|
}
|
|
)
|
|
|
|
func init() {
|
|
registry.Commands = append(registry.Commands, registry.CliCommand{
|
|
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":
|
|
err = cmd.Root().GenBashCompletionV2(w, !noDesc)
|
|
case "zsh":
|
|
if noDesc {
|
|
err = cmd.Root().GenZshCompletionNoDesc(w)
|
|
} else {
|
|
err = cmd.Root().GenZshCompletion(w)
|
|
}
|
|
case "fish":
|
|
err = cmd.Root().GenFishCompletion(w, !noDesc)
|
|
case "powershell":
|
|
if noDesc {
|
|
err = cmd.Root().GenPowerShellCompletion(w)
|
|
} else {
|
|
err = cmd.Root().GenPowerShellCompletionWithDesc(w)
|
|
}
|
|
}
|
|
|
|
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
|
|
}
|