lazygit/pkg/gui/controllers/helpers/helpers.go

package helpers

import (
	"github.com/jesseduffield/lazygit/pkg/common"
	"github.com/jesseduffield/lazygit/pkg/gui/context"
	"github.com/jesseduffield/lazygit/pkg/gui/types"
)

type HelperCommon struct {
	*common.Common
	types.IGuiCommon
	IGetContexts
}

type IGetContexts interface {
	Contexts() *context.ContextTree
}

type Helpers struct {
	Refs           *RefsHelper
	Bisect         *BisectHelper
	Suggestions    *SuggestionsHelper
	Files          *FilesHelper
	WorkingTree    *WorkingTreeHelper
	BranchesHelper *BranchesHelper
	Tags           *TagsHelper
	MergeAndRebase *MergeAndRebaseHelper
	MergeConflicts *MergeConflictsHelper
	CherryPick     *CherryPickHelper
	Host           *HostHelper
	PatchBuilding  *PatchBuildingHelper
	Staging        *StagingHelper
	GPG            *GpgHelper
	Upstream       *UpstreamHelper
	AmendHelper    *AmendHelper
	FixupHelper    *FixupHelper
	Commits        *CommitsHelper
	Snake          *SnakeHelper
	// lives in context package because our contexts need it to render to main
	Diff              *DiffHelper
	Repos             *ReposHelper
	RecordDirectory   *RecordDirectoryHelper
	Update            *UpdateHelper
	Window            *WindowHelper
	View              *ViewHelper
	Refresh           *RefreshHelper
	Confirmation      *ConfirmationHelper
	Mode              *ModeHelper
	AppStatus         *AppStatusHelper
	InlineStatus      *InlineStatusHelper
	WindowArrangement *WindowArrangementHelper
	Search            *SearchHelper
	Worktree          *WorktreeHelper
	SubCommits        *SubCommitsHelper
}

func NewStubHelpers() *Helpers {
	return &Helpers{
		Refs:              &RefsHelper{},
		Bisect:            &BisectHelper{},
		Suggestions:       &SuggestionsHelper{},
		Files:             &FilesHelper{},
		WorkingTree:       &WorkingTreeHelper{},
		Tags:              &TagsHelper{},
		MergeAndRebase:    &MergeAndRebaseHelper{},
		MergeConflicts:    &MergeConflictsHelper{},
		CherryPick:        &CherryPickHelper{},
		Host:              &HostHelper{},
		PatchBuilding:     &PatchBuildingHelper{},
		Staging:           &StagingHelper{},
		GPG:               &GpgHelper{},
		Upstream:          &UpstreamHelper{},
		AmendHelper:       &AmendHelper{},
		FixupHelper:       &FixupHelper{},
		Commits:           &CommitsHelper{},
		Snake:             &SnakeHelper{},
		Diff:              &DiffHelper{},
		Repos:             &ReposHelper{},
		RecordDirectory:   &RecordDirectoryHelper{},
		Update:            &UpdateHelper{},
		Window:            &WindowHelper{},
		View:              &ViewHelper{},
		Refresh:           &RefreshHelper{},
		Confirmation:      &ConfirmationHelper{},
		Mode:              &ModeHelper{},
		AppStatus:         &AppStatusHelper{},
		InlineStatus:      &InlineStatusHelper{},
		WindowArrangement: &WindowArrangementHelper{},
		Search:            &SearchHelper{},
		Worktree:          &WorktreeHelper{},
		SubCommits:        &SubCommitsHelper{},
	}
}
refactor controllers 2022-02-06 06:54:26 +02:00			`package helpers`

split context common from helper common 2023-03-23 03:35:07 +02:00			`import (`
			`"github.com/jesseduffield/lazygit/pkg/common"`
			`"github.com/jesseduffield/lazygit/pkg/gui/context"`
			`"github.com/jesseduffield/lazygit/pkg/gui/types"`
			`)`

			`type HelperCommon struct {`
			`*common.Common`
			`types.IGuiCommon`
			`IGetContexts`
			`}`

			`type IGetContexts interface {`
			`Contexts() *context.ContextTree`
			`}`

refactor controllers 2022-02-06 06:54:26 +02:00			`type Helpers struct {`
			`Refs *RefsHelper`
			`Bisect *BisectHelper`
			`Suggestions *SuggestionsHelper`
			`Files *FilesHelper`
			`WorkingTree *WorkingTreeHelper`
Allow deleting remote tags/branches from local tag/branch views (#2738) 2023-08-10 09:39:26 +02:00			`BranchesHelper *BranchesHelper`
refactor controllers 2022-02-06 06:54:26 +02:00			`Tags *TagsHelper`
			`MergeAndRebase *MergeAndRebaseHelper`
move merge conflicts code into controller 2022-08-06 10:50:52 +02:00			`MergeConflicts *MergeConflictsHelper`
refactor controllers 2022-02-06 06:54:26 +02:00			`CherryPick *CherryPickHelper`
			`Host *HostHelper`
add commit files controller 2022-02-22 11:13:11 +02:00			`PatchBuilding *PatchBuildingHelper`
Begin refactoring gui This begins a big refactor of moving more code out of the Gui struct into contexts, controllers, and helpers. We also move some code into structs in the gui package purely for the sake of better encapsulation 2022-12-30 14:24:24 +02:00			`Staging *StagingHelper`
add commit message controller 2022-02-22 12:16:00 +02:00			`GPG *GpgHelper`
Add option to (un)set upstream for a local branch 2022-04-08 17:06:07 +02:00			`Upstream *UpstreamHelper`
Extract amendHead function into new AmendHelper 2023-03-09 15:36:43 +02:00			`AmendHelper *AmendHelper`
Add command to find base commit for creating a fixup 2023-08-01 14:54:56 +02:00			`FixupHelper *FixupHelper`
Split commit message panel into commit summary and commit description panel When we use the one panel for the entire commit message, its tricky to have a keybinding both for adding a newline and submitting. By having two panels: one for the summary line and one for the description, we allow for 'enter' to submit the message when done from the summary panel, and 'enter' to add a newline when done from the description panel. Alt-enter, for those who can use that key combo, also works for submitting the message from the description panel. For those who can't use that key combo, and don't want to remap the keybinding, they can hit tab to go back to the summary panel and then 'enter' to submit the message. We have some awkwardness in that both contexts (i.e. panels) need to appear and disappear in tandem and we don't have a great way of handling that concept, so we just push both contexts one after the other, and likewise remove both contexts when we escape. 2023-01-21 13:38:14 +02:00			`Commits *CommitsHelper`
Begin refactoring gui This begins a big refactor of moving more code out of the Gui struct into contexts, controllers, and helpers. We also move some code into structs in the gui package purely for the sake of better encapsulation 2022-12-30 14:24:24 +02:00			`Snake *SnakeHelper`
			`// lives in context package because our contexts need it to render to main`
move window arrangement helper 2023-03-23 09:55:41 +02:00			`Diff *DiffHelper`
			`Repos *ReposHelper`
			`RecordDirectory *RecordDirectoryHelper`
			`Update *UpdateHelper`
			`Window *WindowHelper`
			`View *ViewHelper`
			`Refresh *RefreshHelper`
			`Confirmation *ConfirmationHelper`
			`Mode *ModeHelper`
			`AppStatus *AppStatusHelper`
Add WithInlineStatus helper function Very similar to WithWaitingStatus, except that the status is shown in a view next to the affected item, rather than in the status bar. Not used by anything yet; again, committing separately to get smaller commits. 2023-09-22 16:09:02 +02:00			`InlineStatus *InlineStatusHelper`
move window arrangement helper 2023-03-23 09:55:41 +02:00			`WindowArrangement *WindowArrangementHelper`
Introduce filtered list view model We're going to start supporting filtering of list views 2023-05-27 06:14:43 +02:00			`Search *SearchHelper`
Update status to differentiate the main vs linked worktrees 2022-09-02 08:50:34 +02:00			`Worktree *WorktreeHelper`
Extract a SubCommitsHelper from SwitchToSubCommitsController We want to use it from BranchesController too. 2023-08-05 11:19:16 +02:00			`SubCommits *SubCommitsHelper`
refactor controllers 2022-02-06 06:54:26 +02:00			`}`
fix cheatsheet crash 2022-02-13 01:39:14 +02:00
			`func NewStubHelpers() *Helpers {`
			`return &Helpers{`
move window arrangement helper 2023-03-23 09:55:41 +02:00			`Refs: &RefsHelper{},`
			`Bisect: &BisectHelper{},`
			`Suggestions: &SuggestionsHelper{},`
			`Files: &FilesHelper{},`
			`WorkingTree: &WorkingTreeHelper{},`
			`Tags: &TagsHelper{},`
			`MergeAndRebase: &MergeAndRebaseHelper{},`
			`MergeConflicts: &MergeConflictsHelper{},`
			`CherryPick: &CherryPickHelper{},`
			`Host: &HostHelper{},`
			`PatchBuilding: &PatchBuildingHelper{},`
			`Staging: &StagingHelper{},`
			`GPG: &GpgHelper{},`
			`Upstream: &UpstreamHelper{},`
			`AmendHelper: &AmendHelper{},`
Add command to find base commit for creating a fixup 2023-08-01 14:54:56 +02:00			`FixupHelper: &FixupHelper{},`
Split commit message panel into commit summary and commit description panel When we use the one panel for the entire commit message, its tricky to have a keybinding both for adding a newline and submitting. By having two panels: one for the summary line and one for the description, we allow for 'enter' to submit the message when done from the summary panel, and 'enter' to add a newline when done from the description panel. Alt-enter, for those who can use that key combo, also works for submitting the message from the description panel. For those who can't use that key combo, and don't want to remap the keybinding, they can hit tab to go back to the summary panel and then 'enter' to submit the message. We have some awkwardness in that both contexts (i.e. panels) need to appear and disappear in tandem and we don't have a great way of handling that concept, so we just push both contexts one after the other, and likewise remove both contexts when we escape. 2023-01-21 13:38:14 +02:00			`Commits: &CommitsHelper{},`
move window arrangement helper 2023-03-23 09:55:41 +02:00			`Snake: &SnakeHelper{},`
			`Diff: &DiffHelper{},`
			`Repos: &ReposHelper{},`
			`RecordDirectory: &RecordDirectoryHelper{},`
			`Update: &UpdateHelper{},`
			`Window: &WindowHelper{},`
			`View: &ViewHelper{},`
			`Refresh: &RefreshHelper{},`
			`Confirmation: &ConfirmationHelper{},`
			`Mode: &ModeHelper{},`
			`AppStatus: &AppStatusHelper{},`
Add WithInlineStatus helper function Very similar to WithWaitingStatus, except that the status is shown in a view next to the affected item, rather than in the status bar. Not used by anything yet; again, committing separately to get smaller commits. 2023-09-22 16:09:02 +02:00			`InlineStatus: &InlineStatusHelper{},`
move window arrangement helper 2023-03-23 09:55:41 +02:00			`WindowArrangement: &WindowArrangementHelper{},`
Introduce filtered list view model We're going to start supporting filtering of list views 2023-05-27 06:14:43 +02:00			`Search: &SearchHelper{},`
Update status to differentiate the main vs linked worktrees 2022-09-02 08:50:34 +02:00			`Worktree: &WorktreeHelper{},`
Extract a SubCommitsHelper from SwitchToSubCommitsController We want to use it from BranchesController too. 2023-08-05 11:19:16 +02:00			`SubCommits: &SubCommitsHelper{},`
fix cheatsheet crash 2022-02-13 01:39:14 +02:00			`}`
			`}`