cli: set default completion

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
pull/1727/head
CrazyMax 2 years ago committed by CrazyMax
parent 1e149bb84f
commit 8a02cf8717
No known key found for this signature in database
GPG Key ID: 3248E46B6BB8C7F7

@ -23,6 +23,7 @@ import (
"github.com/docker/buildx/store" "github.com/docker/buildx/store"
"github.com/docker/buildx/store/storeutil" "github.com/docker/buildx/store/storeutil"
"github.com/docker/buildx/util/buildflags" "github.com/docker/buildx/util/buildflags"
"github.com/docker/buildx/util/cobrautil/completion"
"github.com/docker/buildx/util/ioset" "github.com/docker/buildx/util/ioset"
"github.com/docker/buildx/util/progress" "github.com/docker/buildx/util/progress"
"github.com/docker/buildx/util/tracing" "github.com/docker/buildx/util/tracing"
@ -253,6 +254,7 @@ func buildCmd(dockerCli command.Cli, rootOpts *rootOptions) *cobra.Command {
} }
return runBuild(dockerCli, options) return runBuild(dockerCli, options)
}, },
ValidArgsFunction: completion.Disable,
} }
var platformsDefault []string var platformsDefault []string

@ -17,6 +17,7 @@ import (
"github.com/docker/buildx/store" "github.com/docker/buildx/store"
"github.com/docker/buildx/store/storeutil" "github.com/docker/buildx/store/storeutil"
"github.com/docker/buildx/util/cobrautil" "github.com/docker/buildx/util/cobrautil"
"github.com/docker/buildx/util/cobrautil/completion"
"github.com/docker/buildx/util/confutil" "github.com/docker/buildx/util/confutil"
"github.com/docker/buildx/util/dockerutil" "github.com/docker/buildx/util/dockerutil"
"github.com/docker/cli/cli" "github.com/docker/cli/cli"
@ -319,6 +320,7 @@ func createCmd(dockerCli command.Cli) *cobra.Command {
RunE: func(cmd *cobra.Command, args []string) error { RunE: func(cmd *cobra.Command, args []string) error {
return runCreate(dockerCli, options, args) return runCreate(dockerCli, options, args)
}, },
ValidArgsFunction: completion.Disable,
} }
flags := cmd.Flags() flags := cmd.Flags()

@ -9,6 +9,7 @@ import (
"time" "time"
"github.com/docker/buildx/builder" "github.com/docker/buildx/builder"
"github.com/docker/buildx/util/cobrautil/completion"
"github.com/docker/cli/cli" "github.com/docker/cli/cli"
"github.com/docker/cli/cli/command" "github.com/docker/cli/cli/command"
"github.com/docker/cli/opts" "github.com/docker/cli/opts"
@ -115,6 +116,7 @@ func duCmd(dockerCli command.Cli, rootOpts *rootOptions) *cobra.Command {
options.builder = rootOpts.builder options.builder = rootOpts.builder
return runDiskUsage(dockerCli, options) return runDiskUsage(dockerCli, options)
}, },
ValidArgsFunction: completion.Disable,
} }
flags := cmd.Flags() flags := cmd.Flags()

@ -8,6 +8,7 @@ import (
"strings" "strings"
"github.com/docker/buildx/builder" "github.com/docker/buildx/builder"
"github.com/docker/buildx/util/cobrautil/completion"
"github.com/docker/buildx/util/imagetools" "github.com/docker/buildx/util/imagetools"
"github.com/docker/buildx/util/progress" "github.com/docker/buildx/util/progress"
"github.com/docker/cli/cli/command" "github.com/docker/cli/cli/command"
@ -273,6 +274,7 @@ func createCmd(dockerCli command.Cli, opts RootOptions) *cobra.Command {
options.builder = *opts.Builder options.builder = *opts.Builder
return runCreate(dockerCli, options, args) return runCreate(dockerCli, options, args)
}, },
ValidArgsFunction: completion.Disable,
} }
flags := cmd.Flags() flags := cmd.Flags()

@ -2,6 +2,7 @@ package commands
import ( import (
"github.com/docker/buildx/builder" "github.com/docker/buildx/builder"
"github.com/docker/buildx/util/cobrautil/completion"
"github.com/docker/buildx/util/imagetools" "github.com/docker/buildx/util/imagetools"
"github.com/docker/cli-docs-tool/annotation" "github.com/docker/cli-docs-tool/annotation"
"github.com/docker/cli/cli" "github.com/docker/cli/cli"
@ -52,6 +53,7 @@ func inspectCmd(dockerCli command.Cli, rootOpts RootOptions) *cobra.Command {
options.builder = *rootOpts.Builder options.builder = *rootOpts.Builder
return runInspect(dockerCli, options, args[0]) return runInspect(dockerCli, options, args[0])
}, },
ValidArgsFunction: completion.Disable,
} }
flags := cmd.Flags() flags := cmd.Flags()

@ -1,6 +1,7 @@
package commands package commands
import ( import (
"github.com/docker/buildx/util/cobrautil/completion"
"github.com/docker/cli/cli/command" "github.com/docker/cli/cli/command"
"github.com/spf13/cobra" "github.com/spf13/cobra"
) )
@ -11,8 +12,9 @@ type RootOptions struct {
func RootCmd(dockerCli command.Cli, opts RootOptions) *cobra.Command { func RootCmd(dockerCli command.Cli, opts RootOptions) *cobra.Command {
cmd := &cobra.Command{ cmd := &cobra.Command{
Use: "imagetools", Use: "imagetools",
Short: "Commands to work on images in registry", Short: "Commands to work on images in registry",
ValidArgsFunction: completion.Disable,
} }
cmd.AddCommand( cmd.AddCommand(

@ -9,6 +9,7 @@ import (
"time" "time"
"github.com/docker/buildx/builder" "github.com/docker/buildx/builder"
"github.com/docker/buildx/util/cobrautil/completion"
"github.com/docker/buildx/util/platformutil" "github.com/docker/buildx/util/platformutil"
"github.com/docker/cli/cli" "github.com/docker/cli/cli"
"github.com/docker/cli/cli/command" "github.com/docker/cli/cli/command"
@ -112,6 +113,7 @@ func inspectCmd(dockerCli command.Cli, rootOpts *rootOptions) *cobra.Command {
} }
return runInspect(dockerCli, options) return runInspect(dockerCli, options)
}, },
ValidArgsFunction: completion.Disable,
} }
flags := cmd.Flags() flags := cmd.Flags()

@ -4,6 +4,7 @@ import (
"os" "os"
"github.com/docker/buildx/util/cobrautil" "github.com/docker/buildx/util/cobrautil"
"github.com/docker/buildx/util/cobrautil/completion"
"github.com/docker/cli/cli" "github.com/docker/cli/cli"
"github.com/docker/cli/cli/command" "github.com/docker/cli/cli/command"
"github.com/docker/cli/cli/config" "github.com/docker/cli/cli/config"
@ -46,7 +47,8 @@ func installCmd(dockerCli command.Cli) *cobra.Command {
RunE: func(cmd *cobra.Command, args []string) error { RunE: func(cmd *cobra.Command, args []string) error {
return runInstall(dockerCli, options) return runInstall(dockerCli, options)
}, },
Hidden: true, Hidden: true,
ValidArgsFunction: completion.Disable,
} }
// hide builder persistent flag for this command // hide builder persistent flag for this command

@ -11,6 +11,7 @@ import (
"github.com/docker/buildx/builder" "github.com/docker/buildx/builder"
"github.com/docker/buildx/store/storeutil" "github.com/docker/buildx/store/storeutil"
"github.com/docker/buildx/util/cobrautil" "github.com/docker/buildx/util/cobrautil"
"github.com/docker/buildx/util/cobrautil/completion"
"github.com/docker/buildx/util/platformutil" "github.com/docker/buildx/util/platformutil"
"github.com/docker/cli/cli" "github.com/docker/cli/cli"
"github.com/docker/cli/cli/command" "github.com/docker/cli/cli/command"
@ -126,6 +127,7 @@ func lsCmd(dockerCli command.Cli) *cobra.Command {
RunE: func(cmd *cobra.Command, args []string) error { RunE: func(cmd *cobra.Command, args []string) error {
return runLs(dockerCli, options) return runLs(dockerCli, options)
}, },
ValidArgsFunction: completion.Disable,
} }
// hide builder persistent flag for this command // hide builder persistent flag for this command

@ -8,6 +8,7 @@ import (
"time" "time"
"github.com/docker/buildx/builder" "github.com/docker/buildx/builder"
"github.com/docker/buildx/util/cobrautil/completion"
"github.com/docker/cli/cli" "github.com/docker/cli/cli"
"github.com/docker/cli/cli/command" "github.com/docker/cli/cli/command"
"github.com/docker/cli/opts" "github.com/docker/cli/opts"
@ -139,6 +140,7 @@ func pruneCmd(dockerCli command.Cli, rootOpts *rootOptions) *cobra.Command {
options.builder = rootOpts.builder options.builder = rootOpts.builder
return runPrune(dockerCli, options) return runPrune(dockerCli, options)
}, },
ValidArgsFunction: completion.Disable,
} }
flags := cmd.Flags() flags := cmd.Flags()

@ -8,6 +8,7 @@ import (
"github.com/docker/buildx/builder" "github.com/docker/buildx/builder"
"github.com/docker/buildx/store" "github.com/docker/buildx/store"
"github.com/docker/buildx/store/storeutil" "github.com/docker/buildx/store/storeutil"
"github.com/docker/buildx/util/cobrautil/completion"
"github.com/docker/cli/cli" "github.com/docker/cli/cli"
"github.com/docker/cli/cli/command" "github.com/docker/cli/cli/command"
"github.com/moby/buildkit/util/appcontext" "github.com/moby/buildkit/util/appcontext"
@ -92,6 +93,7 @@ func rmCmd(dockerCli command.Cli, rootOpts *rootOptions) *cobra.Command {
} }
return runRm(dockerCli, options) return runRm(dockerCli, options)
}, },
ValidArgsFunction: completion.Disable,
} }
flags := cmd.Flags() flags := cmd.Flags()

@ -23,6 +23,9 @@ func NewRootCmd(name string, isPlugin bool, dockerCli command.Cli) *cobra.Comman
Annotations: map[string]string{ Annotations: map[string]string{
annotation.CodeDelimiter: `"`, annotation.CodeDelimiter: `"`,
}, },
CompletionOptions: cobra.CompletionOptions{
HiddenDefaultCmd: true,
},
} }
if isPlugin { if isPlugin {
cmd.PersistentPreRunE = func(cmd *cobra.Command, args []string) error { cmd.PersistentPreRunE = func(cmd *cobra.Command, args []string) error {

@ -4,6 +4,7 @@ import (
"context" "context"
"github.com/docker/buildx/builder" "github.com/docker/buildx/builder"
"github.com/docker/buildx/util/cobrautil/completion"
"github.com/docker/cli/cli" "github.com/docker/cli/cli"
"github.com/docker/cli/cli/command" "github.com/docker/cli/cli/command"
"github.com/moby/buildkit/util/appcontext" "github.com/moby/buildkit/util/appcontext"
@ -46,6 +47,7 @@ func stopCmd(dockerCli command.Cli, rootOpts *rootOptions) *cobra.Command {
} }
return runStop(dockerCli, options) return runStop(dockerCli, options)
}, },
ValidArgsFunction: completion.Disable,
} }
return cmd return cmd

@ -4,6 +4,7 @@ import (
"os" "os"
"github.com/docker/buildx/util/cobrautil" "github.com/docker/buildx/util/cobrautil"
"github.com/docker/buildx/util/cobrautil/completion"
"github.com/docker/cli/cli" "github.com/docker/cli/cli"
"github.com/docker/cli/cli/command" "github.com/docker/cli/cli/command"
"github.com/docker/cli/cli/config" "github.com/docker/cli/cli/config"
@ -52,7 +53,8 @@ func uninstallCmd(dockerCli command.Cli) *cobra.Command {
RunE: func(cmd *cobra.Command, args []string) error { RunE: func(cmd *cobra.Command, args []string) error {
return runUninstall(dockerCli, options) return runUninstall(dockerCli, options)
}, },
Hidden: true, Hidden: true,
ValidArgsFunction: completion.Disable,
} }
// hide builder persistent flag for this command // hide builder persistent flag for this command

@ -4,6 +4,7 @@ import (
"os" "os"
"github.com/docker/buildx/store/storeutil" "github.com/docker/buildx/store/storeutil"
"github.com/docker/buildx/util/cobrautil/completion"
"github.com/docker/buildx/util/dockerutil" "github.com/docker/buildx/util/dockerutil"
"github.com/docker/cli/cli" "github.com/docker/cli/cli"
"github.com/docker/cli/cli/command" "github.com/docker/cli/cli/command"
@ -78,6 +79,7 @@ func useCmd(dockerCli command.Cli, rootOpts *rootOptions) *cobra.Command {
} }
return runUse(dockerCli, options) return runUse(dockerCli, options)
}, },
ValidArgsFunction: completion.Disable,
} }
flags := cmd.Flags() flags := cmd.Flags()

@ -4,6 +4,7 @@ import (
"fmt" "fmt"
"github.com/docker/buildx/util/cobrautil" "github.com/docker/buildx/util/cobrautil"
"github.com/docker/buildx/util/cobrautil/completion"
"github.com/docker/buildx/version" "github.com/docker/buildx/version"
"github.com/docker/cli/cli" "github.com/docker/cli/cli"
"github.com/docker/cli/cli/command" "github.com/docker/cli/cli/command"
@ -23,6 +24,7 @@ func versionCmd(dockerCli command.Cli) *cobra.Command {
RunE: func(cmd *cobra.Command, args []string) error { RunE: func(cmd *cobra.Command, args []string) error {
return runVersion(dockerCli) return runVersion(dockerCli)
}, },
ValidArgsFunction: completion.Disable,
} }
// hide builder persistent flag for this command // hide builder persistent flag for this command

@ -0,0 +1,12 @@
package completion
import (
"github.com/spf13/cobra"
)
// ValidArgsFn defines a completion func to be returned to fetch completion options
type ValidArgsFn func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)
func Disable(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
return nil, cobra.ShellCompDirectiveNoSpace
}
Loading…
Cancel
Save