Standardise panel size naming

We had some conflicting names: screen-mode, window-size, and
window-maximisation. I think panel-size sounds good.

Author: jesseduffield

docs/Config.md

@@ -81,7 +81,7 @@ gui:
   # - 'flexible': (default) split the window horizontally if the window is wide enough, otherwise split vertically
   mainPanelSplitMode: flexible
 
-  # How the window is split when in half screen mode (i.e. after hitting '+' once).
+  # How the window is split when in half panel-size mode (i.e. after hitting '+' once).
   # Possible values:
   # - 'left': split the window horizontally (side panel on the left, main view on the right)
   # - 'top': split the window vertically (side panel on top, main view below)
@@ -221,7 +221,7 @@ gui:
 
   # Default size for focused window. Window size can be changed from within Lazygit with '+' and '_' (but this won't change the default).
   # One of: 'normal' (default) | 'half' | 'full'
-  windowSize: normal
+  panelSize: normal
 
   # Window border style.
   # One of 'rounded' (default) | 'single' | 'double' | 'hidden'
@@ -532,8 +532,8 @@ keybinding:
     createPatchOptionsMenu: <c-p>
     nextTab: ']'
     prevTab: '['
-    nextScreenMode: +
-    prevScreenMode: _
+    nextPanelSize: +
+    prevPanelSize: _
     undo: z
     redo: <c-z>
     filteringMenu: <c-s>

docs/keybindings/Keybindings_en.md

@@ -22,8 +22,8 @@ _Legend: `<c-b>` means ctrl+b, `<a-b>` means alt+b, `B` means shift+b_
 | `` <c-p> `` | View custom patch options |  |
 | `` m `` | View merge/rebase options | View options to abort/continue/skip the current merge/rebase. |
 | `` R `` | Refresh | Refresh the git state (i.e. run `git status`, `git branch`, etc in background to update the contents of panels). This does not run `git fetch`. |
-| `` + `` | Next screen mode (normal/half/fullscreen) |  |
-| `` _ `` | Prev screen mode |  |
+| `` + `` | Next panel size (normal/half/fullscreen) |  |
+| `` _ `` | Prev panel size |  |
 | `` ? `` | Open keybindings menu |  |
 | `` <c-s> `` | View filter options | View options for filtering the commit log, so that only commits matching the filter are shown. |
 | `` W `` | View diffing options | View options relating to diffing two refs e.g. diffing against selected ref, entering ref to diff against, and reversing the diff direction. |

pkg/app/entry_point.go

@@ -33,7 +33,7 @@ type cliArgs struct {
 	WorkTree           string
 	GitDir             string
 	CustomConfigFile   string
-	ScreenMode         string
+	PanelSize          string
 	PrintVersionInfo   bool
 	Debug              bool
 	TailLogs           bool
@@ -165,7 +165,7 @@ func Start(buildInfo *BuildInfo, integrationTest integrationTypes.IntegrationTes
 
 	parsedGitArg := parseGitArg(cliArgs.GitArg)
 
-	Run(appConfig, common, appTypes.NewStartArgs(cliArgs.FilterPath, parsedGitArg, cliArgs.ScreenMode, integrationTest))
+	Run(appConfig, common, appTypes.NewStartArgs(cliArgs.FilterPath, parsedGitArg, cliArgs.PanelSize, integrationTest))
 }
 
 func parseCliArgsAndEnvVars() *cliArgs {
@@ -210,8 +210,8 @@ func parseCliArgsAndEnvVars() *cliArgs {
 	customConfigFile := ""
 	flaggy.String(&customConfigFile, "ucf", "use-config-file", "Comma separated list to custom config file(s)")
 
-	screenMode := ""
-	flaggy.String(&screenMode, "sm", "screen-mode", "The initial screen-mode, which determines the size of the focused panel. Valid options: 'normal' (default), 'half', 'full'")
+	PanelSize := ""
+	flaggy.String(&PanelSize, "ps", "panel-size", "The initial size of the focused panel. Valid options: 'normal' (default), 'half', 'full'")
 
 	flaggy.Parse()
 
@@ -233,7 +233,7 @@ func parseCliArgsAndEnvVars() *cliArgs {
 		WorkTree:           workTree,
 		GitDir:             gitDir,
 		CustomConfigFile:   customConfigFile,
-		ScreenMode:         screenMode,
+		PanelSize:          PanelSize,
 	}
 }
 

pkg/app/types/types.go

@@ -12,8 +12,8 @@ type StartArgs struct {
 	IntegrationTest integrationTypes.IntegrationTest
 	// FilterPath determines which path we're going to filter on so that we only see commits from that file.
 	FilterPath string
-	// ScreenMode determines the initial Screen Mode (normal, half or full) to use
-	ScreenMode string
+	// PanelSize determines the initial panel size (normal, half or full) to use
+	PanelSize string
 }
 
 type GitArg string
@@ -26,11 +26,11 @@ const (
 	GitArgStash  GitArg = "stash"
 )
 
-func NewStartArgs(filterPath string, gitArg GitArg, screenMode string, test integrationTypes.IntegrationTest) StartArgs {
+func NewStartArgs(filterPath string, gitArg GitArg, PanelSize string, test integrationTypes.IntegrationTest) StartArgs {
 	return StartArgs{
 		FilterPath:      filterPath,
 		GitArg:          gitArg,
-		ScreenMode:      screenMode,
+		PanelSize:       PanelSize,
 		IntegrationTest: test,
 	}
 }

pkg/config/app_config.go

@@ -217,16 +217,25 @@ func loadUserConfig(configFiles []*ConfigFile, base *UserConfig) (*UserConfig, e
 // from one container to another, or changing the type of a key (e.g. from bool
 // to an enum).
 func migrateUserConfig(path string, content []byte) ([]byte, error) {
-	changedContent, err := yaml_utils.RenameYamlKey(content, []string{"gui", "skipUnstageLineWarning"},
-		"skipDiscardChangeWarning")
-	if err != nil {
-		return nil, fmt.Errorf("Couldn't migrate config file at `%s`: %s", path, err)
-	}
-
-	changedContent, err = yaml_utils.RenameYamlKey(changedContent, []string{"keybinding", "universal", "executeCustomCommand"},
-		"executeShellCommand")
-	if err != nil {
-		return nil, fmt.Errorf("Couldn't migrate config file at `%s`: %s", path, err)
+	changedContent := content
+
+	pathsToReplace := []struct {
+		oldPath []string
+		newName string
+	}{
+		{[]string{"gui", "skipUnstageLineWarning"}, "skipDiscardChangeWarning"},
+		{[]string{"keybinding", "universal", "executeCustomCommand"}, "executeShellCommand"},
+		{[]string{"gui", "windowSize"}, "panelSize"},
+		{[]string{"keybinding", "nextScreenMode"}, "nextPanelSize"},
+		{[]string{"keybinding", "prevScreenMode"}, "prevPanelSize"},
+	}
+
+	var err error
+	for _, pathToReplace := range pathsToReplace {
+		changedContent, err = yaml_utils.RenameYamlKey(changedContent, pathToReplace.oldPath, pathToReplace.newName)
+		if err != nil {
+			return nil, fmt.Errorf("Couldn't migrate config file at `%s` for key %s: %s", path, strings.Join(pathToReplace.oldPath, "."), err)
+		}
 	}
 
 	changedContent, err = changeNullKeybindingsToDisabled(changedContent)

pkg/config/user_config.go

@@ -86,7 +86,7 @@ type GuiConfig struct {
 	// - 'vertical': split the window vertically
 	// - 'flexible': (default) split the window horizontally if the window is wide enough, otherwise split vertically
 	MainPanelSplitMode string `yaml:"mainPanelSplitMode" jsonschema:"enum=horizontal,enum=flexible,enum=vertical"`
-	// How the window is split when in half screen mode (i.e. after hitting '+' once).
+	// How the window is split when in half panel-size mode (i.e. after hitting '+' once).
 	// Possible values:
 	// - 'left': split the window horizontally (side panel on the left, main view on the right)
 	// - 'top': split the window vertically (side panel on top, main view below)
@@ -150,7 +150,7 @@ type GuiConfig struct {
 	SplitDiff string `yaml:"splitDiff" jsonschema:"enum=auto,enum=always"`
 	// Default size for focused window. Window size can be changed from within Lazygit with '+' and '_' (but this won't change the default).
 	// One of: 'normal' (default) | 'half' | 'full'
-	WindowSize string `yaml:"windowSize" jsonschema:"enum=normal,enum=half,enum=full"`
+	PanelSize string `yaml:"panelSize" jsonschema:"enum=normal,enum=half,enum=full"`
 	// Window border style.
 	// One of 'rounded' (default) | 'single' | 'double' | 'hidden'
 	Border string `yaml:"border" jsonschema:"enum=single,enum=double,enum=rounded,enum=hidden"`
@@ -410,8 +410,8 @@ type KeybindingUniversalConfig struct {
 	CreatePatchOptionsMenu            string   `yaml:"createPatchOptionsMenu"`
 	NextTab                           string   `yaml:"nextTab"`
 	PrevTab                           string   `yaml:"prevTab"`
-	NextScreenMode                    string   `yaml:"nextScreenMode"`
-	PrevScreenMode                    string   `yaml:"prevScreenMode"`
+	NextPanelSize                     string   `yaml:"nextPanelSize"`
+	PrevPanelSize                     string   `yaml:"prevPanelSize"`
 	Undo                              string   `yaml:"undo"`
 	Redo                              string   `yaml:"redo"`
 	FilteringMenu                     string   `yaml:"filteringMenu"`
@@ -734,7 +734,7 @@ func GetDefaultConfig() *UserConfig {
 			CommandLogSize:               8,
 			SplitDiff:                    "auto",
 			SkipRewordInEditorWarning:    false,
-			WindowSize:                   "normal",
+			PanelSize:                    "normal",
 			Border:                       "rounded",
 			AnimateExplosion:             true,
 			PortraitMode:                 "auto",
@@ -855,8 +855,8 @@ func GetDefaultConfig() *UserConfig {
 				CreatePatchOptionsMenu:            "<c-p>",
 				NextTab:                           "]",
 				PrevTab:                           "[",
-				NextScreenMode:                    "+",
-				PrevScreenMode:                    "_",
+				NextPanelSize:                     "+",
+				PrevPanelSize:                     "_",
 				Undo:                              "z",
 				Redo:                              "<c-z>",
 				FilteringMenu:                     "<c-s>",

pkg/gui/context/branches_context.go

@@ -28,7 +28,7 @@ func NewBranchesContext(c *ContextCommon) *BranchesContext {
 		return presentation.GetBranchListDisplayStrings(
 			viewModel.GetItems(),
 			c.State().GetItemOperation,
-			c.State().GetRepoState().GetScreenMode() != types.SCREEN_NORMAL,
+			c.State().GetRepoState().GetPanelSize() != types.PANEL_SIZE_NORMAL,
 			c.Modes().Diffing.Ref,
 			c.Views().Branches.InnerWidth(),
 			c.Tr,

pkg/gui/context/local_commits_context.go

@@ -50,7 +50,7 @@ func NewLocalCommitsContext(c *ContextCommon) *LocalCommitsContext {
 			c.Model().Branches,
 			c.Model().CheckedOutBranch,
 			hasRebaseUpdateRefsConfig,
-			c.State().GetRepoState().GetScreenMode() != types.SCREEN_NORMAL,
+			c.State().GetRepoState().GetPanelSize() != types.PANEL_SIZE_NORMAL,
 			c.Modes().CherryPicking.SelectedHashSet(),
 			c.Modes().Diffing.Ref,
 			c.Modes().MarkedBaseCommit.GetHash(),
@@ -77,7 +77,7 @@ func NewLocalCommitsContext(c *ContextCommon) *LocalCommitsContext {
 				Key:                         LOCAL_COMMITS_CONTEXT_KEY,
 				Kind:                        types.SIDE_CONTEXT,
 				Focusable:                   true,
-				NeedsRerenderOnWidthChange:  types.NEEDS_RERENDER_ON_WIDTH_CHANGE_WHEN_SCREEN_MODE_CHANGES,
+				NeedsRerenderOnWidthChange:  types.NEEDS_RERENDER_ON_WIDTH_CHANGE_WHEN_PANEL_SIZE_CHANGES,
 				NeedsRerenderOnHeightChange: true,
 			})),
 			ListRenderer: ListRenderer{
@@ -215,7 +215,7 @@ func shouldShowGraph(c *ContextCommon) bool {
 	case "never":
 		return false
 	case "when-maximised":
-		return c.State().GetRepoState().GetScreenMode() != types.SCREEN_NORMAL
+		return c.State().GetRepoState().GetPanelSize() != types.PANEL_SIZE_NORMAL
 	}
 
 	log.Fatalf("Unknown value for git.log.showGraph: %s. Expected one of: 'always', 'never', 'when-maximised'", value)

pkg/gui/context/reflog_commits_context.go

@@ -29,7 +29,7 @@ func NewReflogCommitsContext(c *ContextCommon) *ReflogCommitsContext {
 	getDisplayStrings := func(_ int, _ int) [][]string {
 		return presentation.GetReflogCommitListDisplayStrings(
 			viewModel.GetItems(),
-			c.State().GetRepoState().GetScreenMode() != types.SCREEN_NORMAL,
+			c.State().GetRepoState().GetPanelSize() != types.PANEL_SIZE_NORMAL,
 			c.Modes().CherryPicking.SelectedHashSet(),
 			c.Modes().Diffing.Ref,
 			time.Now(),
@@ -48,7 +48,7 @@ func NewReflogCommitsContext(c *ContextCommon) *ReflogCommitsContext {
 				Key:                        REFLOG_COMMITS_CONTEXT_KEY,
 				Kind:                       types.SIDE_CONTEXT,
 				Focusable:                  true,
-				NeedsRerenderOnWidthChange: types.NEEDS_RERENDER_ON_WIDTH_CHANGE_WHEN_SCREEN_MODE_CHANGES,
+				NeedsRerenderOnWidthChange: types.NEEDS_RERENDER_ON_WIDTH_CHANGE_WHEN_PANEL_SIZE_CHANGES,
 			})),
 			ListRenderer: ListRenderer{
 				list:              viewModel,

pkg/gui/context/sub_commits_context.go

@@ -40,7 +40,7 @@ func NewSubCommitsContext(
 
 	getDisplayStrings := func(startIdx int, endIdx int) [][]string {
 		// This can happen if a sub-commits view is asked to be rerendered while
-		// it is invisible; for example when switching screen modes, which
+		// it is invisible; for example when switching panel size, which
 		// rerenders all views.
 		if viewModel.GetRef() == nil {
 			return [][]string{}
@@ -64,7 +64,7 @@ func NewSubCommitsContext(
 			branches,
 			viewModel.GetRef().RefName(),
 			hasRebaseUpdateRefsConfig,
-			c.State().GetRepoState().GetScreenMode() != types.SCREEN_NORMAL,
+			c.State().GetRepoState().GetPanelSize() != types.PANEL_SIZE_NORMAL,
 			c.Modes().CherryPicking.SelectedHashSet(),
 			c.Modes().Diffing.Ref,
 			"",
@@ -121,7 +121,7 @@ func NewSubCommitsContext(
 				Kind:                        types.SIDE_CONTEXT,
 				Focusable:                   true,
 				Transient:                   true,
-				NeedsRerenderOnWidthChange:  types.NEEDS_RERENDER_ON_WIDTH_CHANGE_WHEN_SCREEN_MODE_CHANGES,
+				NeedsRerenderOnWidthChange:  types.NEEDS_RERENDER_ON_WIDTH_CHANGE_WHEN_PANEL_SIZE_CHANGES,
 				NeedsRerenderOnHeightChange: true,
 			})),
 			ListRenderer: ListRenderer{