cli: disable file-completion by default

[thaJeztah]

• relates to Feature request: Set a default completion function spf13/cobra#2209
• relates to The default ShellCompDirective can be customized for a command and its subcommands spf13/cobra#2238
• relates to 06260e6#diff-50fe347eb4bdafebc190aa42b2caa34b089a538cd444b8a151a763372e93c0cf / Improve Cobra completions for run and create #5580
• depends on vendor github.com/spf13/pflag v1.0.10, github.com/spf13/cobra v1.10.1 #6429

cli: disable file-completion by default

This uses the DefaultShellCompDirective feature which was added
in cobra to override the default (which would complete to use
files for commands and flags).

cli-plugins: disable file-completion by default

This uses the DefaultShellCompDirective feature which was added
in cobra to override the default (which would complete to use
files for commands and flags).

- How I did it

- How to verify it

- Human readable description for the release notes

- A picture of a cute animal (not mandatory but encouraged)

[codecov-commenter]

Codecov Report

❌ Patch coverage is 66.66667% with 2 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
cli-plugins/plugin/plugin.go	0.00%	2 Missing ⚠️

📢 Thoughts on this report? Let us know!

[thaJeztah]

FWIW; this would allow us to remove uses of cobra.NoFileCompletions from command definitions, but I thought it was better to keep them to more clearly indicate "this is disabled by choice";

cli/cli/command/config/ls.go

Line 35 in c5467b5

ValidArgsFunction: cobra.NoFileCompletions,

I also considered adding a completion.TODO alias for that one, similar to context.TODO for places where we currently disable completion, but because it still has to be implemented.

[thaJeztah]

cc @crazy-max @ndeloof in case buildx or compose depends on the behavior to complete with filenames (for both commands and flags); I put the "disable for plugins" as a separate commit.

[crazy-max]

cc @crazy-max @ndeloof in case buildx or compose depends on the behavior to complete with filenames (for both commands and flags); I put the "disable for plugins" as a separate commit.

@thaJeztah For flags/cmds that need file completion in cli plugins I guess it needs follow-ups to opt-in with this implementation?

[thaJeztah]

Yes, probably; we can try when I update my PR that vendors the latest from master.

Currently the default is that any flag and any command that doesn't have completion configured will default to completing based on the filesystem; in MOST cases that's not desirable; for example, with buildx;

docker buildx build --platform<tab>
AUTHORS   codecov.yml      docs/    LICENSE      README.md  version/
bake/     commands/        driver/  localstate/  store/
bin/      controller/      foo/     MAINTAINERS  tests/
...

With this option set, the above will just "not provide completion", but of course some commands do want completion for files (or directories, or files with a specific extension), so for those, it will have to be explicitly enabled.

FWIW, I was considering adding a completion.TODO completion that would be the equivalent of "no (file) completion", similar to context.TODO() - that option would be for cases where we know completion is missing, and still has to be added, making it easier to find back places where work is still to do.