Skip to content

Commit 3f9cf0e

Browse files
authored
feat: add fish and zsh completion support (#207)
Signed-off-by: Rui Chen <[email protected]>
1 parent 9b3c3da commit 3f9cf0e

File tree

3 files changed

+109
-1
lines changed

3 files changed

+109
-1
lines changed

internal/commands/completion/completion.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,11 @@ import (
2323

2424
var Command = &cli.Command{
2525
Name: "completion",
26-
Usage: "Output shell completion code for bash and powershell",
26+
Usage: "Output shell completion code for bash, zsh, fish, and powershell",
2727
Subcommands: []*cli.Command{
2828
bashCommand,
29+
fishCommand,
30+
zshCommand,
2931
powershellCommand,
3032
},
3133
}
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
// Licensed to Apache Software Foundation (ASF) under one or more contributor
2+
// license agreements. See the NOTICE file distributed with
3+
// this work for additional information regarding copyright
4+
// ownership. Apache Software Foundation (ASF) licenses this file to you under
5+
// the Apache License, Version 2.0 (the "License"); you may
6+
// not use this file except in compliance with the License.
7+
// You may obtain a copy of the License at
8+
//
9+
// http://www.apache.org/licenses/LICENSE-2.0
10+
//
11+
// Unless required by applicable law or agreed to in writing,
12+
// software distributed under the License is distributed on an
13+
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
// KIND, either express or implied. See the License for the
15+
// specific language governing permissions and limitations
16+
// under the License.
17+
18+
package completion
19+
20+
import (
21+
"fmt"
22+
23+
"github.com/urfave/cli/v2"
24+
)
25+
26+
var fishCommand = &cli.Command{
27+
Name: "fish",
28+
Aliases: []string{"f"},
29+
Usage: "Output shell completion code for fish",
30+
ArgsUsage: "[parameters...]",
31+
Action: func(ctx *cli.Context) error {
32+
fmt.Print(fishScript)
33+
return nil
34+
},
35+
}
36+
37+
const fishScript = `
38+
function __fish_swctl_complete
39+
set -l command (commandline -cp)
40+
set -l last_token (commandline -ct)
41+
42+
if test "$last_token" = ""
43+
return
44+
end
45+
46+
# Get completions using the auto-complete flag
47+
set -l completions (eval "$command --auto_complete" 2> /dev/null)
48+
49+
for completion in $completions
50+
echo -e "$completion\t(swctl suggestion)"
51+
end
52+
end
53+
54+
complete -c swctl -f -a "(__fish_swctl_complete)"
55+
`
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
// Licensed to Apache Software Foundation (ASF) under one or more contributor
2+
// license agreements. See the NOTICE file distributed with
3+
// this work for additional information regarding copyright
4+
// ownership. Apache Software Foundation (ASF) licenses this file to you under
5+
// the Apache License, Version 2.0 (the "License"); you may
6+
// not use this file except in compliance with the License.
7+
// You may obtain a copy of the License at
8+
//
9+
// http://www.apache.org/licenses/LICENSE-2.0
10+
//
11+
// Unless required by applicable law or agreed to in writing,
12+
// software distributed under the License is distributed on an
13+
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
// KIND, either express or implied. See the License for the
15+
// specific language governing permissions and limitations
16+
// under the License.
17+
18+
package completion
19+
20+
import (
21+
"fmt"
22+
23+
"github.com/urfave/cli/v2"
24+
)
25+
26+
var zshCommand = &cli.Command{
27+
Name: "zsh",
28+
Aliases: []string{"z"},
29+
Usage: "Output shell completion code for zsh",
30+
ArgsUsage: "[parameters...]",
31+
Action: func(ctx *cli.Context) error {
32+
fmt.Print(zshScript)
33+
return nil
34+
},
35+
}
36+
37+
const zshScript = `
38+
#compdef swctl
39+
40+
_cli_zsh_autocomplete() {
41+
local -a completions
42+
local word
43+
44+
word="${words[CURRENT]}"
45+
completions=("${(@f)$( ${words[1,CURRENT-1]} --auto_complete )}")
46+
47+
_describe -t commands 'swctl commands' completions
48+
}
49+
50+
compdef _cli_zsh_autocomplete swctl
51+
`

0 commit comments

Comments
 (0)