commit

Documentation

Overview

Package commit provides ui to perform a git commit.

Index

• func Execute(msg string) tea.Cmd
• type Content
  • func NewContent(commit Model) Content
  • func (c Content) Init() tea.Cmd
  • func (c Content) SetSize(width, height int) dialog.Content
  • func (c Content) Update(msg tea.Msg) (dialog.Content, tea.Cmd)
  • func (c Content) View() string
• type ExecutedMsg
• type KeyMap
  • func NewKeyMap() KeyMap
• type Model
  • func New(branch string, stagedFileList git.FileStatusList) Model
  • func (m Model) Help() []key.Binding
  • func (m Model) Init() tea.Cmd
  • func (m Model) SetSize(width, height int) Model
  • func (m Model) Update(msg tea.Msg) (Model, tea.Cmd)
  • func (m Model) View() string

Functions

func Execute

func Execute(msg string) tea.Cmd

Execute creates a tea.Cmd to execute a git commit.

Types

type Content

type Content struct {
	Model
}

Content is a wrapper to use the commit ui as dialog.Content.

func NewContent

func NewContent(commit Model) Content

func (Content) Init

func (c Content) Init() tea.Cmd

func (Content) SetSize

func (c Content) SetSize(width, height int) dialog.Content

func (Content) Update

func (c Content) Update(msg tea.Msg) (dialog.Content, tea.Cmd)

func (Content) View

func (c Content) View() string

type ExecutedMsg

type ExecutedMsg struct {
	Err error
}

ExecutedMsg is the message to be sent after we performed a git commit.

type KeyMap

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

func NewKeyMap

func NewKeyMap() KeyMap

type Model

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

Model represents the UI to pefrom a commit. It shows the staged files to be included in the commit and allows to write a commit message.

func New

func New(branch string, stagedFileList git.FileStatusList) Model

func (Model) Help

func (m Model) Help() []key.Binding

func (Model) Init

func (m Model) Init() tea.Cmd

func (Model) SetSize

func (m Model) SetSize(width, height int) Model

func (Model) Update

func (m Model) Update(msg tea.Msg) (Model, tea.Cmd)

func (Model) View

func (m Model) View() string