Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: disable shell completion if double dash is included in arguments (v3) #1933

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions help.go
Original file line number Diff line number Diff line change
Expand Up @@ -454,6 +454,15 @@ func checkShellCompleteFlag(c *Command, arguments []string) (bool, []string) {
return false, arguments
}

for _, arg := range arguments {
// If arguments include "--", shell completion is disabled
// because after "--" only positional arguments are accepted.
// https://unix.stackexchange.com/a/11382
if arg == "--" {
return false, arguments
}
}

return true, arguments[:pos]
}

Expand Down
65 changes: 65 additions & 0 deletions help_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -1662,3 +1662,68 @@ GLOBAL OPTIONS:

`, output.String())
}

func Test_checkShellCompleteFlag(t *testing.T) {
t.Parallel()
tests := []struct {
name string
cmd *Command
arguments []string
wantShellCompletion bool
wantArgs []string
}{
{
name: "disable-shell-completion",
arguments: []string{"--generate-shell-completion"},
cmd: &Command{},
wantShellCompletion: false,
wantArgs: []string{"--generate-shell-completion"},
},
{
name: "child-disable-shell-completion",
arguments: []string{"--generate-shell-completion"},
cmd: &Command{
parent: &Command{},
},
wantShellCompletion: false,
wantArgs: []string{"--generate-shell-completion"},
},
{
name: "last argument isn't --generate-shell-completion",
arguments: []string{"foo"},
cmd: &Command{
EnableShellCompletion: true,
},
wantShellCompletion: false,
wantArgs: []string{"foo"},
},
{
name: "arguments include double dash",
arguments: []string{"--", "foo", "--generate-shell-completion"},
cmd: &Command{
EnableShellCompletion: true,
},
wantShellCompletion: false,
wantArgs: []string{"--", "foo", "--generate-shell-completion"},
},
{
name: "shell completion",
arguments: []string{"foo", "--generate-shell-completion"},
cmd: &Command{
EnableShellCompletion: true,
},
wantShellCompletion: true,
wantArgs: []string{"foo"},
},
}

for _, tt := range tests {
tt := tt
t.Run(tt.name, func(t *testing.T) {
t.Parallel()
shellCompletion, args := checkShellCompleteFlag(tt.cmd, tt.arguments)
assert.Equal(t, tt.wantShellCompletion, shellCompletion)
assert.Equal(t, tt.wantArgs, args)
})
}
}
Loading