Replace paging config with an array of pagers

Author: stefanhaller

docs/Config.md

@@ -292,22 +292,29 @@ gui:
 
 # Config relating to git
 git:
-  # See https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Pagers.md
-  paging:
-    # Value of the --color arg in the git diff command. Some pagers want this to be set to 'always' and some want it set to 'never'
-    colorArg: always
-
-    # e.g.
-    # diff-so-fancy
-    # delta --dark --paging=never
-    # ydiff -p cat -s --wrap --width={{columnWidth}}
-    pager: ""
-
-    # e.g. 'difft --color=always'
-    externalDiffCommand: ""
-
-    # If true, Lazygit will use git's `diff.external` config for paging. The advantage over `externalDiffCommand` is that this can be configured per file type in .gitattributes; see https://git-scm.com/docs/gitattributes#_defining_an_external_diff_driver.
-    useExternalDiffGitConfig: false
+  # Array of pagers. Each entry has the following format:
+  #
+  #   # Value of the --color arg in the git diff command. Some pagers want
+  #   # this to be set to 'always' and some want it set to 'never'
+  #   colorArg: "always"
+  #
+  #   # e.g.
+  #   # diff-so-fancy
+  #   # delta --dark --paging=never
+  #   # ydiff -p cat -s --wrap --width={{columnWidth}}
+  #   pager: ""
+  #
+  #   # e.g. 'difft --color=always'
+  #   externalDiffCommand: ""
+  #
+  #   # If true, Lazygit will use git's `diff.external` config for paging.
+  #   # The advantage over `externalDiffCommand` is that this can be
+  #   # configured per file type in .gitattributes; see
+  #   # https://git-scm.com/docs/gitattributes#_defining_an_external_diff_driver.
+  #   useExternalDiffGitConfig: false
+  #
+  # See https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Pagers.md for more information.
+  pagers: []
 
   # Config relating to committing
   commit:
@@ -585,6 +592,7 @@ keybinding:
     prevTab: '['
     nextScreenMode: +
     prevScreenMode: _
+    cyclePagers: '|'
     undo: z
     redo: Z
     filteringMenu: <c-s>

docs/Custom_Pagers.md

@@ -4,23 +4,27 @@ Lazygit supports custom pagers, [configured](/docs/Config.md) in the config.yml
 
 Support does not extend to Windows users, because we're making use of a package which doesn't have Windows support. However, see [below](#emulating-custom-pagers-on-windows) for a workaround.
 
-## Default:
+Multiple pagers are supported; you can cycle through them with the `|` key. This can be useful if you usually prefer a particular pager, but want to use a different one for certain kinds of diffs.
+
+Pagers are configured with the `pagers` array in the git section; here's an example for a multi-pager setup:
 
 ```yaml
 git:
-  paging:
-    colorArg: always
+  pagers:
+    - pager: delta --dark --paging=never
+    - pager: ydiff -p cat -s --wrap --width={{columnWidth}}
+      colorArg: never
+    - externalDiffCommand: difft --color=always
 ```
 
-the `colorArg` key is for whether you want the `--color=always` arg in your `git diff` command. Some pagers want it set to `always`, others want it set to `never`.
+The `colorArg` key is for whether you want the `--color=always` arg in your `git diff` command. Some pagers want it set to `always`, others want it set to `never`. The default is `always`, since that's what most pagers need.
 
 ## Delta:
 
 ```yaml
 git:
-  paging:
-    colorArg: always
-    pager: delta --dark --paging=never
+  pagers:
+    - pager: delta --dark --paging=never
 ```
 
 ![](https://i.imgur.com/QJpQkF3.png)
@@ -31,9 +35,8 @@ A cool feature of delta is --hyperlinks, which renders clickable links for the l
 
 ```yaml
 git:
-  paging:
-    colorArg: always
-    pager: diff-so-fancy
+  pagers:
+    - pager: diff-so-fancy
 ```
 
 ![](https://i.imgur.com/rjH1TpT.png)
@@ -44,9 +47,9 @@ git:
 gui:
   sidePanelWidth: 0.2 # gives you more space to show things side-by-side
 git:
-  paging:
-    colorArg: never
-    pager: ydiff -p cat -s --wrap --width={{columnWidth}}
+  pagers:
+    - colorArg: never
+      pager: ydiff -p cat -s --wrap --width={{columnWidth}}
 ```
 
 ![](https://i.imgur.com/vaa8z0H.png)
@@ -61,8 +64,8 @@ These can be used in lazygit by using the `externalDiffCommand` config; in the c
 
 ```yaml
 git:
-  paging:
-    externalDiffCommand: difft --color=always
+  pagers:
+    - externalDiffCommand: difft --color=always
 ```
 
 The `colorArg` and `pager` options are not used in this case.
@@ -71,16 +74,16 @@ You can add whatever extra arguments you prefer for your difftool; for instance
 
 ```yaml
 git:
-  paging:
-    externalDiffCommand: difft --color=always --display=inline --syntax-highlight=off
+  pagers:
+    - externalDiffCommand: difft --color=always --display=inline --syntax-highlight=off
 ```
 
 Instead of setting this command in lazygit's `externalDiffCommand` config, you can also tell lazygit to use the external diff command that is configured in git itself (`diff.external`), by using
 
 ```yaml
 git:
-  paging:
-    useExternalDiffGitConfig: true
+  pagers:
+    - useExternalDiffGitConfig: true
 ```
 
 This can be useful if you also want to use it for diffs on the command line, and it also has the advantage that you can configure it per file type in `.gitattributes`; see https://git-scm.com/docs/gitattributes#_defining_an_external_diff_driver.
@@ -106,8 +109,8 @@ In your lazygit config, use
 
 ```yml
 git:
-  paging:
-    externalDiffCommand: "C:/wherever/lazygit-pager.ps1"
+  pagers:
+    - externalDiffCommand: "C:/wherever/lazygit-pager.ps1"
 ```
 
 The main limitation of this approach compared to a "real" pager is that renames are not displayed correctly; they are shown as if they were modifications of the old file. (This affects only the hunk headers; the diff itself is always correct.)

pkg/commands/git_commands/commit_test.go

@@ -255,8 +255,7 @@ func TestCommitShowCmdObj(t *testing.T) {
 		contextSize         uint64
 		similarityThreshold int
 		ignoreWhitespace    bool
-		extDiffCmd          string
-		useExtDiffGitConfig bool
+		pagerConfig         *config.PagingConfig
 		expected            []string
 	}
 
@@ -267,7 +266,7 @@ func TestCommitShowCmdObj(t *testing.T) {
 			contextSize:         3,
 			similarityThreshold: 50,
 			ignoreWhitespace:    false,
-			extDiffCmd:          "",
+			pagerConfig:         nil,
 			expected:            []string{"-C", "/path/to/worktree", "-c", "diff.noprefix=false", "show", "--no-ext-diff", "--submodule", "--color=always", "--unified=3", "--stat", "--decorate", "-p", "1234567890", "--find-renames=50%", "--"},
 		},
 		{
@@ -276,7 +275,7 @@ func TestCommitShowCmdObj(t *testing.T) {
 			contextSize:         3,
 			similarityThreshold: 50,
 			ignoreWhitespace:    false,
-			extDiffCmd:          "",
+			pagerConfig:         nil,
 			expected:            []string{"-C", "/path/to/worktree", "-c", "diff.noprefix=false", "show", "--no-ext-diff", "--submodule", "--color=always", "--unified=3", "--stat", "--decorate", "-p", "1234567890", "--find-renames=50%", "--", "file.txt"},
 		},
 		{
@@ -285,7 +284,7 @@ func TestCommitShowCmdObj(t *testing.T) {
 			contextSize:         77,
 			similarityThreshold: 50,
 			ignoreWhitespace:    false,
-			extDiffCmd:          "",
+			pagerConfig:         nil,
 			expected:            []string{"-C", "/path/to/worktree", "-c", "diff.noprefix=false", "show", "--no-ext-diff", "--submodule", "--color=always", "--unified=77", "--stat", "--decorate", "-p", "1234567890", "--find-renames=50%", "--"},
 		},
 		{
@@ -294,7 +293,7 @@ func TestCommitShowCmdObj(t *testing.T) {
 			contextSize:         3,
 			similarityThreshold: 33,
 			ignoreWhitespace:    false,
-			extDiffCmd:          "",
+			pagerConfig:         nil,
 			expected:            []string{"-C", "/path/to/worktree", "-c", "diff.noprefix=false", "show", "--no-ext-diff", "--submodule", "--color=always", "--unified=3", "--stat", "--decorate", "-p", "1234567890", "--find-renames=33%", "--"},
 		},
 		{
@@ -303,7 +302,7 @@ func TestCommitShowCmdObj(t *testing.T) {
 			contextSize:         77,
 			similarityThreshold: 50,
 			ignoreWhitespace:    true,
-			extDiffCmd:          "",
+			pagerConfig:         nil,
 			expected:            []string{"-C", "/path/to/worktree", "-c", "diff.noprefix=false", "show", "--no-ext-diff", "--submodule", "--color=always", "--unified=77", "--stat", "--decorate", "-p", "1234567890", "--ignore-all-space", "--find-renames=50%", "--"},
 		},
 		{
@@ -312,7 +311,7 @@ func TestCommitShowCmdObj(t *testing.T) {
 			contextSize:         3,
 			similarityThreshold: 50,
 			ignoreWhitespace:    false,
-			extDiffCmd:          "difft --color=always",
+			pagerConfig:         &config.PagingConfig{ExternalDiffCommand: "difft --color=always"},
 			expected:            []string{"-C", "/path/to/worktree", "-c", "diff.external=difft --color=always", "-c", "diff.noprefix=false", "show", "--ext-diff", "--submodule", "--color=always", "--unified=3", "--stat", "--decorate", "-p", "1234567890", "--find-renames=50%", "--"},
 		},
 		{
@@ -321,19 +320,20 @@ func TestCommitShowCmdObj(t *testing.T) {
 			contextSize:         3,
 			similarityThreshold: 50,
 			ignoreWhitespace:    false,
-			useExtDiffGitConfig: true,
+			pagerConfig:         &config.PagingConfig{UseExternalDiffGitConfig: true},
 			expected:            []string{"-C", "/path/to/worktree", "-c", "diff.noprefix=false", "show", "--ext-diff", "--submodule", "--color=always", "--unified=3", "--stat", "--decorate", "-p", "1234567890", "--find-renames=50%", "--"},
 		},
 	}
 
 	for _, s := range scenarios {
 		t.Run(s.testName, func(t *testing.T) {
 			userConfig := config.GetDefaultConfig()
-			userConfig.Git.Paging.ExternalDiffCommand = s.extDiffCmd
+			if s.pagerConfig != nil {
+				userConfig.Git.Pagers = []config.PagingConfig{*s.pagerConfig}
+			}
 			userConfig.Git.IgnoreWhitespaceInDiffView = s.ignoreWhitespace
 			userConfig.Git.DiffContextSize = s.contextSize
 			userConfig.Git.RenameSimilarityThreshold = s.similarityThreshold
-			userConfig.Git.Paging.UseExternalDiffGitConfig = s.useExtDiffGitConfig
 
 			runner := oscommands.NewFakeRunner(t).ExpectGitArgs(s.expected, "", nil)
 			repoPaths := RepoPaths{

pkg/commands/git_commands/stash_test.go

@@ -103,8 +103,7 @@ func TestStashStashEntryCmdObj(t *testing.T) {
 		contextSize         uint64
 		similarityThreshold int
 		ignoreWhitespace    bool
-		extDiffCmd          string
-		useExtDiffGitConfig bool
+		pagerConfig         *config.PagingConfig
 		expected            []string
 	}
 
@@ -139,7 +138,7 @@ func TestStashStashEntryCmdObj(t *testing.T) {
 			contextSize:         3,
 			similarityThreshold: 50,
 			ignoreWhitespace:    false,
-			extDiffCmd:          "difft --color=always",
+			pagerConfig:         &config.PagingConfig{ExternalDiffCommand: "difft --color=always"},
 			expected:            []string{"git", "-C", "/path/to/worktree", "-c", "diff.external=difft --color=always", "stash", "show", "-p", "--stat", "-u", "--ext-diff", "--color=always", "--unified=3", "--find-renames=50%", "refs/stash@{5}"},
 		},
 		{
@@ -148,7 +147,7 @@ func TestStashStashEntryCmdObj(t *testing.T) {
 			contextSize:         3,
 			similarityThreshold: 50,
 			ignoreWhitespace:    false,
-			useExtDiffGitConfig: true,
+			pagerConfig:         &config.PagingConfig{UseExternalDiffGitConfig: true},
 			expected:            []string{"git", "-C", "/path/to/worktree", "stash", "show", "-p", "--stat", "-u", "--ext-diff", "--color=always", "--unified=3", "--find-renames=50%", "refs/stash@{5}"},
 		},
 		{
@@ -167,8 +166,9 @@ func TestStashStashEntryCmdObj(t *testing.T) {
 			userConfig.Git.IgnoreWhitespaceInDiffView = s.ignoreWhitespace
 			userConfig.Git.DiffContextSize = s.contextSize
 			userConfig.Git.RenameSimilarityThreshold = s.similarityThreshold
-			userConfig.Git.Paging.ExternalDiffCommand = s.extDiffCmd
-			userConfig.Git.Paging.UseExternalDiffGitConfig = s.useExtDiffGitConfig
+			if s.pagerConfig != nil {
+				userConfig.Git.Pagers = []config.PagingConfig{*s.pagerConfig}
+			}
 			repoPaths := RepoPaths{
 				worktreePath: "/path/to/worktree",
 			}

pkg/config/pager_config.go

@@ -8,29 +8,75 @@ import (
 
 type PagerConfig struct {
 	getUserConfig func() *UserConfig
+	pagerIndex    int
 }
 
 func NewPagerConfig(getUserConfig func() *UserConfig) *PagerConfig {
 	return &PagerConfig{getUserConfig: getUserConfig}
 }
 
+func (self *PagerConfig) currentPagerConfig() *PagingConfig {
+	pagers := self.getUserConfig().Git.Pagers
+	if len(pagers) == 0 {
+		return nil
+	}
+
+	// Guard against the pager index being out of range, which can happen if the user
+	// has removed pagers from their config file while lazygit is running.
+	if self.pagerIndex >= len(pagers) {
+		self.pagerIndex = 0
+	}
+
+	return &pagers[self.pagerIndex]
+}
+
 func (self *PagerConfig) GetPagerCommand(width int) string {
+	currentPagerConfig := self.currentPagerConfig()
+	if currentPagerConfig == nil {
+		return ""
+	}
+
 	templateValues := map[string]string{
 		"columnWidth": strconv.Itoa(width/2 - 6),
 	}
 
-	pagerTemplate := string(self.getUserConfig().Git.Paging.Pager)
+	pagerTemplate := string(currentPagerConfig.Pager)
 	return utils.ResolvePlaceholderString(pagerTemplate, templateValues)
 }
 
 func (self *PagerConfig) GetColorArg() string {
-	return self.getUserConfig().Git.Paging.ColorArg
+	currentPagerConfig := self.currentPagerConfig()
+	if currentPagerConfig == nil {
+		return "always"
+	}
+
+	colorArg := currentPagerConfig.ColorArg
+	if colorArg == "" {
+		return "always"
+	}
+	return colorArg
 }
 
 func (self *PagerConfig) GetExternalDiffCommand() string {
-	return self.getUserConfig().Git.Paging.ExternalDiffCommand
+	currentPagerConfig := self.currentPagerConfig()
+	if currentPagerConfig == nil {
+		return ""
+	}
+	return currentPagerConfig.ExternalDiffCommand
 }
 
 func (self *PagerConfig) GetUseExternalDiffGitConfig() bool {
-	return self.getUserConfig().Git.Paging.UseExternalDiffGitConfig
+	currentPagerConfig := self.currentPagerConfig()
+	if currentPagerConfig == nil {
+		return false
+	}
+	return currentPagerConfig.UseExternalDiffGitConfig
+}
+
+func (self *PagerConfig) CyclePagers() {
+	self.pagerIndex = (self.pagerIndex + 1) % len(self.getUserConfig().Git.Pagers)
+}
+
+func (self *PagerConfig) CurrentPagerIndex() (int, int) {
+	return self.pagerIndex, len(self.getUserConfig().Git.Pagers)
 }