go/lazygit
1
0
Fork 0
mirror of https://github.com/jesseduffield/lazygit.git synced 2025-03-27 22:01:46 +02:00
Code Issues Releases Activity

Minor changes to menuFromCommand prompts

Browse Source
This commit is contained in:
Elwardi 2021-08-06 10:53:32 +01:00
parent a8ec044f0e
commit 906ec30cac
4 changed files with 54 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/Custom_Command_Keybindings.md
View File

@ -47,8 +47,8 @@ customCommands:
title: 'Remote branch:' title: 'Remote branch:'
command: 'git branch -r --list {{index .PromptResponses 0}}/*' command: 'git branch -r --list {{index .PromptResponses 0}}/*'
filter: '.*{{index .PromptResponses 0}}/(?P<branch>.*)' filter: '.*{{index .PromptResponses 0}}/(?P<branch>.*)'
itemFormat: '{{ .branch }}' valueFormat: '{{ .branch }}'
descriptionFormat: '' labelFormat: ''
``` ```
Looking at the command assigned to the 'n' key, here's what the result looks like: Looking at the command assigned to the 'n' key, here's what the result looks like:
@ -103,11 +103,11 @@ The permitted prompt fields are:
| | menu options | | | | menu options | |
| filter | (only applicable to 'menuFromCommand' prompts) the regexp to run specifying | yes | | filter | (only applicable to 'menuFromCommand' prompts) the regexp to run specifying | yes |
| | groups which are going to be kept from the command's output | | | | groups which are going to be kept from the command's output | |
| itemFormat | (only applicable to 'menuFromCommand' prompts) how to format matched groups from | yes | | valueFormat | (only applicable to 'menuFromCommand' prompts) how to format matched groups from | yes |
| | the filter to construct a menu item. You can use named groups, | yes | | | the filter to construct a menu item. You can use named groups, | yes |
| | or `{{ .group_GROUPID }}`. | | | | or `{{ .group_GROUPID }}`. | |
| | PS: named groups keep first match only | yes | | | PS: named groups keep first match only | yes |
| descriptionFormat | (only applicable to 'menuFromCommand' prompts) how to format matched groups from | yes | | labelFormat | (only applicable to 'menuFromCommand' prompts) how to format matched groups from | yes |
| | the filter to construct a menu item's description. You can use named groups, | yes | | | the filter to construct a menu item's description. You can use named groups, | yes |
| | or `{{ .group_GROUPID }}`. | | | | or `{{ .group_GROUPID }}`. | |
| | PS: named groups keep first match only | yes | | | PS: named groups keep first match only | yes |

8
pkg/config/user_config.go
View File

@ -283,10 +283,10 @@ type CustomCommandPrompt struct {
Options []CustomCommandMenuOption Options []CustomCommandMenuOption
// this only applies to menuFromCommand // this only applies to menuFromCommand
Command string `yaml:"command"` Command string `yaml:"command"`
Filter string `yaml:"filter"` Filter string `yaml:"filter"`
TFormat string `yaml:"itemFormat"` ValueFormat string `yaml:"valueFormat"`
DFormat string `yaml:"descriptionFormat"` LabelFormat string `yaml:"labelFormat"`
} }
type CustomCommandMenuOption struct { type CustomCommandMenuOption struct {

49
pkg/gui/custom_commands.go
View File

@ -33,6 +33,11 @@ type CustomCommandObjects struct {
PromptResponses []string PromptResponses []string
} }
type CommandMenuEntry struct {
label string
value string
}
func (gui *Gui) resolveTemplate(templateStr string, promptResponses []string) (string, error) { func (gui *Gui) resolveTemplate(templateStr string, promptResponses []string) (string, error) {
objects := CustomCommandObjects{ objects := CustomCommandObjects{
SelectedFile: gui.getSelectedFile(), SelectedFile: gui.getSelectedFile(),
@ -118,22 +123,21 @@ func (gui *Gui) menuPrompt(prompt config.CustomCommandPrompt, promptResponses []
return gui.createMenu(title, menuItems, createMenuOptions{showCancel: true}) return gui.createMenu(title, menuItems, createMenuOptions{showCancel: true})
} }
func (gui *Gui) GenerateMenuCandidates(commandOutput string, filter string, tFormat string, dFormat string) ([]string, []string, error) { func (gui *Gui) GenerateMenuCandidates(commandOutput, filter, valueFormat, labelFormat string) ([]CommandMenuEntry, error) {
candidates := []string{} candidates := []CommandMenuEntry{}
descriptions := []string{}
reg, err := regexp.Compile(filter) reg, err := regexp.Compile(filter)
if err != nil { if err != nil {
return candidates, descriptions, gui.surfaceError(errors.New("unable to parse filter regex, error: " + err.Error())) return candidates, gui.surfaceError(errors.New("unable to parse filter regex, error: " + err.Error()))
} }
buffTitle := bytes.NewBuffer(nil) buffItem := bytes.NewBuffer(nil)
tempTitle, err := template.New("format").Parse(tFormat) tempItem, err := template.New("format").Parse(valueFormat)
if err != nil { if err != nil {
return candidates, descriptions, gui.surfaceError(errors.New("unable to parse item format, error: " + err.Error())) return candidates, gui.surfaceError(errors.New("unable to parse item format, error: " + err.Error()))
} }
buffDescr := bytes.NewBuffer(nil) buffDescr := bytes.NewBuffer(nil)
tempDescr, err := template.New("format").Parse(dFormat) tempDescr, err := template.New("format").Parse(labelFormat)
if err != nil { if err != nil {
return candidates, descriptions, gui.surfaceError(errors.New("unable to parse item description format, error: " + err.Error())) return candidates, gui.surfaceError(errors.New("unable to parse item description format, error: " + err.Error()))
} }
for _, str := range strings.Split(string(commandOutput), "\n") { for _, str := range strings.Split(string(commandOutput), "\n") {
if str == "" { if str == "" {
@ -152,21 +156,28 @@ func (gui *Gui) GenerateMenuCandidates(commandOutput string, filter string, tFor
} }
} }
} }
err = tempTitle.Execute(buffTitle, tmplData) err = tempItem.Execute(buffItem, tmplData)
if err != nil { if err != nil {
return candidates, descriptions, gui.surfaceError(err) return candidates, gui.surfaceError(err)
} }
err = tempDescr.Execute(buffDescr, tmplData) err = tempDescr.Execute(buffDescr, tmplData)
if err != nil { if err != nil {
return candidates, descriptions, gui.surfaceError(err) return candidates, gui.surfaceError(err)
} }
candidates = append(candidates, strings.TrimSpace(buffTitle.String())) // Populate menu entry
descriptions = append(descriptions, strings.TrimSpace(buffDescr.String())) // label formatted as labelFormat
buffTitle.Reset() // value as valueFormat
entry := CommandMenuEntry{
strings.TrimSpace(buffDescr.String()),
//"Description",
strings.TrimSpace(buffItem.String()),
}
candidates = append(candidates, entry)
buffItem.Reset()
buffDescr.Reset() buffDescr.Reset()
} }
return candidates, descriptions, err return candidates, err
} }
func (gui *Gui) menuPromptFromCommand(prompt config.CustomCommandPrompt, promptResponses []string, responseIdx int, wrappedF func() error) error { func (gui *Gui) menuPromptFromCommand(prompt config.CustomCommandPrompt, promptResponses []string, responseIdx int, wrappedF func() error) error {
@ -189,7 +200,7 @@ func (gui *Gui) menuPromptFromCommand(prompt config.CustomCommandPrompt, promptR
} }
// Need to make a menu out of what the cmd has displayed // Need to make a menu out of what the cmd has displayed
candidates, descriptions, err := gui.GenerateMenuCandidates(message, filter, prompt.TFormat, prompt.DFormat) candidates, err := gui.GenerateMenuCandidates(message, filter, prompt.ValueFormat, prompt.LabelFormat)
if err != nil { if err != nil {
return gui.surfaceError(err) return gui.surfaceError(err)
} }
@ -198,9 +209,9 @@ func (gui *Gui) menuPromptFromCommand(prompt config.CustomCommandPrompt, promptR
for i := range candidates { for i := range candidates {
menuItems[i] = &menuItem{ menuItems[i] = &menuItem{
// Put in candidate and its description // Put in candidate and its description
displayStrings: []string{candidates[i], style.FgYellow.Sprint(descriptions[i])}, displayStrings: []string{candidates[i].value, style.FgYellow.Sprint(candidates[i].label)},
onPress: func() error { onPress: func() error {
promptResponses[responseIdx] = candidates[i] promptResponses[responseIdx] = candidates[i].value
return wrappedF() return wrappedF()
}, },
} }

32
pkg/gui/gui_test.go
View File

@ -83,12 +83,12 @@ func runCmdHeadless(cmd *exec.Cmd) error {
func TestGuiGenerateMenuCandidates(t *testing.T) { func TestGuiGenerateMenuCandidates(t *testing.T) {
type scenario struct { type scenario struct {
testName string testName string
cmdOut string cmdOut string
filter string filter string
tFormat string valueFormat string
dFormat string labelFormat string
test func([]string, []string, error) test func([]CommandMenuEntry, error)
} }
scenarios := []scenario{ scenarios := []scenario{
@ -98,10 +98,10 @@ func TestGuiGenerateMenuCandidates(t *testing.T) {
"(?P<remote>[a-z_]+)/(?P<branch>.*)", "(?P<remote>[a-z_]+)/(?P<branch>.*)",
"{{ .branch }}", "{{ .branch }}",
"Remote: {{ .remote }}", "Remote: {{ .remote }}",
func(actualCandidate []string, actualDescr []string, err error) { func(actualEntry []CommandMenuEntry, err error) {
assert.NoError(t, err) assert.NoError(t, err)
assert.EqualValues(t, "pr-1", actualCandidate[0]) assert.EqualValues(t, "pr-1", actualEntry[0].value)
assert.EqualValues(t, "Remote: upstream", actualDescr[0]) assert.EqualValues(t, "Remote: upstream", actualEntry[0].label)
}, },
}, },
{ {
@ -110,10 +110,10 @@ func TestGuiGenerateMenuCandidates(t *testing.T) {
"(?P<remote>[a-z]*)/(?P<branch>.*)", "(?P<remote>[a-z]*)/(?P<branch>.*)",
"{{ .branch }}|{{ .remote }}", "{{ .branch }}|{{ .remote }}",
"", "",
func(actualCandidate []string, actualDescr []string, err error) { func(actualEntry []CommandMenuEntry, err error) {
assert.NoError(t, err) assert.NoError(t, err)
assert.EqualValues(t, "pr-1|upstream", actualCandidate[0]) assert.EqualValues(t, "pr-1|upstream", actualEntry[0].value)
assert.EqualValues(t, "", actualDescr[0]) assert.EqualValues(t, "", actualEntry[0].label)
}, },
}, },
{ {
@ -122,17 +122,17 @@ func TestGuiGenerateMenuCandidates(t *testing.T) {
"(?P<remote>[a-z]*)/(?P<branch>.*)", "(?P<remote>[a-z]*)/(?P<branch>.*)",
"{{ .group_2 }}|{{ .group_1 }}", "{{ .group_2 }}|{{ .group_1 }}",
"Remote: {{ .group_1 }}", "Remote: {{ .group_1 }}",
func(actualCandidate []string, actualDescr []string, err error) { func(actualEntry []CommandMenuEntry, err error) {
assert.NoError(t, err) assert.NoError(t, err)
assert.EqualValues(t, "pr-1|upstream", actualCandidate[0]) assert.EqualValues(t, "pr-1|upstream", actualEntry[0].value)
assert.EqualValues(t, "Remote: upstream", actualDescr[0]) assert.EqualValues(t, "Remote: upstream", actualEntry[0].label)
}, },
}, },
} }
for _, s := range scenarios { for _, s := range scenarios {
t.Run(s.testName, func(t *testing.T) { t.Run(s.testName, func(t *testing.T) {
s.test(NewDummyGui().GenerateMenuCandidates(s.cmdOut, s.filter, s.tFormat, s.dFormat)) s.test(NewDummyGui().GenerateMenuCandidates(s.cmdOut, s.filter, s.valueFormat, s.labelFormat))
}) })
} }
} }