hook

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

• type HelpAgent
  • func NewHelpAgent(pa pluginAgent, ghc githubClient) *HelpAgent
  • func (ha *HelpAgent) GeneratePluginHelp() *pluginhelp.Help
  • func (ha *HelpAgent) ServeHTTP(w http.ResponseWriter, r *http.Request)

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.

func (*HelpAgent) ServeHTTP

func (ha *HelpAgent) ServeHTTP(w http.ResponseWriter, r *http.Request)