Add PagerConfig

This is an object that is owned by Gui, is accessible through GuiCommon.State(), and also passed down to GitCommand, where it is mostly needed. Right now it simply wraps access to the Git.Paging config, which isn't very exciting, but we'll extend it in the next commit to handle a slice of pagers (and maintain the currently selected pager index), and doing this refactoring up front allows us to make that change without having to touch clients.
2025-10-16 09:27:37 +03:00 · 2025-10-09 15:42:45 +02:00
parent ed05470732
commit 765c9eb85c
12 changed files with 93 additions and 47 deletions
--- a/pkg/commands/git.go
+++ b/pkg/commands/git.go
@@ -12,6 +12,7 @@ import (
 	"github.com/jesseduffield/lazygit/pkg/commands/oscommands"
 	"github.com/jesseduffield/lazygit/pkg/commands/patch"
 	"github.com/jesseduffield/lazygit/pkg/common"
+	"github.com/jesseduffield/lazygit/pkg/config"
 	"github.com/jesseduffield/lazygit/pkg/utils"
 )

@@ -59,6 +60,7 @@ func NewGitCommand(
 	version *git_commands.GitVersion,
 	osCommand *oscommands.OSCommand,
 	gitConfig git_config.IGitConfig,
+	pagerConfig *config.PagerConfig,
 ) (*GitCommand, error) {
 	repoPaths, err := git_commands.GetRepoPaths(osCommand.Cmd, version)
 	if err != nil {
@@ -88,6 +90,7 @@ func NewGitCommand(
 		gitConfig,
 		repoPaths,
 		repository,
+		pagerConfig,
 	), nil
 }

@@ -98,6 +101,7 @@ func NewGitCommandAux(
 	gitConfig git_config.IGitConfig,
 	repoPaths *git_commands.RepoPaths,
 	repo *gogit.Repository,
+	pagerConfig *config.PagerConfig,
 ) *GitCommand {
 	cmd := NewGitCmdObjBuilder(cmn.Log, osCommand.Cmd)

@@ -108,7 +112,7 @@ func NewGitCommandAux(
 	// common ones are: cmn, osCommand, dotGitDir, configCommands
 	configCommands := git_commands.NewConfigCommands(cmn, gitConfig, repo)

-	gitCommon := git_commands.NewGitCommon(cmn, version, cmd, osCommand, repoPaths, repo, configCommands)
+	gitCommon := git_commands.NewGitCommon(cmn, version, cmd, osCommand, repoPaths, repo, configCommands, pagerConfig)

 	fileLoader := git_commands.NewFileLoader(gitCommon, cmd, configCommands)
 	statusCommands := git_commands.NewStatusCommands(gitCommon)
--- a/pkg/commands/git_commands/commit.go
+++ b/pkg/commands/git_commands/commit.go
@@ -256,14 +256,14 @@ func (self *CommitCommands) AmendHeadCmdObj() *oscommands.CmdObj {
 func (self *CommitCommands) ShowCmdObj(hash string, filterPaths []string) *oscommands.CmdObj {
 	contextSize := self.UserConfig().Git.DiffContextSize

-	extDiffCmd := self.UserConfig().Git.Paging.ExternalDiffCommand
-	useExtDiffGitConfig := self.UserConfig().Git.Paging.UseExternalDiffGitConfig
+	extDiffCmd := self.pagerConfig.GetExternalDiffCommand()
+	useExtDiffGitConfig := self.pagerConfig.GetUseExternalDiffGitConfig()
 	cmdArgs := NewGitCmd("show").
 		Config("diff.noprefix=false").
 		ConfigIf(extDiffCmd != "", "diff.external="+extDiffCmd).
 		ArgIfElse(extDiffCmd != "" || useExtDiffGitConfig, "--ext-diff", "--no-ext-diff").
 		Arg("--submodule").
-		Arg("--color="+self.UserConfig().Git.Paging.ColorArg).
+		Arg("--color="+self.pagerConfig.GetColorArg()).
 		Arg(fmt.Sprintf("--unified=%d", contextSize)).
 		Arg("--stat").
 		Arg("--decorate").
--- a/pkg/commands/git_commands/common.go
+++ b/pkg/commands/git_commands/common.go
@@ -4,16 +4,18 @@ import (
 	gogit "github.com/jesseduffield/go-git/v5"
 	"github.com/jesseduffield/lazygit/pkg/commands/oscommands"
 	"github.com/jesseduffield/lazygit/pkg/common"
+	"github.com/jesseduffield/lazygit/pkg/config"
 )

 type GitCommon struct {
 	*common.Common
-	version   *GitVersion
-	cmd       oscommands.ICmdObjBuilder
-	os        *oscommands.OSCommand
-	repoPaths *RepoPaths
-	repo      *gogit.Repository
-	config    *ConfigCommands
+	version     *GitVersion
+	cmd         oscommands.ICmdObjBuilder
+	os          *oscommands.OSCommand
+	repoPaths   *RepoPaths
+	repo        *gogit.Repository
+	config      *ConfigCommands
+	pagerConfig *config.PagerConfig
 }

 func NewGitCommon(
@@ -24,14 +26,16 @@ func NewGitCommon(
 	repoPaths *RepoPaths,
 	repo *gogit.Repository,
 	config *ConfigCommands,
+	pagerConfig *config.PagerConfig,
 ) *GitCommon {
 	return &GitCommon{
-		Common:    cmn,
-		version:   version,
-		cmd:       cmd,
-		os:        osCommand,
-		repoPaths: repoPaths,
-		repo:      repo,
-		config:    config,
+		Common:      cmn,
+		version:     version,
+		cmd:         cmd,
+		os:          osCommand,
+		repoPaths:   repoPaths,
+		repo:        repo,
+		config:      config,
+		pagerConfig: pagerConfig,
 	}
 }
--- a/pkg/commands/git_commands/config.go
+++ b/pkg/commands/git_commands/config.go
@@ -1,13 +1,10 @@
 package git_commands

 import (
-	"strconv"
-
 	gogit "github.com/jesseduffield/go-git/v5"
 	"github.com/jesseduffield/go-git/v5/config"
 	"github.com/jesseduffield/lazygit/pkg/commands/git_config"
 	"github.com/jesseduffield/lazygit/pkg/common"
-	"github.com/jesseduffield/lazygit/pkg/utils"
 )

 type ConfigCommands struct {
@@ -29,15 +26,6 @@ func NewConfigCommands(
 	}
 }

-func (self *ConfigCommands) GetPager(width int) string {
-	templateValues := map[string]string{
-		"columnWidth": strconv.Itoa(width/2 - 6),
-	}
-
-	pagerTemplate := string(self.UserConfig().Git.Paging.Pager)
-	return utils.ResolvePlaceholderString(pagerTemplate, templateValues)
-}
-
 type GpgConfigKey string

 const (
--- a/pkg/commands/git_commands/deps_test.go
+++ b/pkg/commands/git_commands/deps_test.go
@@ -61,6 +61,10 @@ func buildGitCommon(deps commonDeps) *GitCommon {
 		gitCommon.Common.SetUserConfig(config.GetDefaultConfig())
 	}

+	gitCommon.pagerConfig = config.NewPagerConfig(func() *config.UserConfig {
+		return gitCommon.Common.UserConfig()
+	})
+
 	gitCommon.version = deps.gitVersion
 	if gitCommon.version == nil {
 		gitCommon.version = &GitVersion{2, 0, 0, ""}
--- a/pkg/commands/git_commands/diff.go
+++ b/pkg/commands/git_commands/diff.go
@@ -19,9 +19,9 @@ func NewDiffCommands(gitCommon *GitCommon) *DiffCommands {
 // This is for generating diffs to be shown in the UI (e.g. rendering a range
 // diff to the main view). It uses a custom pager if one is configured.
 func (self *DiffCommands) DiffCmdObj(diffArgs []string) *oscommands.CmdObj {
-	extDiffCmd := self.UserConfig().Git.Paging.ExternalDiffCommand
+	extDiffCmd := self.pagerConfig.GetExternalDiffCommand()
 	useExtDiff := extDiffCmd != ""
-	useExtDiffGitConfig := self.UserConfig().Git.Paging.UseExternalDiffGitConfig
+	useExtDiffGitConfig := self.pagerConfig.GetUseExternalDiffGitConfig()
 	ignoreWhitespace := self.UserConfig().Git.IgnoreWhitespaceInDiffView

 	return self.cmd.New(
@@ -30,7 +30,7 @@ func (self *DiffCommands) DiffCmdObj(diffArgs []string) *oscommands.CmdObj {
 			ConfigIf(useExtDiff, "diff.external="+extDiffCmd).
 			ArgIfElse(useExtDiff || useExtDiffGitConfig, "--ext-diff", "--no-ext-diff").
 			Arg("--submodule").
-			Arg(fmt.Sprintf("--color=%s", self.UserConfig().Git.Paging.ColorArg)).
+			Arg(fmt.Sprintf("--color=%s", self.pagerConfig.GetColorArg())).
 			ArgIf(ignoreWhitespace, "--ignore-all-space").
 			Arg(fmt.Sprintf("--unified=%d", self.UserConfig().Git.DiffContextSize)).
 			Arg(diffArgs...).
--- a/pkg/commands/git_commands/stash.go
+++ b/pkg/commands/git_commands/stash.go
@@ -81,8 +81,8 @@ func (self *StashCommands) Hash(index int) (string, error) {
 }

 func (self *StashCommands) ShowStashEntryCmdObj(index int) *oscommands.CmdObj {
-	extDiffCmd := self.UserConfig().Git.Paging.ExternalDiffCommand
-	useExtDiffGitConfig := self.UserConfig().Git.Paging.UseExternalDiffGitConfig
+	extDiffCmd := self.pagerConfig.GetExternalDiffCommand()
+	useExtDiffGitConfig := self.pagerConfig.GetUseExternalDiffGitConfig()

 	// "-u" is the same as "--include-untracked", but the latter fails in older git versions for some reason
 	cmdArgs := NewGitCmd("stash").Arg("show").
@@ -91,7 +91,7 @@ func (self *StashCommands) ShowStashEntryCmdObj(index int) *oscommands.CmdObj {
 		Arg("-u").
 		ConfigIf(extDiffCmd != "", "diff.external="+extDiffCmd).
 		ArgIfElse(extDiffCmd != "" || useExtDiffGitConfig, "--ext-diff", "--no-ext-diff").
-		Arg(fmt.Sprintf("--color=%s", self.UserConfig().Git.Paging.ColorArg)).
+		Arg(fmt.Sprintf("--color=%s", self.pagerConfig.GetColorArg())).
 		Arg(fmt.Sprintf("--unified=%d", self.UserConfig().Git.DiffContextSize)).
 		ArgIf(self.UserConfig().Git.IgnoreWhitespaceInDiffView, "--ignore-all-space").
 		Arg(fmt.Sprintf("--find-renames=%d%%", self.UserConfig().Git.RenameSimilarityThreshold)).
--- a/pkg/commands/git_commands/working_tree.go
+++ b/pkg/commands/git_commands/working_tree.go
@@ -258,7 +258,7 @@ func (self *WorkingTreeCommands) WorktreeFileDiff(file *models.File, plain bool,
 }

 func (self *WorkingTreeCommands) WorktreeFileDiffCmdObj(node models.IFile, plain bool, cached bool) *oscommands.CmdObj {
-	colorArg := self.UserConfig().Git.Paging.ColorArg
+	colorArg := self.pagerConfig.GetColorArg()
 	if plain {
 		colorArg = "never"
 	}
@@ -266,9 +266,9 @@ func (self *WorkingTreeCommands) WorktreeFileDiffCmdObj(node models.IFile, plain
 	contextSize := self.UserConfig().Git.DiffContextSize
 	prevPath := node.GetPreviousPath()
 	noIndex := !node.GetIsTracked() && !node.GetHasStagedChanges() && !cached && node.GetIsFile()
-	extDiffCmd := self.UserConfig().Git.Paging.ExternalDiffCommand
+	extDiffCmd := self.pagerConfig.GetExternalDiffCommand()
 	useExtDiff := extDiffCmd != "" && !plain
-	useExtDiffGitConfig := self.UserConfig().Git.Paging.UseExternalDiffGitConfig && !plain
+	useExtDiffGitConfig := self.pagerConfig.GetUseExternalDiffGitConfig() && !plain

 	cmdArgs := NewGitCmd("diff").
 		ConfigIf(useExtDiff, "diff.external="+extDiffCmd).
@@ -299,14 +299,14 @@ func (self *WorkingTreeCommands) ShowFileDiff(from string, to string, reverse bo
 func (self *WorkingTreeCommands) ShowFileDiffCmdObj(from string, to string, reverse bool, fileName string, plain bool) *oscommands.CmdObj {
 	contextSize := self.UserConfig().Git.DiffContextSize

-	colorArg := self.UserConfig().Git.Paging.ColorArg
+	colorArg := self.pagerConfig.GetColorArg()
 	if plain {
 		colorArg = "never"
 	}

-	extDiffCmd := self.UserConfig().Git.Paging.ExternalDiffCommand
+	extDiffCmd := self.pagerConfig.GetExternalDiffCommand()
 	useExtDiff := extDiffCmd != "" && !plain
-	useExtDiffGitConfig := self.UserConfig().Git.Paging.UseExternalDiffGitConfig && !plain
+	useExtDiffGitConfig := self.pagerConfig.GetUseExternalDiffGitConfig() && !plain

 	cmdArgs := NewGitCmd("diff").
 		Config("diff.noprefix=false").