24062067765

Committed 07 Apr 2026 02:47AM UTC coverage: 80.377% (-0.2%) from 80.62%

Build # 24062067765

Build Type

Pull #5587

github

Committed by

vitorfloriano

Commit Message

feat(cli): show hint when file completion not applicable

When hitting TAB on subcommands that don't
take files as arguments, the cli will show a
hint message (ActiveHelp) on how to list flags
instead of showing file completions.

Pull Request Pull Request #5587: ✨ feat(cli): Show hint message when file completion not applicable to subcommand

Coverage Stats

8 of 33 new or added lines in 5 files covered. (24.24%)

6558 of 8159 relevant lines covered (80.38%)

45.86 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

70.59

/pkg/cli/version.go

/*
Copyright 2020 The Kubernetes Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package cli

import (
        "fmt"

        "github.com/spf13/cobra"
)

func (c CLI) newVersionCmd() *cobra.Command {
        cmd := &cobra.Command{
                Use:     "version",
                Short:   fmt.Sprintf("Print the %s version", c.commandName),
                Long:    fmt.Sprintf("Print the %s version", c.commandName),
                Example: fmt.Sprintf("%s version", c.commandName),
                RunE: func(_ *cobra.Command, _ []string) error {
                        fmt.Println(c.version)
                        return nil
                },
        }

        // Show hint message on how to list flags instead of showing file completion for commands that don't take files as arguments
        cmd.ValidArgsFunction = func(cmd *cobra.Command, args []string, toComplete string) ([]cobra.Completion, cobra.ShellCompDirective) {
                completions := []cobra.Completion{}
                if len(args) == 0 && toComplete == "" {
                        completions = cobra.AppendActiveHelp(completions, "Type '--' and press TAB to list flags")
                }
                return completions, cobra.ShellCompDirectiveNoFileComp
        }

        return cmd
}

1	/*
2	Copyright 2020 The Kubernetes Authors.
3
4	Licensed under the Apache License, Version 2.0 (the "License");
5	you may not use this file except in compliance with the License.
6	You may obtain a copy of the License at
7
8	http://www.apache.org/licenses/LICENSE-2.0
9
10	Unless required by applicable law or agreed to in writing, software
11	distributed under the License is distributed on an "AS IS" BASIS,
12	WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13	See the License for the specific language governing permissions and
14	limitations under the License.
15	*/
16
17	package cli
18
19	import (
20	"fmt"
21
22	"github.com/spf13/cobra"
23	)
24
25	func (c CLI) newVersionCmd() *cobra.Command {	2✔
26	cmd := &cobra.Command{	2✔
27	Use: "version",	2✔
28	Short: fmt.Sprintf("Print the %s version", c.commandName),	2✔
29	Long: fmt.Sprintf("Print the %s version", c.commandName),	2✔
30	Example: fmt.Sprintf("%s version", c.commandName),	2✔
31	RunE: func(_ *cobra.Command, _ []string) error {	3✔
32	fmt.Println(c.version)	1✔
33	return nil	1✔
34	},	1✔
35	}
36
37	// Show hint message on how to list flags instead of showing file completion for commands that don't take files as arguments
38	cmd.ValidArgsFunction = func(cmd *cobra.Command, args []string, toComplete string) ([]cobra.Completion, cobra.ShellCompDirective) {	2✔
NEW 39	completions := []cobra.Completion{}	×
NEW 40	if len(args) == 0 && toComplete == "" {	×
NEW 41	completions = cobra.AppendActiveHelp(completions, "Type '--' and press TAB to list flags")	×
NEW 42	}	×
NEW 43	return completions, cobra.ShellCompDirectiveNoFileComp	×
44	}
45
46	return cmd	2✔
47	}

kubernetes-sigs / kubebuilder / 24062067765

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous