Documentation
¶
Overview ¶
Package hook provides the plugin help components to be compiled into the hook binary. This includes the code to fetch help from normal and external plugins and the code to build and serve a pluginhelp.Help struct.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type HelpAgent ¶
type HelpAgent struct {
// contains filtered or unexported fields
}
HelpAgent is a handler that generates and serve plugin help information.
func NewHelpAgent ¶
func NewHelpAgent(pa pluginAgent, ghc githubClient) *HelpAgent
NewHelpAgent constructs a new HelpAgent.
func (*HelpAgent) GeneratePluginHelp ¶
func (ha *HelpAgent) GeneratePluginHelp() *pluginhelp.Help
GeneratePluginHelp compiles and returns the help information for all plugins.
Source Files
Click to show internal directories.
Click to hide internal directories.