custom_commands

Documentation

Index

• type Client
  • func NewClient(c *helpers.HelperCommon, helpers *helpers.Helpers) *Client
  • func (self *Client) GetCustomCommandKeybindings() ([]*types.Binding, error)
• type CustomCommandObject
• type CustomCommandObjects
• type HandlerCreator
  • func NewHandlerCreator(c *helpers.HelperCommon, sessionStateLoader *SessionStateLoader, ...) *HandlerCreator
• type KeybindingCreator
  • func NewKeybindingCreator(c *helpers.HelperCommon) *KeybindingCreator
• type MenuGenerator
  • func NewMenuGenerator(c *common.Common) *MenuGenerator
• type Resolver
  • func NewResolver(c *common.Common) *Resolver
• type SessionState
• type SessionStateLoader
  • func NewSessionStateLoader(c *helpers.HelperCommon, refsHelper *helpers.RefsHelper) *SessionStateLoader
• type TrimmerTemplate
  • func NewTrimmerTemplate(template *template.Template) *TrimmerTemplate

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client is the entry point to this package. It returns a list of keybindings based on the config's user-defined custom commands. See https://github.com/RetoranPetra/lazygit/blob/master/docs/Custom_Command_Keybindings.md for more info.

func NewClient

func NewClient(
	c *helpers.HelperCommon,
	helpers *helpers.Helpers,
) *Client

func (*Client) GetCustomCommandKeybindings

func (self *Client) GetCustomCommandKeybindings() ([]*types.Binding, error)

type CustomCommandObject

type CustomCommandObject struct {
	// deprecated. Use Responses instead
	PromptResponses []string
	Form            map[string]string
}

type CustomCommandObjects

type CustomCommandObjects struct {
	*SessionState
	PromptResponses []string
	Form            map[string]string
}

type HandlerCreator

type HandlerCreator struct {
	// contains filtered or unexported fields
}

takes a custom command and returns a function that will be called when the corresponding user-defined keybinding is pressed

func NewHandlerCreator

func NewHandlerCreator(
	c *helpers.HelperCommon,
	sessionStateLoader *SessionStateLoader,
	suggestionsHelper *helpers.SuggestionsHelper,
	mergeAndRebaseHelper *helpers.MergeAndRebaseHelper,
) *HandlerCreator

type KeybindingCreator

type KeybindingCreator struct {
	// contains filtered or unexported fields
}

KeybindingCreator takes a custom command along with its handler and returns a corresponding keybinding

func NewKeybindingCreator

func NewKeybindingCreator(c *helpers.HelperCommon) *KeybindingCreator

type MenuGenerator

type MenuGenerator struct {
	// contains filtered or unexported fields
}

func NewMenuGenerator

func NewMenuGenerator(c *common.Common) *MenuGenerator

takes the output of a command and returns a list of menu entries based on a filter and value/label format templates provided by the user

type Resolver

type Resolver struct {
	// contains filtered or unexported fields
}

takes a prompt that is defined in terms of template strings and resolves the templates to contain actual values

func NewResolver

func NewResolver(c *common.Common) *Resolver

type SessionState

type SessionState struct {
	SelectedLocalCommit    *models.Commit
	SelectedReflogCommit   *models.Commit
	SelectedSubCommit      *models.Commit
	SelectedFile           *models.File
	SelectedPath           string
	SelectedLocalBranch    *models.Branch
	SelectedRemoteBranch   *models.RemoteBranch
	SelectedRemote         *models.Remote
	SelectedTag            *models.Tag
	SelectedStashEntry     *models.StashEntry
	SelectedCommitFile     *models.CommitFile
	SelectedCommitFilePath string
	SelectedWorktree       *models.Worktree
	CheckedOutBranch       *models.Branch
}

SessionState captures the current state of the application for use in custom commands

type SessionStateLoader

type SessionStateLoader struct {
	// contains filtered or unexported fields
}

loads the session state at the time that a custom command is invoked, for use in the custom command's template strings

func NewSessionStateLoader

func NewSessionStateLoader(c *helpers.HelperCommon, refsHelper *helpers.RefsHelper) *SessionStateLoader

type TrimmerTemplate

type TrimmerTemplate struct {
	// contains filtered or unexported fields
}

wrapper around a template which trims the output

func NewTrimmerTemplate

func NewTrimmerTemplate(template *template.Template) *TrimmerTemplate