-
Notifications
You must be signed in to change notification settings - Fork 152
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
11 changed files
with
405 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 | ||
| 🟥🟥🟥 STDERR️️ 🟥🟥🟥️ | ||
| Start shell mode | ||
|
|
||
| USAGE: | ||
| scw shell | ||
|
|
||
| FLAGS: | ||
| -h, --help help for shell |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| <!-- DO NOT EDIT: this file is automatically generated using scw-doc-gen --> | ||
| # Documentation for `scw shell` | ||
| Start shell mode | ||
|
|
||
|
|
||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,274 @@ | ||
| package core | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "os" | ||
| "sort" | ||
| "strconv" | ||
| "strings" | ||
|
|
||
| "github.com/c-bata/go-prompt" | ||
| "github.com/scaleway/scaleway-cli/v2/internal/interactive" | ||
| "github.com/spf13/cobra" | ||
| ) | ||
|
|
||
| type Completer struct { | ||
| ctx context.Context | ||
| } | ||
|
|
||
| type ShellSuggestion struct { | ||
| Text string | ||
| Arg *ArgSpec | ||
| Cmd *Command | ||
| } | ||
|
|
||
| // lastArg returns last element of string or empty string | ||
| func lastArg(args []string) string { | ||
| l := len(args) | ||
| if l >= 2 { | ||
| return args[l-1] | ||
| } | ||
| if l == 1 { | ||
| return args[0] | ||
| } | ||
| return "" | ||
| } | ||
|
|
||
| // firstArg returns first element of list or empty string | ||
| func firstArg(args []string) string { | ||
| l := len(args) | ||
| if l >= 1 { | ||
| return args[0] | ||
| } | ||
| return "" | ||
| } | ||
|
|
||
| // trimLastArg returns all arguments but the last one | ||
| // return a nil slice if there is no previous arguments | ||
| func trimLastArg(args []string) []string { | ||
| l := len(args) | ||
| if l > 1 { | ||
| return args[:l-1] | ||
| } | ||
| return []string(nil) | ||
| } | ||
|
|
||
| // argIsOption returns if an argument is an option | ||
| func argIsOption(arg string) bool { | ||
| return strings.Contains(arg, "=") || strings.Contains(arg, ".") | ||
| } | ||
|
|
||
| // removeOptions removes options from a list of argument | ||
| // ex: scw instance create name=myserver | ||
| // will be changed to: scw instance server create | ||
| func removeOptions(args []string) []string { | ||
| filteredArgs := []string(nil) | ||
| for _, arg := range args { | ||
| if !argIsOption(arg) { | ||
| filteredArgs = append(filteredArgs, arg) | ||
| } | ||
| } | ||
| return filteredArgs | ||
| } | ||
|
|
||
| // optionToArgSpecName convert option to arg spec name | ||
| // from additional-volumes.0=hello to additional-volumes.{index} | ||
| // also with multiple indexes pools.0.kubelet-args. to pools.{index}.kubelet-args.{key} | ||
| func optionToArgSpecName(option string) string { | ||
| optionName := strings.Split(option, "=")[0] | ||
|
|
||
| if strings.Contains(optionName, ".") { | ||
| // If option is formatted like "additional-volumes.0" | ||
| // it should be converted to "additional-volumes.{index} | ||
| elems := strings.Split(optionName, ".") | ||
| for i := range elems { | ||
| _, err := strconv.Atoi(elems[i]) | ||
| if err == nil { | ||
| elems[i] = "{index}" | ||
| } | ||
| } | ||
| if elems[len(elems)-1] == "" { | ||
| elems[len(elems)-1] = "{key}" | ||
| } | ||
| optionName = strings.Join(elems, ".") | ||
| } | ||
| return optionName | ||
| } | ||
|
|
||
| // getCommand return command object from args and suggest | ||
| func getCommand(meta *meta, args []string, suggest string) *Command { | ||
| rawCommand := removeOptions(args) | ||
| suggestIsOption := argIsOption(suggest) | ||
|
|
||
| if !suggestIsOption { | ||
| rawCommand = append(rawCommand, suggest) | ||
| } | ||
|
|
||
| command, foundCommand := meta.Commands.find(rawCommand...) | ||
| if foundCommand { | ||
| return command | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| // getSuggestDescription will return suggest description | ||
| // it will return command description if it is a command | ||
| // or option description if suggest is an option of a command | ||
| func getSuggestDescription(meta *meta, args []string, suggest string) string { | ||
| isOption := argIsOption(suggest) | ||
|
|
||
| command := getCommand(meta, args, suggest) | ||
| if command == nil { | ||
| return "command not found" | ||
| } | ||
|
|
||
| if isOption { | ||
| option := command.ArgSpecs.GetByName(optionToArgSpecName(suggest)) | ||
| if option != nil { | ||
| return option.Short | ||
| } | ||
| } else { | ||
| return command.Short | ||
| } | ||
|
|
||
| return "" | ||
| } | ||
|
|
||
| // sortOptions sorts options, putting required first then order alphabetically | ||
| func sortOptions(meta *meta, args []string, toSuggest string, suggestions []string) []string { | ||
| command := getCommand(meta, args, toSuggest) | ||
| if command == nil { | ||
| return suggestions | ||
| } | ||
|
|
||
| argSpecs := []ShellSuggestion(nil) | ||
| for _, suggest := range suggestions { | ||
| argSpec := command.ArgSpecs.GetByName(optionToArgSpecName(suggest)) | ||
| argSpecs = append(argSpecs, ShellSuggestion{ | ||
| Text: suggest, | ||
| Arg: argSpec, | ||
| }) | ||
| } | ||
|
|
||
| sort.Slice(argSpecs, func(i, j int) bool { | ||
| if argSpecs[i].Arg.Required != argSpecs[j].Arg.Required { | ||
| return argSpecs[i].Arg.Required | ||
| } | ||
| return argSpecs[i].Text < argSpecs[j].Text | ||
| }) | ||
|
|
||
| suggests := []string(nil) | ||
| for _, argSpec := range argSpecs { | ||
| suggests = append(suggests, argSpec.Text) | ||
| } | ||
|
|
||
| return suggests | ||
| } | ||
|
|
||
| // Complete returns the list of suggestion based on prompt content | ||
| func (c *Completer) Complete(d prompt.Document) []prompt.Suggest { | ||
| argsBeforeCursor := strings.Split(d.TextBeforeCursor(), " ") | ||
| argsAfterCursor := strings.Split(d.TextAfterCursor(), " ") | ||
| currentArg := lastArg(argsBeforeCursor) + firstArg(argsAfterCursor) | ||
|
|
||
| // args contains all arguments before the one with the cursor | ||
| args := trimLastArg(argsBeforeCursor) | ||
|
|
||
| acr := AutoComplete(c.ctx, append([]string{"scw"}, args...), currentArg, argsAfterCursor) | ||
|
|
||
| suggestions := []prompt.Suggest(nil) | ||
|
|
||
| meta := extractMeta(c.ctx) | ||
| rawSuggestions := []string(acr.Suggestions) | ||
|
|
||
| // if first suggestion is an option, all suggestions should be options | ||
| // we sort them | ||
| if len(rawSuggestions) > 0 && argIsOption(rawSuggestions[0]) { | ||
| rawSuggestions = sortOptions(meta, args, rawSuggestions[0], rawSuggestions) | ||
| } | ||
|
|
||
| for _, suggest := range rawSuggestions { | ||
| suggestions = append(suggestions, prompt.Suggest{ | ||
| Text: suggest, | ||
| Description: getSuggestDescription(meta, args, suggest), | ||
| }) | ||
| } | ||
|
|
||
| return prompt.FilterHasPrefix(suggestions, currentArg, true) | ||
| } | ||
|
|
||
| func NewShellCompleter(ctx context.Context) *Completer { | ||
| return &Completer{ | ||
| ctx: ctx, | ||
| } | ||
| } | ||
|
|
||
| // shellExecutor returns the function that will execute command entered in shell | ||
| func shellExecutor(rootCmd *cobra.Command, printer *Printer, meta *meta) func(s string) { | ||
| return func(s string) { | ||
| args := strings.Fields(s) | ||
| rootCmd.SetArgs(args) | ||
|
|
||
| err := rootCmd.Execute() | ||
| if err != nil { | ||
| if _, ok := err.(*interactive.InterruptError); ok { | ||
| return | ||
| } | ||
|
|
||
| printErr := printer.Print(err, nil) | ||
| if printErr != nil { | ||
| _, _ = fmt.Fprintln(os.Stderr, err) | ||
| } | ||
|
|
||
| return | ||
| } | ||
|
|
||
| printErr := printer.Print(meta.result, meta.command.getHumanMarshalerOpt()) | ||
| if printErr != nil { | ||
| _, _ = fmt.Fprintln(os.Stderr, printErr) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // Return the shell subcommand | ||
| func getShellCommand(rootCmd *cobra.Command) *cobra.Command { | ||
| subcommands := rootCmd.Commands() | ||
| for _, command := range subcommands { | ||
| if command.Name() == "shell" { | ||
| return command | ||
| } | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| // RunShell will run an interactive shell that runs cobra commands | ||
| func RunShell(ctx context.Context, printer *Printer, meta *meta, rootCmd *cobra.Command, args []string) { | ||
| completer := NewShellCompleter(ctx) | ||
|
|
||
| shellCobraCommand := getShellCommand(rootCmd) | ||
| shellCobraCommand.InitDefaultHelpFlag() | ||
| _ = shellCobraCommand.ParseFlags(args) | ||
| if isHelp, _ := shellCobraCommand.Flags().GetBool("help"); isHelp { | ||
| shellCobraCommand.HelpFunc()(shellCobraCommand, args) | ||
| return | ||
| } | ||
|
|
||
| // remove shell command so it cannot be called from shell | ||
| rootCmd.RemoveCommand(shellCobraCommand) | ||
| meta.Commands.Remove("shell", "") | ||
|
|
||
| executor := shellExecutor(rootCmd, printer, meta) | ||
| p := prompt.New( | ||
| executor, | ||
| completer.Complete, | ||
| prompt.OptionPrefix(">>>"), | ||
| prompt.OptionSuggestionBGColor(prompt.Purple), | ||
| prompt.OptionSelectedSuggestionBGColor(prompt.Fuchsia), | ||
| prompt.OptionSelectedSuggestionTextColor(prompt.White), | ||
| prompt.OptionDescriptionBGColor(prompt.Purple), | ||
| prompt.OptionSelectedDescriptionBGColor(prompt.Fuchsia), | ||
| prompt.OptionSelectedDescriptionTextColor(prompt.White), | ||
| ) | ||
| p.Run() | ||
| } |
Oops, something went wrong.