custom_commands

Documentation

Index

• type Branch
• type Client
  • func NewClient(c *helpers.HelperCommon, helpers *helpers.Helpers) *Client
  • func (self *Client) GetCustomCommandKeybindings() ([]*types.Binding, error)
• type Commit
• type CommitFile
• type CommitRange
• type CustomCommandObject
• type CustomCommandObjects
• type File
• 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 Remote
• type RemoteBranch
• type Resolver
  • func NewResolver(c *common.Common) *Resolver
• type SessionState
• type SessionStateLoader
  • func NewSessionStateLoader(c *helpers.HelperCommon, refsHelper *helpers.RefsHelper) *SessionStateLoader
• type StashEntry
• type Tag
• type TrimmerTemplate
  • func NewTrimmerTemplate(template *template.Template) *TrimmerTemplate
• type Worktree

Types

type Branch

type Branch struct {
	Name           string
	DisplayName    string
	Recency        string
	Pushables      string // deprecated: use AheadForPull
	Pullables      string // deprecated: use BehindForPull
	AheadForPull   string
	BehindForPull  string
	AheadForPush   string
	BehindForPush  string
	UpstreamGone   bool
	Head           bool
	DetachedHead   bool
	UpstreamRemote string
	UpstreamBranch string
	Subject        string
	CommitHash     string
}

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/jesseduffield/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 Commit

type Commit struct {
	Hash          string
	Sha           string // deprecated: use Hash
	Name          string
	Status        models.CommitStatus
	Action        todo.TodoCommand
	Tags          []string
	ExtraInfo     string
	AuthorName    string
	AuthorEmail   string
	UnixTimestamp int64
	Divergence    models.Divergence
	Parents       []string
}

type CommitFile

type CommitFile struct {
	Name         string
	ChangeStatus string
}

type CommitRange

type CommitRange struct {
	From string
	To   string
}

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 File

type File struct {
	Name                    string
	PreviousName            string
	HasStagedChanges        bool
	HasUnstagedChanges      bool
	Tracked                 bool
	Added                   bool
	Deleted                 bool
	HasMergeConflicts       bool
	HasInlineMergeConflicts bool
	DisplayString           string
	ShortStatus             string
	IsWorktree              bool
}

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 Remote

type Remote struct {
	Name     string
	Urls     []string
	Branches []*RemoteBranch
}

type RemoteBranch

type RemoteBranch struct {
	Name       string
	RemoteName string
}

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    *Commit // deprecated, use SelectedCommit
	SelectedReflogCommit   *Commit // deprecated, use SelectedCommit
	SelectedSubCommit      *Commit // deprecated, use SelectedCommit
	SelectedCommit         *Commit
	SelectedCommitRange    *CommitRange
	SelectedFile           *File
	SelectedPath           string
	SelectedLocalBranch    *Branch
	SelectedRemoteBranch   *RemoteBranch
	SelectedRemote         *Remote
	SelectedTag            *Tag
	SelectedStashEntry     *StashEntry
	SelectedCommitFile     *CommitFile
	SelectedCommitFilePath string
	SelectedWorktree       *Worktree
	CheckedOutBranch       *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 StashEntry

type StashEntry struct {
	Index   int
	Recency string
	Name    string
}

type Tag

type Tag struct {
	Name    string
	Message string
}

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

type Worktree

type Worktree struct {
	IsMain        bool
	IsCurrent     bool
	Path          string
	IsPathMissing bool
	GitDir        string
	Branch        string
	Name          string
}