2915abc2ba
When ran directly in the terminal, the command now errors out with:
$ gh completion
error: the value for `--shell` is required
see `gh completion --help` for more information
This is to avoid the previously default bash code output confusing the
user if they ran the command out of curiousity.
A backwards compatibility layer is present here: if stdout is not a
terminal, then output bash code like before. This is to support users
who have already added a line like this to their bash profile:
eval "$(gh completion)"
66 lines
1.7 KiB
Go
66 lines
1.7 KiB
Go
package command
|
|
|
|
import (
|
|
"errors"
|
|
"fmt"
|
|
"os"
|
|
|
|
"github.com/cli/cli/internal/cobrafish"
|
|
"github.com/cli/cli/utils"
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
func init() {
|
|
RootCmd.AddCommand(completionCmd)
|
|
completionCmd.Flags().StringP("shell", "s", "", "Shell type: {bash|zsh|fish|powershell}")
|
|
}
|
|
|
|
var completionCmd = &cobra.Command{
|
|
Use: "completion",
|
|
Short: "Generate shell completion scripts",
|
|
Long: `Generate shell completion scripts for GitHub CLI commands.
|
|
|
|
The output of this command will be computer code and is meant to be saved to a
|
|
file or immediately evaluated by an interactive shell.
|
|
|
|
For example, for bash you could add this to your '~/.bash_profile':
|
|
|
|
eval "$(gh completion -s bash)"
|
|
|
|
When installing GitHub CLI through a package manager, however, it's possible that
|
|
no additional shell configuration is necessary to gain completion support. For
|
|
Homebrew, see <https://docs.brew.sh/Shell-Completion>
|
|
`,
|
|
RunE: func(cmd *cobra.Command, args []string) error {
|
|
shellType, err := cmd.Flags().GetString("shell")
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
if shellType == "" {
|
|
out := cmd.OutOrStdout()
|
|
isTTY := false
|
|
if outFile, isFile := out.(*os.File); isFile {
|
|
isTTY = utils.IsTerminal(outFile)
|
|
}
|
|
|
|
if isTTY {
|
|
return errors.New("error: the value for `--shell` is required\nsee `gh help completion` for more information")
|
|
}
|
|
shellType = "bash"
|
|
}
|
|
|
|
switch shellType {
|
|
case "bash":
|
|
return RootCmd.GenBashCompletion(cmd.OutOrStdout())
|
|
case "zsh":
|
|
return RootCmd.GenZshCompletion(cmd.OutOrStdout())
|
|
case "powershell":
|
|
return RootCmd.GenPowerShellCompletion(cmd.OutOrStdout())
|
|
case "fish":
|
|
return cobrafish.GenCompletion(RootCmd, cmd.OutOrStdout())
|
|
default:
|
|
return fmt.Errorf("unsupported shell type %q", shellType)
|
|
}
|
|
},
|
|
}
|