Only apply right-alignment on first column of keybindings menu (#2801)

Previously we applied a right-align on the first column of _all_ menus, even though we really
only intended for it to be on the first column of the keybindings menu (that you get from pressing
'?')

.github/release.yml

@@ -0,0 +1,26 @@
+changelog:
+  exclude:
+    labels:
+      - ignore-for-release
+  categories:
+    - title: Features ✨
+      labels:
+        - feature
+    - title: Enhancements 🔥
+      labels:
+        - enhancement
+    - title: Fixes 🔧
+      labels:
+        - bug
+    - title: Maintenance ⚙️
+      labels:
+        - maintenance
+    - title: Docs 📖
+      labels:
+        - docs
+    - title: I18n 🌎
+      labels:
+        - i18n
+    - title: Other Changes
+      labels:
+        - "*"

.github/workflows/ci.yml

@@ -204,3 +204,11 @@ jobs:
       - name: errors
         run: golangci-lint run
         if: ${{ failure() }}
+  check-required-label:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: mheap/github-action-required-labels@v5
+        with:
+          mode: exactly
+          count: 1
+          labels: "ignore-for-release, feature, enhancement, bug, maintenance, docs, i18n"

pkg/gui/context/list_context_trait.go

@@ -14,7 +14,7 @@ type ListContextTrait struct {
 	list              types.IList
 	getDisplayStrings func(startIdx int, length int) [][]string
 	// Alignment for each column. If nil, the default is left alignment
-	columnAlignments []utils.Alignment
+	getColumnAlignments func() []utils.Alignment
 	// Some contexts, like the commit context, will highlight the path from the selected commit
 	// to its parents, because it's ambiguous otherwise. For these, we need to refresh the viewport
 	// so that we show the highlighted path.
@@ -82,9 +82,13 @@ func (self *ListContextTrait) HandleFocusLost(opts types.OnFocusLostOpts) error
 // OnFocus assumes that the content of the context has already been rendered to the view. OnRender is the function which actually renders the content to the view
 func (self *ListContextTrait) HandleRender() error {
 	self.list.RefreshSelectedIdx()
+	var columnAlignments []utils.Alignment
+	if self.getColumnAlignments != nil {
+		columnAlignments = self.getColumnAlignments()
+	}
 	content := utils.RenderDisplayStrings(
 		self.getDisplayStrings(0, self.list.Len()),
-		self.columnAlignments,
+		columnAlignments,
 	)
 	self.GetViewTrait().SetContent(content)
 	self.c.Render()

pkg/gui/context/menu_context.go

@@ -35,10 +35,10 @@ func NewMenuContext(
 				Focusable:             true,
 				HasUncontrolledBounds: true,
 			})),
-			getDisplayStrings: viewModel.GetDisplayStrings,
-			list:              viewModel,
-			c:                 c,
-			columnAlignments:  []utils.Alignment{utils.AlignRight, utils.AlignLeft},
+			getDisplayStrings:   viewModel.GetDisplayStrings,
+			list:                viewModel,
+			c:                   c,
+			getColumnAlignments: func() []utils.Alignment { return viewModel.columnAlignment },
 		},
 	}
 }
@@ -54,8 +54,9 @@ func (self *MenuContext) GetSelectedItemId() string {
 }
 
 type MenuViewModel struct {
-	c         *ContextCommon
-	menuItems []*types.MenuItem
+	c               *ContextCommon
+	menuItems       []*types.MenuItem
+	columnAlignment []utils.Alignment
 	*FilteredListViewModel[*types.MenuItem]
 }
 
@@ -73,8 +74,9 @@ func NewMenuViewModel(c *ContextCommon) *MenuViewModel {
 	return self
 }
 
-func (self *MenuViewModel) SetMenuItems(items []*types.MenuItem) {
+func (self *MenuViewModel) SetMenuItems(items []*types.MenuItem, columnAlignment []utils.Alignment) {
 	self.menuItems = items
+	self.columnAlignment = columnAlignment
 }
 
 // TODO: move into presentation package
@@ -135,6 +137,10 @@ func (self *MenuContext) OnMenuPress(selectedItem *types.MenuItem) error {
 		return err
 	}
 
+	if selectedItem == nil {
+		return nil
+	}
+
 	if err := selectedItem.OnPress(); err != nil {
 		return err
 	}

pkg/gui/controllers/helpers/confirmation_helper.go

@@ -302,7 +302,12 @@ func (self *ConfirmationHelper) resizeMenu() {
 	_, _ = self.c.GocuiGui().SetView(self.c.Views().Menu.Name(), x0, y0, x1, menuBottom, 0)
 
 	tooltipTop := menuBottom + 1
-	tooltipHeight := getMessageHeight(true, self.c.Contexts().Menu.GetSelected().Tooltip, panelWidth) + 2 // plus 2 for the frame
+	tooltip := ""
+	selectedItem := self.c.Contexts().Menu.GetSelected()
+	if selectedItem != nil {
+		tooltip = selectedItem.Tooltip
+	}
+	tooltipHeight := getMessageHeight(true, tooltip, panelWidth) + 2 // plus 2 for the frame
 	_, _ = self.c.GocuiGui().SetView(self.c.Views().Tooltip.Name(), x0, tooltipTop, x1, tooltipTop+tooltipHeight-1, 0)
 }
 

pkg/gui/controllers/menu_controller.go

@@ -53,7 +53,9 @@ func (self *MenuController) GetOnClick() func() error {
 func (self *MenuController) GetOnFocus() func(types.OnFocusOpts) error {
 	return func(types.OnFocusOpts) error {
 		selectedMenuItem := self.context().GetSelected()
-		self.c.Views().Tooltip.SetContent(selectedMenuItem.Tooltip)
+		if selectedMenuItem != nil {
+			self.c.Views().Tooltip.SetContent(selectedMenuItem.Tooltip)
+		}
 		return nil
 	}
 }

pkg/gui/controllers/options_menu_action.go

@@ -4,6 +4,7 @@ import (
 	"github.com/jesseduffield/generics/slices"
 	"github.com/jesseduffield/lazygit/pkg/gui/keybindings"
 	"github.com/jesseduffield/lazygit/pkg/gui/types"
+	"github.com/jesseduffield/lazygit/pkg/utils"
 	"github.com/samber/lo"
 )
 
@@ -37,9 +38,10 @@ func (self *OptionsMenuAction) Call() error {
 	})
 
 	return self.c.Menu(types.CreateMenuOptions{
-		Title:      self.c.Tr.Keybindings,
-		Items:      menuItems,
-		HideCancel: true,
+		Title:           self.c.Tr.Keybindings,
+		Items:           menuItems,
+		HideCancel:      true,
+		ColumnAlignment: []utils.Alignment{utils.AlignRight, utils.AlignLeft},
 	})
 }
 

pkg/gui/menu_panel.go

@@ -41,7 +41,7 @@ func (gui *Gui) createMenu(opts types.CreateMenuOptions) error {
 		}
 	}
 
-	gui.State.Contexts.Menu.SetMenuItems(opts.Items)
+	gui.State.Contexts.Menu.SetMenuItems(opts.Items, opts.ColumnAlignment)
 	gui.State.Contexts.Menu.SetSelectedLineIdx(0)
 
 	gui.Views.Menu.Title = opts.Title

pkg/gui/types/common.go

@@ -133,9 +133,10 @@ type IPopupHandler interface {
 }
 
 type CreateMenuOptions struct {
-	Title      string
-	Items      []*MenuItem
-	HideCancel bool
+	Title           string
+	Items           []*MenuItem
+	HideCancel      bool
+	ColumnAlignment []utils.Alignment
 }
 
 type CreatePopupPanelOpts struct {

pkg/integration/tests/test_list.go

@@ -211,6 +211,7 @@ var tests = []*components.IntegrationTest{
 	tag.Reset,
 	ui.Accordion,
 	ui.DoublePopup,
+	ui.EmptyMenu,
 	ui.SwitchTabFromMenu,
 	undo.UndoCheckoutAndDrop,
 	undo.UndoDrop,

pkg/integration/tests/ui/empty_menu.go

@@ -0,0 +1,31 @@
+package ui
+
+import (
+	"github.com/jesseduffield/lazygit/pkg/config"
+	. "github.com/jesseduffield/lazygit/pkg/integration/components"
+)
+
+var EmptyMenu = NewIntegrationTest(NewIntegrationTestArgs{
+	Description:  "Verify that we don't crash on an empty menu",
+	ExtraCmdArgs: []string{},
+	Skip:         false,
+	SetupConfig:  func(config *config.AppConfig) {},
+	SetupRepo: func(shell *Shell) {
+	},
+	Run: func(t *TestDriver, keys config.KeybindingConfig) {
+		t.Views().Files().
+			IsFocused().
+			Press(keys.Universal.OptionMenu)
+
+		t.Views().Menu().
+			IsFocused().
+			// a string that filters everything out
+			FilterOrSearch("ljasldkjaslkdjalskdjalsdjaslkd").
+			IsEmpty().
+			Press(keys.Universal.Select)
+
+		// back in the files view, selecting the non-existing menu item was a no-op
+		t.Views().Files().
+			IsFocused()
+	},
+})