Documentation
      ¶
    
    
  
    
  
    Index ¶
- type Branch
 - type Client
 - type Commit
 - type CommitFile
 - type CommitRange
 - type CustomCommandObject
 - type CustomCommandObjects
 - type File
 - type HandlerCreator
 - type KeybindingCreator
 - type MenuGenerator
 - type Remote
 - type RemoteBranch
 - type Resolver
 - type SessionState
 - type SessionStateLoader
 - type StashEntry
 - type Tag
 - type TrimmerTemplate
 - type Worktree
 
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Branch ¶ added in v0.42.0
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.
type Commit ¶ added in v0.42.0
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 ¶ added in v0.42.0
type CommitRange ¶ added in v0.46.0
type CustomCommandObject ¶ added in v0.36.0
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 Remote ¶ added in v0.42.0
type Remote struct {
	Name     string
	Urls     []string
	Branches []*RemoteBranch
}
    type RemoteBranch ¶ added in v0.42.0
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 ¶
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 ¶ added in v0.42.0
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