Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(branches): proper help menu #431

Merged
merged 1 commit into from
Aug 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ui/components/footer/footer.go
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ func (m Model) View() string {
}

if m.ShowAll {
keymap := keys.GetKeyMap(m.ctx.View)
keymap := keys.CreateKeyMapForView(m.ctx.View)
fullHelp := m.help.View(keymap)
return lipgloss.JoinVertical(lipgloss.Top, footer, fullHelp)
}
Expand Down
2 changes: 1 addition & 1 deletion ui/keys/branchKeys.go
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ var BranchKeys = BranchKeyMap{
),
Delete: key.NewBinding(
key.WithKeys("d", "backspace"),
key.WithHelp("d/backspace", "checkout"),
key.WithHelp("d/backspace", "delete"),
),
ViewPRs: key.NewBinding(
key.WithKeys("s"),
Expand Down
6 changes: 4 additions & 2 deletions ui/keys/keys.go
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ type KeyMap struct {
Quit key.Binding
}

func GetKeyMap(viewType config.ViewType) help.KeyMap {
func CreateKeyMapForView(viewType config.ViewType) help.KeyMap {
Keys.viewType = viewType
return Keys
}
Expand All @@ -42,8 +42,10 @@ func (k KeyMap) ShortHelp() []key.Binding {

func (k KeyMap) FullHelp() [][]key.Binding {
var additionalKeys []key.Binding
if k.viewType == config.PRsView || k.viewType == config.RepoView {
if k.viewType == config.PRsView {
additionalKeys = PRFullHelp()
} else if k.viewType == config.RepoView {
additionalKeys = BranchFullHelp()
} else {
additionalKeys = IssueFullHelp()
}
Expand Down
57 changes: 54 additions & 3 deletions ui/modelUtils.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,12 @@ package ui

import (
"bytes"
"errors"
"fmt"
"maps"
"os"
"os/exec"
"reflect"
"text/template"
"time"

Expand Down Expand Up @@ -82,7 +84,7 @@ func (m *Model) executeKeybinding(key string) tea.Cmd {
return m.runCustomIssueCommand(keybinding.Command, data)
}
}
case config.PRsView, config.RepoView:
case config.PRsView:
for _, keybinding := range m.ctx.Config.Keybindings.Prs {
if keybinding.Key != key || keybinding.Command == "" {
continue
Expand All @@ -95,6 +97,19 @@ func (m *Model) executeKeybinding(key string) tea.Cmd {
return m.runCustomPRCommand(keybinding.Command, data)
}
}
case config.RepoView:
for _, keybinding := range m.ctx.Config.Keybindings.Branches {
if keybinding.Key != key || keybinding.Command == "" {
continue
}

log.Debug("executing keybind", "key", keybinding.Key, "command", keybinding.Command)

switch data := currRowData.(type) {
case *data.PullRequestData:
return m.runCustomBranchCommand(keybinding.Command, data)
}
}
default:
// Not a valid case - ignore it
}
Expand All @@ -112,7 +127,9 @@ func (m *Model) runCustomCommand(commandTemplate string, contextData *map[string
input := map[string]any{}

// Merge data specific to the context the command is being run in onto any common data, overwriting duplicate keys.
maps.Copy(input, *contextData)
if contextData != nil {
maps.Copy(input, *contextData)
}

// Append in the local RepoPath only if it can be found
if repoPath, ok := common.GetRepoLocalPath(input["RepoName"].(string), m.ctx.Config.RepoPaths); ok {
Expand Down Expand Up @@ -156,7 +173,21 @@ func (m *Model) runCustomIssueCommand(commandTemplate string, issueData *data.Is
)
}

func (m *Model) runCustomBranchCommand(commandTemplate string, branchData *data.PullRequestData) tea.Cmd {
if reflect.ValueOf(branchData).IsNil() {
return m.executeCustomCommand(commandTemplate)
}
return m.runCustomCommand(commandTemplate,
&map[string]any{
"RepoName": branchData.GetRepoNameWithOwner(),
"PrNumber": branchData.Number,
"HeadRefName": branchData.HeadRefName,
"BaseRefName": branchData.BaseRefName,
})
}

func (m *Model) executeCustomCommand(cmd string) tea.Cmd {
log.Debug("executing custom command", "cmd", cmd)
shell := os.Getenv("SHELL")
if shell == "" {
shell = "sh"
Expand All @@ -169,7 +200,7 @@ func (m *Model) executeCustomCommand(cmd string) tea.Cmd {
if mdErr != nil {
return constants.ErrMsg{Err: mdErr}
}
return constants.ErrMsg{Err: fmt.Errorf(
return constants.ErrMsg{Err: errors.New(
lipgloss.JoinVertical(lipgloss.Left,
fmt.Sprintf("Whoops, got an error: %s", err),
md,
Expand Down Expand Up @@ -198,3 +229,23 @@ func (m *Model) notify(text string) tea.Cmd {

return tea.Sequence(startCmd, finishCmd)
}

func (m *Model) notifyErr(text string) tea.Cmd {
id := fmt.Sprint(time.Now().Unix())
startCmd := m.ctx.StartTask(
context.Task{
Id: id,
StartText: text,
FinishedText: text,
State: context.TaskStart,
})

finishCmd := func() tea.Msg {
return constants.TaskFinishedMsg{
TaskId: id,
Err: errors.New(text),
}
}

return tea.Sequence(startCmd, finishCmd)
}
31 changes: 25 additions & 6 deletions ui/ui.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package ui
import (
"fmt"
"os"
"reflect"
"sort"
"strings"
"time"
Expand Down Expand Up @@ -246,22 +247,32 @@ func (m Model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
}

case key.Matches(msg, m.keys.CopyNumber):
number := fmt.Sprint(m.getCurrRowData().GetNumber())
err := clipboard.WriteAll(number)
row := m.getCurrRowData()
var cmd tea.Cmd
if reflect.ValueOf(row).IsNil() {
cmd = m.notifyErr("Current selection isn't associated with a PR/Issue")
return m, cmd
}
number := fmt.Sprint(row.GetNumber())
err := clipboard.WriteAll(number)
if err != nil {
cmd = m.notify(fmt.Sprintf("Failed copying to clipboard %v", err))
cmd = m.notifyErr(fmt.Sprintf("Failed copying to clipboard %v", err))
} else {
cmd = m.notify(fmt.Sprintf("Copied %s to clipboard", number))
}
return m, cmd

case key.Matches(msg, m.keys.CopyUrl):
url := m.getCurrRowData().GetUrl()
err := clipboard.WriteAll(url)
var cmd tea.Cmd
row := m.getCurrRowData()
if reflect.ValueOf(row).IsNil() {
cmd = m.notifyErr("Current selection isn't associated with a PR/Issue")
return m, cmd
}
url := row.GetUrl()
err := clipboard.WriteAll(url)
if err != nil {
cmd = m.notify(fmt.Sprintf("Failed copying to clipboard %v", err))
cmd = m.notifyErr(fmt.Sprintf("Failed copying to clipboard %v", err))
} else {
cmd = m.notify(fmt.Sprintf("Copied %s to clipboard", url))
}
Expand Down Expand Up @@ -798,6 +809,14 @@ func (m *Model) isUserDefinedKeybinding(msg tea.KeyMsg) bool {
}
}

if m.ctx.View == config.RepoView {
for _, keybinding := range m.ctx.Config.Keybindings.Branches {
if keybinding.Builtin == "" && keybinding.Key == msg.String() {
return true
}
}
}

return false
}

Expand Down
Loading