-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This introduce an experimental way to extend one fisk command with another. Fisk commands will have --fisk-introspection that emits an ApplicationModel. Other fisk apps can import this using the ExternalPluginJSON() function. Help output and more will include the full command model and on execution it will call the command to do the actual work Ideally plugins will be able to define global flags that clash with the command they plug into, in that case the value of the global flag will be passed to the app but for now that's left for a followup PR Signed-off-by: R.I.Pienaar <[email protected]>
- Loading branch information
Showing
4 changed files
with
224 additions
and
45 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
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,167 @@ | ||
| package fisk | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "fmt" | ||
| "os" | ||
| "os/exec" | ||
| "strings" | ||
| ) | ||
|
|
||
| type pluginDelegator struct { | ||
| command string | ||
| flags map[string]*string | ||
| boolFlags map[string]*bool | ||
| unNegBoolFlags map[string]*bool | ||
| args map[string]*string | ||
| } | ||
|
|
||
| func (a *Application) introspectModel() *ApplicationModel { | ||
| model := a.Model() | ||
| var nf []*FlagModel | ||
| for _, flag := range model.Flags { | ||
| if flag.Name == "help" || strings.HasPrefix(flag.Name, "help-") || strings.HasPrefix(flag.Name, "completion-") || strings.HasPrefix(flag.Name, "fisk-") { | ||
| continue | ||
| } | ||
|
|
||
| nf = append(nf, flag) | ||
| } | ||
| model.Flags = nf | ||
|
|
||
| var nc []*CmdModel | ||
| for _, cmd := range model.Commands { | ||
| if cmd.Name == "help" { | ||
| continue | ||
| } | ||
| nc = append(nc, cmd) | ||
| } | ||
| model.Commands = nc | ||
|
|
||
| return model | ||
| } | ||
|
|
||
| func (a *Application) introspectAction(c *ParseContext) error { | ||
| a.Writer(os.Stdout) | ||
|
|
||
| j, err := json.Marshal(a.introspectModel()) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| fmt.Println(string(j)) | ||
| return nil | ||
| } | ||
|
|
||
| func (c *CmdClause) addArgsFromModel(model *ArgGroupModel) { | ||
| for _, arg := range model.Args { | ||
| a := c.Arg(arg.Name, arg.Help) | ||
| a.placeholder = arg.PlaceHolder | ||
| a.required = arg.Required | ||
| a.hidden = arg.Hidden | ||
| a.defaultValues = arg.Default | ||
| a.envar = arg.Envar | ||
| c.pluginDelegator.args[arg.Name] = a.String() | ||
| } | ||
| } | ||
|
|
||
| func (c *CmdClause) addFlagsFromModel(model *FlagGroupModel) { | ||
| for _, flag := range model.Flags { | ||
| f := c.Flag(flag.Name, flag.Help) | ||
| f.shorthand = flag.Short | ||
| f.defaultValues = flag.Default | ||
| f.envar = flag.Envar | ||
| f.placeholder = flag.PlaceHolder | ||
| f.required = flag.Required | ||
| f.hidden = flag.Hidden | ||
|
|
||
| switch { | ||
| case flag.Boolean && flag.Negatable: | ||
| c.pluginDelegator.boolFlags[flag.Name] = f.Bool() | ||
|
|
||
| case flag.Boolean: | ||
| c.pluginDelegator.unNegBoolFlags[flag.Name] = f.UnNegatableBool() | ||
|
|
||
| default: | ||
| c.pluginDelegator.flags[flag.Name] = f.String() | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func (c *CmdClause) addCommandsFromModel(model *CmdGroupModel) { | ||
| for _, cmd := range model.Commands { | ||
| cm := c.Command(cmd.Name, cmd.Help) | ||
| cm.pluginDelegator = c.pluginDelegator | ||
| cm.aliases = cmd.Aliases | ||
| cm.helpLong = cmd.HelpLong | ||
| cm.hidden = cmd.Hidden | ||
| cm.isDefault = cmd.Default | ||
| cm.addArgsFromModel(cmd.ArgGroupModel) | ||
| cm.addFlagsFromModel(cmd.FlagGroupModel) | ||
| cm.addCommandsFromModel(cmd.CmdGroupModel) | ||
| cm.Action(func(pc *ParseContext) error { | ||
| var args []string | ||
| for k, v := range cm.pluginDelegator.args { | ||
| if v != nil { | ||
| args = append(args, fmt.Sprintf("%s=%s", k, *v)) | ||
| } | ||
| } | ||
|
|
||
| for k, v := range cm.pluginDelegator.flags { | ||
| if v != nil { | ||
| args = append(args, fmt.Sprintf("--%s=%s", k, *v)) | ||
| } | ||
| } | ||
|
|
||
| for k, v := range cm.pluginDelegator.boolFlags { | ||
| if *v { | ||
| args = append(args, fmt.Sprintf("--%s", k)) | ||
| } else { | ||
| args = append(args, fmt.Sprintf("--no-%s", k)) | ||
| } | ||
| } | ||
|
|
||
| for k, v := range cm.pluginDelegator.unNegBoolFlags { | ||
| if *v { | ||
| args = append(args, fmt.Sprintf("--%s", k)) | ||
| } | ||
| } | ||
|
|
||
| return exec.Command(cm.pluginDelegator.command, args...).Run() | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func (a *Application) registerPluginModel(command string, model *ApplicationModel) (*CmdClause, error) { | ||
| cmd := a.Command(model.Name, model.Help) | ||
| cmd.pluginDelegator = &pluginDelegator{ | ||
| command: command, | ||
| flags: map[string]*string{}, | ||
| args: map[string]*string{}, | ||
| boolFlags: map[string]*bool{}, | ||
| unNegBoolFlags: map[string]*bool{}, | ||
| } | ||
|
|
||
| cmd.addArgsFromModel(model.ArgGroupModel) | ||
| cmd.addFlagsFromModel(model.FlagGroupModel) | ||
| cmd.addCommandsFromModel(model.CmdGroupModel) | ||
|
|
||
| return cmd, nil | ||
| } | ||
|
|
||
| // ExternalPluginJSON extends the application using a plugin and a model describing the application | ||
| func (a *Application) ExternalPluginJSON(command string, model json.RawMessage) (*CmdClause, error) { | ||
| var m ApplicationModel | ||
| err := json.Unmarshal(model, &m) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| if m.Name == "" { | ||
| return nil, fmt.Errorf("plugin declared no name") | ||
| } | ||
| if m.Help == "" { | ||
| return nil, fmt.Errorf("plugin declared no help") | ||
| } | ||
|
|
||
| return a.registerPluginModel(command, &m) | ||
| } |
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