mirror of
https://github.com/podman-container-tools/podman.git
synced 2026-08-26 10:17:53 +00:00
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>
38 lines
1.2 KiB
Go
38 lines
1.2 KiB
Go
package registry
|
|
|
|
import (
|
|
"os"
|
|
"sync"
|
|
|
|
"github.com/containers/podman/v2/pkg/domain/entities"
|
|
"github.com/spf13/cobra"
|
|
"github.com/spf13/pflag"
|
|
)
|
|
|
|
// Value for --remote given on command line
|
|
var remoteFromCLI = struct {
|
|
Value bool
|
|
sync sync.Once
|
|
}{}
|
|
|
|
// IsRemote returns true if podman was built to run remote or --remote flag given on CLI
|
|
// Use in init() functions as an initialization check
|
|
func IsRemote() bool {
|
|
remoteFromCLI.sync.Do(func() {
|
|
fs := pflag.NewFlagSet("remote", pflag.ContinueOnError)
|
|
fs.ParseErrorsWhitelist.UnknownFlags = true
|
|
fs.Usage = func() {}
|
|
fs.SetInterspersed(false)
|
|
fs.BoolVarP(&remoteFromCLI.Value, "remote", "r", false, "")
|
|
|
|
// The shell completion logic will call a command called "__complete" or "__completeNoDesc"
|
|
// This command will always be the second argument
|
|
// To still parse --remote correctly in this case we have to set args offset to two in this case
|
|
start := 1
|
|
if len(os.Args) > 1 && (os.Args[1] == cobra.ShellCompRequestCmd || os.Args[1] == cobra.ShellCompNoDescRequestCmd) {
|
|
start = 2
|
|
}
|
|
_ = fs.Parse(os.Args[start:])
|
|
})
|
|
return podmanOptions.EngineMode == entities.TunnelMode || remoteFromCLI.Value
|
|
}
|