Move IgnoreWhitespaceInDiffView to user config

When toggling the value in the UI we simply overwrite the value in UserConfig;
this would be bad if there was ever a chance that we want to write the user
config back to disk, but it is very unlikely that we can do that, because
currently we have no way to tell which parts of the config come from the global
config file and which ones come from a repo-local one.

docs/Config.md

@@ -366,6 +366,9 @@ git:
   allBranchesLogCmds:
     - git log --graph --all --color=always --abbrev-commit --decorate --date=relative  --pretty=medium
 
+  # If true, git diffs are rendered with the `--ignore-all-space` flag, which ignores whitespace changes. Can be toggled from within Lazygit with `<c-w>`.
+  ignoreWhitespaceInDiffView: false
+
   # If true, do not spawn a separate process when using GPG
   overrideGpg: false
 

pkg/commands/git_commands/commit.go

@@ -268,7 +268,7 @@ func (self *CommitCommands) ShowCmdObj(hash string, filterPath string) *oscomman
 		Arg("--decorate").
 		Arg("-p").
 		Arg(hash).
-		ArgIf(self.AppState.IgnoreWhitespaceInDiffView, "--ignore-all-space").
+		ArgIf(self.UserConfig().Git.IgnoreWhitespaceInDiffView, "--ignore-all-space").
 		Arg(fmt.Sprintf("--find-renames=%d%%", self.AppState.RenameSimilarityThreshold)).
 		ArgIf(filterPath != "", "--", filterPath).
 		Dir(self.repoPaths.worktreePath).

pkg/commands/git_commands/commit_test.go

@@ -320,8 +320,8 @@ func TestCommitShowCmdObj(t *testing.T) {
 		t.Run(s.testName, func(t *testing.T) {
 			userConfig := config.GetDefaultConfig()
 			userConfig.Git.Paging.ExternalDiffCommand = s.extDiffCmd
+			userConfig.Git.IgnoreWhitespaceInDiffView = s.ignoreWhitespace
 			appState := &config.AppState{}
-			appState.IgnoreWhitespaceInDiffView = s.ignoreWhitespace
 			appState.DiffContextSize = s.contextSize
 			appState.RenameSimilarityThreshold = s.similarityThreshold
 

pkg/commands/git_commands/diff.go

@@ -21,7 +21,7 @@ func NewDiffCommands(gitCommon *GitCommon) *DiffCommands {
 func (self *DiffCommands) DiffCmdObj(diffArgs []string) *oscommands.CmdObj {
 	extDiffCmd := self.UserConfig().Git.Paging.ExternalDiffCommand
 	useExtDiff := extDiffCmd != ""
-	ignoreWhitespace := self.AppState.IgnoreWhitespaceInDiffView
+	ignoreWhitespace := self.UserConfig().Git.IgnoreWhitespaceInDiffView
 
 	return self.cmd.New(
 		NewGitCmd("diff").

pkg/commands/git_commands/stash.go

@@ -88,7 +88,7 @@ func (self *StashCommands) ShowStashEntryCmdObj(index int) *oscommands.CmdObj {
 		Arg("-u").
 		Arg(fmt.Sprintf("--color=%s", self.UserConfig().Git.Paging.ColorArg)).
 		Arg(fmt.Sprintf("--unified=%d", self.AppState.DiffContextSize)).
-		ArgIf(self.AppState.IgnoreWhitespaceInDiffView, "--ignore-all-space").
+		ArgIf(self.UserConfig().Git.IgnoreWhitespaceInDiffView, "--ignore-all-space").
 		Arg(fmt.Sprintf("--find-renames=%d%%", self.AppState.RenameSimilarityThreshold)).
 		Arg(fmt.Sprintf("refs/stash@{%d}", index)).
 		Dir(self.repoPaths.worktreePath).

pkg/commands/git_commands/stash_test.go

@@ -144,8 +144,8 @@ func TestStashStashEntryCmdObj(t *testing.T) {
 	for _, s := range scenarios {
 		t.Run(s.testName, func(t *testing.T) {
 			userConfig := config.GetDefaultConfig()
+			userConfig.Git.IgnoreWhitespaceInDiffView = s.ignoreWhitespace
 			appState := &config.AppState{}
-			appState.IgnoreWhitespaceInDiffView = s.ignoreWhitespace
 			appState.DiffContextSize = s.contextSize
 			appState.RenameSimilarityThreshold = s.similarityThreshold
 			repoPaths := RepoPaths{

pkg/commands/git_commands/working_tree.go

@@ -272,7 +272,7 @@ func (self *WorkingTreeCommands) WorktreeFileDiffCmdObj(node models.IFile, plain
 		Arg("--submodule").
 		Arg(fmt.Sprintf("--unified=%d", contextSize)).
 		Arg(fmt.Sprintf("--color=%s", colorArg)).
-		ArgIf(!plain && self.AppState.IgnoreWhitespaceInDiffView, "--ignore-all-space").
+		ArgIf(!plain && self.UserConfig().Git.IgnoreWhitespaceInDiffView, "--ignore-all-space").
 		Arg(fmt.Sprintf("--find-renames=%d%%", self.AppState.RenameSimilarityThreshold)).
 		ArgIf(cached, "--cached").
 		ArgIf(noIndex, "--no-index").
@@ -314,7 +314,7 @@ func (self *WorkingTreeCommands) ShowFileDiffCmdObj(from string, to string, reve
 		Arg(from).
 		Arg(to).
 		ArgIf(reverse, "-R").
-		ArgIf(!plain && self.AppState.IgnoreWhitespaceInDiffView, "--ignore-all-space").
+		ArgIf(!plain && self.UserConfig().Git.IgnoreWhitespaceInDiffView, "--ignore-all-space").
 		Arg("--").
 		Arg(fileName).
 		Dir(self.repoPaths.worktreePath).

pkg/commands/git_commands/working_tree_test.go

@@ -327,8 +327,8 @@ func TestWorkingTreeDiff(t *testing.T) {
 	for _, s := range scenarios {
 		t.Run(s.testName, func(t *testing.T) {
 			userConfig := config.GetDefaultConfig()
+			userConfig.Git.IgnoreWhitespaceInDiffView = s.ignoreWhitespace
 			appState := &config.AppState{}
-			appState.IgnoreWhitespaceInDiffView = s.ignoreWhitespace
 			appState.DiffContextSize = s.contextSize
 			appState.RenameSimilarityThreshold = s.similarityThreshold
 			repoPaths := RepoPaths{
@@ -396,8 +396,8 @@ func TestWorkingTreeShowFileDiff(t *testing.T) {
 	for _, s := range scenarios {
 		t.Run(s.testName, func(t *testing.T) {
 			userConfig := config.GetDefaultConfig()
+			userConfig.Git.IgnoreWhitespaceInDiffView = s.ignoreWhitespace
 			appState := &config.AppState{}
-			appState.IgnoreWhitespaceInDiffView = s.ignoreWhitespace
 			appState.DiffContextSize = s.contextSize
 			repoPaths := RepoPaths{
 				worktreePath: "/path/to/worktree",

pkg/config/app_config.go

@@ -676,12 +676,11 @@ type AppState struct {
 	// For backwards compatibility we keep the old name in yaml files.
 	ShellCommandsHistory []string `yaml:"customcommandshistory"`
 
-	HideCommandLog             bool
-	IgnoreWhitespaceInDiffView bool
-	DiffContextSize            uint64
-	RenameSimilarityThreshold  int
-	LocalBranchSortOrder       string
-	RemoteBranchSortOrder      string
+	HideCommandLog            bool
+	DiffContextSize           uint64
+	RenameSimilarityThreshold int
+	LocalBranchSortOrder      string
+	RemoteBranchSortOrder     string
 
 	// One of: 'date-order' | 'author-date-order' | 'topo-order' | 'default'
 	// 'topo-order' makes it easier to read the git log graph, but commits may not

pkg/config/user_config.go

@@ -264,6 +264,8 @@ type GitConfig struct {
 	BranchLogCmd string `yaml:"branchLogCmd"`
 	// Commands used to display git log of all branches in the main window, they will be cycled in order of appearance (array of strings)
 	AllBranchesLogCmds []string `yaml:"allBranchesLogCmds"`
+	// If true, git diffs are rendered with the `--ignore-all-space` flag, which ignores whitespace changes. Can be toggled from within Lazygit with `<c-w>`.
+	IgnoreWhitespaceInDiffView bool `yaml:"ignoreWhitespaceInDiffView"`
 	// If true, do not spawn a separate process when using GPG
 	OverrideGpg bool `yaml:"overrideGpg"`
 	// If true, do not allow force pushes
@@ -808,6 +810,7 @@ func GetDefaultConfig() *UserConfig {
 			AutoStageResolvedConflicts:   true,
 			BranchLogCmd:                 "git log --graph --color=always --abbrev-commit --decorate --date=relative --pretty=medium {{branchName}} --",
 			AllBranchesLogCmds:           []string{"git log --graph --all --color=always --abbrev-commit --decorate --date=relative  --pretty=medium"},
+			IgnoreWhitespaceInDiffView:   false,
 			DisableForcePushing:          false,
 			CommitPrefixes:               map[string][]CommitPrefixConfig(nil),
 			BranchPrefix:                 "",

pkg/gui/controllers/helpers/diff_helper.go

@@ -144,7 +144,7 @@ func (self *DiffHelper) WithDiffModeCheck(f func()) {
 }
 
 func (self *DiffHelper) IgnoringWhitespaceSubTitle() string {
-	if self.c.GetAppState().IgnoreWhitespaceInDiffView {
+	if self.c.UserConfig().Git.IgnoreWhitespaceInDiffView {
 		return self.c.Tr.IgnoreWhitespaceDiffViewSubTitle
 	}
 

pkg/gui/controllers/toggle_whitespace_action.go

@@ -25,8 +25,7 @@ func (self *ToggleWhitespaceAction) Call() error {
 		return errors.New(self.c.Tr.IgnoreWhitespaceNotSupportedHere)
 	}
 
-	self.c.GetAppState().IgnoreWhitespaceInDiffView = !self.c.GetAppState().IgnoreWhitespaceInDiffView
-	self.c.SaveAppStateAndLogError()
+	self.c.UserConfig().Git.IgnoreWhitespaceInDiffView = !self.c.UserConfig().Git.IgnoreWhitespaceInDiffView
 
 	self.c.Context().CurrentSide().HandleFocus(types.OnFocusOpts{})
 	return nil

schema/config.json

@@ -359,6 +359,11 @@
             "git log --graph --all --color=always --abbrev-commit --decorate --date=relative  --pretty=medium"
           ]
         },
+        "ignoreWhitespaceInDiffView": {
+          "type": "boolean",
+          "description": "If true, git diffs are rendered with the `--ignore-all-space` flag, which ignores whitespace changes. Can be toggled from within Lazygit with `\u003cc-w\u003e`.",
+          "default": false
+        },
         "overrideGpg": {
           "type": "boolean",
           "description": "If true, do not spawn a separate process when using GPG",