mirrors/lazygit
1
0
Fork 0
mirror of https://github.com/jesseduffield/lazygit.git synced 2025-05-11 12:25:47 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Make menuFromCommand format menu items and their description

Browse source
This commit is contained in:
Elwardi 2021-08-05 15:24:17 +01:00
parent d626bcac00
commit a8ec044f0e
4 changed files with 65 additions and 38 deletions
Download patch file Download diff file Expand all files Collapse all files

34
docs/Custom_Command_Keybindings.md
View file

@ -47,7 +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>.*)'
format: '{{ .branch }}' itemFormat: '{{ .branch }}'
descriptionFormat: ''
``` ```
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:
@ -92,19 +93,24 @@ The permitted contexts are:
The permitted prompt fields are: The permitted prompt fields are:
| _field_ | _description_ | _required_ | | _field_ | _description_ | _required_ |
| ------------ | -------------------------------------------------------------------------------- | ---------- | | ------------ | -------------------------------------------------------------------------------- | ---------- |
| type | one of 'input' or 'menu' | yes | | type | one of 'input' or 'menu' | yes |
| title | the title to display in the popup panel | no | | title | the title to display in the popup panel | no |
| initialValue | (only applicable to 'input' prompts) the initial value to appear in the text box | no | | initialValue | (only applicable to 'input' prompts) the initial value to appear in the text box | no |
| options | (only applicable to 'menu' prompts) the options to display in the menu | no | | options | (only applicable to 'menu' prompts) the options to display in the menu | no |
| command | (only applicable to 'menuFromCommand' prompts) the command to run to generate | yes | | command | (only applicable to 'menuFromCommand' prompts) the command to run to generate | yes |
| | 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 | |
| format | (only applicable to 'menuFromCommand' prompts) how to format matched groups from | yes | | itemFormat | (only applicable to 'menuFromCommand' prompts) how to format matched groups from | yes |
| | the filter. You can use named groups, or `{{ .group_GROUPID }}`. | yes | | | the filter to construct a menu item. You can use named groups, | yes |
| | PS: named groups keep first match only | yes | | | or `{{ .group_GROUPID }}`. | |
| | PS: named groups keep first match only | yes |
| descriptionFormat | (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 |
| | or `{{ .group_GROUPID }}`. | |
| | PS: named groups keep first match only | yes |
The permitted option fields are: The permitted option fields are:
| _field_ | _description_ | _required_ | | _field_ | _description_ | _required_ |

3
pkg/config/user_config.go
View file

@ -285,7 +285,8 @@ type CustomCommandPrompt struct {
// 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"`
Format string `yaml:"format"` TFormat string `yaml:"itemFormat"`
DFormat string `yaml:"descriptionFormat"`
} }
type CustomCommandMenuOption struct { type CustomCommandMenuOption struct {

37
pkg/gui/custom_commands.go
View file

@ -118,16 +118,22 @@ 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, format string) ([]string, error) { func (gui *Gui) GenerateMenuCandidates(commandOutput string, filter string, tFormat string, dFormat string) ([]string, []string, error) {
candidates := []string{} candidates := []string{}
descriptions := []string{}
reg, err := regexp.Compile(filter) reg, err := regexp.Compile(filter)
if err != nil { if err != nil {
return candidates, gui.surfaceError(errors.New("unable to parse filter regex, error: " + err.Error())) return candidates, descriptions, gui.surfaceError(errors.New("unable to parse filter regex, error: " + err.Error()))
} }
buff := bytes.NewBuffer(nil) buffTitle := bytes.NewBuffer(nil)
temp, err := template.New("format").Parse(format) tempTitle, err := template.New("format").Parse(tFormat)
if err != nil { if err != nil {
return candidates, gui.surfaceError(errors.New("unable to parse format, error: " + err.Error())) return candidates, descriptions, gui.surfaceError(errors.New("unable to parse item format, error: " + err.Error()))
}
buffDescr := bytes.NewBuffer(nil)
tempDescr, err := template.New("format").Parse(dFormat)
if err != nil {
return candidates, descriptions, 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 == "" {
@ -146,15 +152,21 @@ func (gui *Gui) GenerateMenuCandidates(commandOutput string, filter string, form
} }
} }
} }
err = temp.Execute(buff, tmplData) err = tempTitle.Execute(buffTitle, tmplData)
if err != nil { if err != nil {
return candidates, gui.surfaceError(err) return candidates, descriptions, gui.surfaceError(err)
}
err = tempDescr.Execute(buffDescr, tmplData)
if err != nil {
return candidates, descriptions, gui.surfaceError(err)
} }
candidates = append(candidates, strings.TrimSpace(buff.String())) candidates = append(candidates, strings.TrimSpace(buffTitle.String()))
buff.Reset() descriptions = append(descriptions, strings.TrimSpace(buffDescr.String()))
buffTitle.Reset()
buffDescr.Reset()
} }
return candidates, err return candidates, descriptions, 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 {
@ -177,7 +189,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, err := gui.GenerateMenuCandidates(message, filter, prompt.Format) candidates, descriptions, err := gui.GenerateMenuCandidates(message, filter, prompt.TFormat, prompt.DFormat)
if err != nil { if err != nil {
return gui.surfaceError(err) return gui.surfaceError(err)
} }
@ -185,7 +197,8 @@ func (gui *Gui) menuPromptFromCommand(prompt config.CustomCommandPrompt, promptR
menuItems := make([]*menuItem, len(candidates)) menuItems := make([]*menuItem, len(candidates))
for i := range candidates { for i := range candidates {
menuItems[i] = &menuItem{ menuItems[i] = &menuItem{
displayStrings: []string{candidates[i]}, // Put in candidate and its description
displayStrings: []string{candidates[i], style.FgYellow.Sprint(descriptions[i])},
onPress: func() error { onPress: func() error {
promptResponses[responseIdx] = candidates[i] promptResponses[responseIdx] = candidates[i]
return wrappedF() return wrappedF()

29
pkg/gui/gui_test.go
View file

@ -86,29 +86,34 @@ func TestGuiGenerateMenuCandidates(t *testing.T) {
testName string testName string
cmdOut string cmdOut string
filter string filter string
format string tFormat string
test func([]string, error) dFormat string
test func([]string, []string, error)
} }
scenarios := []scenario{ scenarios := []scenario{
{ {
"Extract remote branch name", "Extract remote branch name",
"upstream/pr-1", "upstream/pr-1",
"upstream/(?P<branch>.*)", "(?P<remote>[a-z_]+)/(?P<branch>.*)",
"{{ .branch }}", "{{ .branch }}",
func(actual []string, err error) { "Remote: {{ .remote }}",
func(actualCandidate []string, actualDescr []string, err error) {
assert.NoError(t, err) assert.NoError(t, err)
assert.EqualValues(t, "pr-1", actual[0]) assert.EqualValues(t, "pr-1", actualCandidate[0])
assert.EqualValues(t, "Remote: upstream", actualDescr[0])
}, },
}, },
{ {
"Multiple named groups", "Multiple named groups with empty description",
"upstream/pr-1", "upstream/pr-1",
"(?P<remote>[a-z]*)/(?P<branch>.*)", "(?P<remote>[a-z]*)/(?P<branch>.*)",
"{{ .branch }}|{{ .remote }}", "{{ .branch }}|{{ .remote }}",
func(actual []string, err error) { "",
func(actualCandidate []string, actualDescr []string, err error) {
assert.NoError(t, err) assert.NoError(t, err)
assert.EqualValues(t, "pr-1|upstream", actual[0]) assert.EqualValues(t, "pr-1|upstream", actualCandidate[0])
assert.EqualValues(t, "", actualDescr[0])
}, },
}, },
{ {
@ -116,16 +121,18 @@ func TestGuiGenerateMenuCandidates(t *testing.T) {
"upstream/pr-1", "upstream/pr-1",
"(?P<remote>[a-z]*)/(?P<branch>.*)", "(?P<remote>[a-z]*)/(?P<branch>.*)",
"{{ .group_2 }}|{{ .group_1 }}", "{{ .group_2 }}|{{ .group_1 }}",
func(actual []string, err error) { "Remote: {{ .group_1 }}",
func(actualCandidate []string, actualDescr []string, err error) {
assert.NoError(t, err) assert.NoError(t, err)
assert.EqualValues(t, "pr-1|upstream", actual[0]) assert.EqualValues(t, "pr-1|upstream", actualCandidate[0])
assert.EqualValues(t, "Remote: upstream", actualDescr[0])
}, },
}, },
} }
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.format)) s.test(NewDummyGui().GenerateMenuCandidates(s.cmdOut, s.filter, s.tFormat, s.dFormat))
}) })
} }
} }