Enable hunk staging mode by default (#4780)

- **PR Description** In #4684 we improved the hunk selection behavior to work on blocks of changes instead of actual hunks, and I find this so useful that I wanted to use it by default. In #4685 I added a user config to make hunk selection the default, but I made it an opt-in config because I was worried that users might not find out how to switch back to line selection if needed. To address this concern, in this PR I add a popup that explains this the first time the user enters staging; there is also a breaking changes notice at startup, and we improve the options display at the bottom of the screen to be clearer about this. Hopefully these measures are enough to not confuse people. Closes #4759.

Author: stefanhaller

docs/Config.md

@@ -117,7 +117,7 @@ gui:
  wrapLinesInStagingView: true
 
  # If true, hunk selection mode will be enabled by default when entering the staging view.
- useHunkModeInStagingView: false
+ useHunkModeInStagingView: true
 
  # One of 'auto' (default) | 'en' | 'zh-CN' | 'zh-TW' | 'pl' | 'nl' | 'ja' | 'ko' | 'ru'
  language: auto

docs/keybindings/Keybindings_en.md

@@ -221,7 +221,7 @@ _Legend: `<c-b>` means ctrl+b, `<a-b>` means alt+b, `B` means shift+b_
 | `` <left> `` | Go to previous hunk | |
 | `` <right> `` | Go to next hunk | |
 | `` v `` | Toggle range select | |
-| `` a `` | Select hunk | Toggle hunk selection mode. |
+| `` a `` | Toggle hunk selection | Toggle line-by-line vs. hunk selection mode. |
 | `` <c-o> `` | Copy selected text to clipboard | |
 | `` o `` | Open file | Open file in default application. |
 | `` e `` | Edit file | Open file in external editor. |
@@ -236,7 +236,7 @@ _Legend: `<c-b>` means ctrl+b, `<a-b>` means alt+b, `B` means shift+b_
 | `` <left> `` | Go to previous hunk | |
 | `` <right> `` | Go to next hunk | |
 | `` v `` | Toggle range select | |
-| `` a `` | Select hunk | Toggle hunk selection mode. |
+| `` a `` | Toggle hunk selection | Toggle line-by-line vs. hunk selection mode. |
 | `` <c-o> `` | Copy selected text to clipboard | |
 | `` <space> `` | Stage | Toggle selection staged / unstaged. |
 | `` d `` | Discard | When unstaged change is selected, discard the change using `git reset`. When staged change is selected, unstage the change. |

docs/keybindings/Keybindings_ko.md

@@ -164,7 +164,7 @@ _Legend: `<c-b>` means ctrl+b, `<a-b>` means alt+b, `B` means shift+b_
 | `` <left> `` | 이전 hunk를 선택 | |
 | `` <right> `` | 다음 hunk를 선택 | |
 | `` v `` | 드래그 선택 전환 | |
-| `` a `` | Toggle select hunk | Toggle hunk selection mode. |
+| `` a `` | Toggle select hunk | Toggle line-by-line vs. hunk selection mode. |
 | `` <c-o> `` | 선택한 텍스트를 클립보드에 복사 | |
 | `` o `` | 파일 닫기 | Open file in default application. |
 | `` e `` | 파일 편집 | Open file in external editor. |
@@ -179,7 +179,7 @@ _Legend: `<c-b>` means ctrl+b, `<a-b>` means alt+b, `B` means shift+b_
 | `` <left> `` | 이전 hunk를 선택 | |
 | `` <right> `` | 다음 hunk를 선택 | |
 | `` v `` | 드래그 선택 전환 | |
-| `` a `` | Toggle select hunk | Toggle hunk selection mode. |
+| `` a `` | Toggle select hunk | Toggle line-by-line vs. hunk selection mode. |
 | `` <c-o> `` | 선택한 텍스트를 클립보드에 복사 | |
 | `` <space> `` | Staged 전환 | 선택한 행을 staged / unstaged |
 | `` d `` | 변경을 삭제 (git reset) | When unstaged change is selected, discard the change using `git reset`. When staged change is selected, unstage the change. |

docs/keybindings/Keybindings_nl.md

@@ -229,7 +229,7 @@ _Legend: `<c-b>` means ctrl+b, `<a-b>` means alt+b, `B` means shift+b_
 | `` <left> `` | Selecteer de vorige hunk | |
 | `` <right> `` | Selecteer de volgende hunk | |
 | `` v `` | Toggle drag selecteer | |
-| `` a `` | Toggle selecteer hunk | Toggle hunk selection mode. |
+| `` a `` | Toggle selecteer hunk | Toggle line-by-line vs. hunk selection mode. |
 | `` <c-o> `` | Copy selected text to clipboard | |
 | `` o `` | Open bestand | Open file in default application. |
 | `` e `` | Verander bestand | Open file in external editor. |
@@ -302,7 +302,7 @@ _Legend: `<c-b>` means ctrl+b, `<a-b>` means alt+b, `B` means shift+b_
 | `` <left> `` | Selecteer de vorige hunk | |
 | `` <right> `` | Selecteer de volgende hunk | |
 | `` v `` | Toggle drag selecteer | |
-| `` a `` | Toggle selecteer hunk | Toggle hunk selection mode. |
+| `` a `` | Toggle selecteer hunk | Toggle line-by-line vs. hunk selection mode. |
 | `` <c-o> `` | Copy selected text to clipboard | |
 | `` <space> `` | Toggle staged | Toggle lijnen staged / unstaged |
 | `` d `` | Verwijdert change (git reset) | When unstaged change is selected, discard the change using `git reset`. When staged change is selected, unstage the change. |

docs/keybindings/Keybindings_ru.md

@@ -76,7 +76,7 @@ _Связки клавиш_
 | `` <left> `` | Выбрать предыдущую часть | |
 | `` <right> `` | Выбрать следующую часть | |
 | `` v `` | Переключить выборку перетаскивания | |
-| `` a `` | Переключить выборку частей | Toggle hunk selection mode. |
+| `` a `` | Переключить выборку частей | Toggle line-by-line vs. hunk selection mode. |
 | `` <c-o> `` | Скопировать выделенный текст в буфер обмена | |
 | `` <space> `` | Переключить индекс | Переключить строку в проиндексированные / непроиндексированные |
 | `` d `` | Отменить изменение (git reset) | When unstaged change is selected, discard the change using `git reset`. When staged change is selected, unstage the change. |
@@ -124,7 +124,7 @@ _Связки клавиш_
 | `` <left> `` | Выбрать предыдущую часть | |
 | `` <right> `` | Выбрать следующую часть | |
 | `` v `` | Переключить выборку перетаскивания | |
-| `` a `` | Переключить выборку частей | Toggle hunk selection mode. |
+| `` a `` | Переключить выборку частей | Toggle line-by-line vs. hunk selection mode. |
 | `` <c-o> `` | Скопировать выделенный текст в буфер обмена | |
 | `` o `` | Открыть файл | Open file in default application. |
 | `` e `` | Редактировать файл | Open file in external editor. |

docs/keybindings/Keybindings_zh-TW.md

@@ -58,7 +58,7 @@ _說明：`<c-b>` 表示 Ctrl＋B、`<a-b>` 表示 Alt＋B，`B`表示 Shift＋B
 | `` <left> `` | 選擇上一段 | |
 | `` <right> `` | 選擇下一段 | |
 | `` v `` | 切換拖曳選擇 | |
-| `` a `` | 切換選擇程式碼塊 | Toggle hunk selection mode. |
+| `` a `` | 切換選擇程式碼塊 | Toggle line-by-line vs. hunk selection mode. |
 | `` <c-o> `` | 複製所選文本至剪貼簿 | |
 | `` o `` | 開啟檔案 | 使用預設軟體開啟 |
 | `` e `` | 編輯檔案 | 使用外部編輯器開啟 |
@@ -99,7 +99,7 @@ _說明：`<c-b>` 表示 Ctrl＋B、`<a-b>` 表示 Alt＋B，`B`表示 Shift＋B
 | `` <left> `` | 選擇上一段 | |
 | `` <right> `` | 選擇下一段 | |
 | `` v `` | 切換拖曳選擇 | |
-| `` a `` | 切換選擇程式碼塊 | Toggle hunk selection mode. |
+| `` a `` | 切換選擇程式碼塊 | Toggle line-by-line vs. hunk selection mode. |
 | `` <c-o> `` | 複製所選文本至剪貼簿 | |
 | `` <space> `` | 切換預存 | 切換現有行的狀態 (已預存/未預存) |
 | `` d `` | 刪除變更 (git reset) | When unstaged change is selected, discard the change using `git reset`. When staged change is selected, unstage the change. |

pkg/app/entry_point.go

@@ -141,6 +141,9 @@ func Start(buildInfo *BuildInfo, integrationTest integrationTypes.IntegrationTes
 
 if integrationTest != nil {
 integrationTest.SetupConfig(appConfig)
+// Set this to true so that integration tests don't have to explicitly deal with the hunk
+// staging hint:
+appConfig.GetAppState().DidShowHunkStagingHint = true
 
 // Preserve the changes that the test setup just made to the config, so
 // they don't get lost when we reload the config while running the test

pkg/config/app_config.go

@@ -656,10 +656,11 @@ func (c *AppConfig) SaveGlobalUserConfig() {
 // AppState stores data between runs of the app like when the last update check
 // was performed and which other repos have been checked out
 type AppState struct {
-LastUpdateCheck int64
-RecentRepos []string
-StartupPopupVersion int
-LastVersion string // this is the last version the user was using, for the purpose of showing release notes
+LastUpdateCheck int64
+RecentRepos []string
+StartupPopupVersion int
+DidShowHunkStagingHint bool
+LastVersion string // this is the last version the user was using, for the purpose of showing release notes
 
 // these are for shell commands typed in directly, not for custom commands in the lazygit config.
 // For backwards compatibility we keep the old name in yaml files.
@@ -669,12 +670,7 @@ type AppState struct {
 }
 
 func getDefaultAppState() *AppState {
-return &AppState{
-LastUpdateCheck: 0,
-RecentRepos: []string{},
-StartupPopupVersion: 0,
-LastVersion: "",
-}
+return &AppState{}
 }
 
 func LogPath() (string, error) {

pkg/config/user_config.go

@@ -739,7 +739,7 @@ func GetDefaultConfig() *UserConfig {
 MainPanelSplitMode: "flexible",
 EnlargedSideViewLocation: "left",
 WrapLinesInStagingView: true,
-UseHunkModeInStagingView: false,
+UseHunkModeInStagingView: true,
 Language: "auto",
 TimeFormat: "02 Jan 06",
 ShortTimeFormat: time.Kitchen,

pkg/gui/controllers/commits_files_controller.go

@@ -494,6 +494,8 @@ func (self *CommitFilesController) enterCommitFile(node *filetree.CommitFileNode
 }
 
 self.c.Context().Push(self.c.Contexts().CustomPatchBuilder, opts)
+self.c.Helpers().PatchBuilding.ShowHunkStagingHint()
+
 return nil
 },
 })