Documentation
¶
Overview ¶
Package gitstatus implements the Git Status panel for grut. It displays files grouped by stage status (Staged, Unstaged, Untracked) with support for file-level staging/unstaging, inline diff expansion, hunk-level and line-level staging, and cursor-based navigation.
Index ¶
- type GitClient
- type GitStatus
- func (p *GitStatus) Init(ctx context.Context) tea.Cmd
- func (p *GitStatus) KeyBindings() []panels.KeyBinding
- func (p *GitStatus) SetActionsCfg(cfg config.ActionsConfig)
- func (p *GitStatus) SetGitCfg(cfg config.GitConfig)
- func (p *GitStatus) Update(msg tea.Msg) (panels.Panel, tea.Cmd)
- func (p *GitStatus) View(width, height int) string
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type GitClient ¶
type GitClient interface {
Status(ctx context.Context) ([]git.FileStatus, error)
Diff(ctx context.Context, opts git.DiffOpts) ([]git.FileDiff, error)
Stage(ctx context.Context, paths []string) error
Unstage(ctx context.Context, paths []string) error
StageHunk(ctx context.Context, path string, hunk git.Hunk) error
UnstageHunk(ctx context.Context, path string, hunk git.Hunk) error
StageLine(ctx context.Context, path string, hunk git.Hunk, lineIdx int) error
UnstageLine(ctx context.Context, path string, hunk git.Hunk, lineIdx int) error
DiscardFile(ctx context.Context, path string) error
CleanPreview(ctx context.Context, opts git.CleanOpts) ([]git.CleanCandidate, error)
Clean(ctx context.Context, opts git.CleanOpts) error
WorktreeFile(ctx context.Context, path string) ([]byte, error)
}
--------------------------------------------------------------------------- GitStatus panel --------------------------------------------------------------------------- GitClient is the subset of git.GitClient used by this panel. It's intentionally narrow — only the methods the panel actually needs — making it easy to mock in tests without implementing unused methods.
type GitStatus ¶
GitStatus is the git status panel. It implements panels.Panel.
func (*GitStatus) Init ¶
--------------------------------------------------------------------------- panels.Panel interface --------------------------------------------------------------------------- Init implements panels.Panel.
func (*GitStatus) KeyBindings ¶
func (p *GitStatus) KeyBindings() []panels.KeyBinding
KeyBindings implements panels.Panel.
func (*GitStatus) SetActionsCfg ¶
func (p *GitStatus) SetActionsCfg(cfg config.ActionsConfig)
SetActionsCfg stores the actions configuration for right-click menus.
func (*GitStatus) SetGitCfg ¶ added in v0.5.0
SetGitCfg applies git-related settings, including the pre-stage secret guard.
Source Files