1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
|
package completion
import (
"fmt"
"github.com/MakeNowJust/heredoc/v2"
"gitlab.com/gitlab-org/cli/pkg/iostreams"
"github.com/spf13/cobra"
)
func NewCmdCompletion(io *iostreams.IOStreams) *cobra.Command {
var (
shellType string
// description will not be added if true
excludeDesc = false
)
completionCmd := &cobra.Command{
Use: "completion",
Short: "Generate shell completion scripts.",
Long: heredoc.Docf(`
This command outputs code meant to be saved to a file, or immediately
evaluated by an interactive shell. To load completions:
### Bash
To load completions in your current shell session:
%[2]splaintext
source <(glab completion -s bash)
%[2]s
To load completions for every new session, run this command one time:
#### Linux
%[2]splaintext
glab completion -s bash > /etc/bash_completion.d/glab
%[2]s
#### macOS
%[2]splaintext
glab completion -s bash > /usr/local/etc/bash_completion.d/glab
%[2]s
### Zsh
If shell completion is not already enabled in your environment you must
enable it. Run this command one time:
%[2]splaintext
echo "autoload -U compinit; compinit" >> ~/.zshrc
%[2]s
To load completions in your current shell session:
%[2]splaintext
source <(glab completion -s zsh); compdef _glab glab
%[2]s
To load completions for every new session, run this command one time:
#### Linux
%[2]splaintext
glab completion -s zsh > "${fpath[1]}/_glab"
%[2]s
#### macOS
For older versions of macOS, you might need this command:
%[2]splaintext
glab completion -s zsh > /usr/local/share/zsh/site-functions/_glab
%[2]s
The Homebrew version of glab should install completions automatically.
### fish
To load completions in your current shell session:
%[2]splaintext
glab completion -s fish | source
%[2]s
To load completions for every new session, run this command one time:
%[2]splaintext
glab completion -s fish > ~/.config/fish/completions/glab.fish
%[2]s
### PowerShell
To load completions in your current shell session:
%[2]splaintext
glab completion -s powershell | Out-String | Invoke-Expression
%[2]s
To load completions for every new session, add the output of the above command
to your PowerShell profile.
When installing glab through a package manager, however, you might not need
more shell configuration to support completions.
For Homebrew, see [brew shell completion](https://docs.brew.sh/Shell-Completion)
`, "`", "```"),
RunE: func(cmd *cobra.Command, args []string) error {
out := io.StdOut
rootCmd := cmd.Parent()
switch shellType {
case "bash":
return rootCmd.GenBashCompletionV2(out, !excludeDesc)
case "zsh":
if excludeDesc {
return rootCmd.GenZshCompletionNoDesc(out)
}
return rootCmd.GenZshCompletion(out)
case "powershell":
if excludeDesc {
return rootCmd.GenPowerShellCompletion(out)
}
return rootCmd.GenPowerShellCompletionWithDesc(out)
case "fish":
return rootCmd.GenFishCompletion(out, !excludeDesc)
default:
return fmt.Errorf("unsupported shell type %q", shellType)
}
},
}
completionCmd.Flags().StringVarP(&shellType, "shell", "s", "bash", "Shell type: bash, zsh, fish, powershell.")
completionCmd.Flags().BoolVarP(&excludeDesc, "no-desc", "", false, "Do not include shell completion description.")
return completionCmd
}
|
