go/lazygit
1
0
Fork 0
mirror of https://github.com/jesseduffield/lazygit.git synced 2025-07-17 01:42:45 +02:00
Code Issues Releases Activity

Un-deprecate UserConfig.Git.Log.Order and ShowGraph

Browse Source 
And remove them from AppState.
This commit is contained in:
Stefan Haller
2025-07-07 17:14:55 +02:00
parent 703256e92d
commit 562a2aaa6b
28 changed files with 46 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/Config.md
View File

@ -396,6 +396,19 @@ git:
# Config for showing the log in the commits view
log:
# 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
# appear chronologically. See https://git-scm.com/docs/
#
# Can be changed from within Lazygit with `Log menu -> Commit sort order` (`<c-l>` in the commits window by default).
order: topo-order
# This determines whether the git graph is rendered in the commits panel
# One of 'always' | 'never' | 'when-maximised'
#
# Can be toggled from within lazygit with `Log menu -> Show git graph` (`<c-l>` in the commits window by default).
showGraph: always
# displays the whole git graph by default in the commits view (equivalent to passing the `--all` argument to `git log`)
showWholeGraph: false

2
pkg/commands/git_commands/commit_loader.go
View File

@ -583,7 +583,7 @@ func (self *CommitLoader) getFirstPushedCommit(refName string) (string, error) {
// getLog gets the git log.
func (self *CommitLoader) getLogCmd(opts GetCommitsOptions) *oscommands.CmdObj {
gitLogOrder := self.AppState.GitLogOrder
gitLogOrder := self.UserConfig().Git.Log.Order
refSpec := opts.RefName
if opts.RefToShowDivergenceFrom != "" {

4
pkg/commands/git_commands/commit_loader_test.go
View File

@ -9,7 +9,6 @@ import (
"github.com/jesseduffield/lazygit/pkg/commands/models"
"github.com/jesseduffield/lazygit/pkg/commands/oscommands"
"github.com/jesseduffield/lazygit/pkg/common"
"github.com/jesseduffield/lazygit/pkg/config"
"github.com/jesseduffield/lazygit/pkg/utils"
"github.com/samber/lo"
"github.com/stefanhaller/git-todo-parser/todo"
@ -298,8 +297,7 @@ func TestGetCommits(t *testing.T) {
for _, scenario := range scenarios {
t.Run(scenario.testName, func(t *testing.T) {
common := common.NewDummyCommon()
common.AppState = &config.AppState{}
common.AppState.GitLogOrder = scenario.logOrder
common.UserConfig().Git.Log.Order = scenario.logOrder
cmd := oscommands.NewDummyCmdObjBuilder(scenario.runner)
builder := &CommitLoader{

22
pkg/config/app_config.go
View File

@ -107,17 +107,6 @@ func NewAppConfig(
return nil, err
}
// Temporary: the defaults for these are set to empty strings in
// getDefaultAppState so that we can migrate them from userConfig (which is
// now deprecated). Once we remove the user configs, we can remove this code
// and set the proper defaults in getDefaultAppState.
if appState.GitLogOrder == "" {
appState.GitLogOrder = userConfig.Git.Log.Order
}
if appState.GitLogShowGraph == "" {
appState.GitLogShowGraph = userConfig.Git.Log.ShowGraph
}
appConfig := &AppConfig{
name: name,
version: version,
@ -677,15 +666,6 @@ type AppState struct {
ShellCommandsHistory []string `yaml:"customcommandshistory"`
HideCommandLog bool
// 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
// appear chronologically. See https://git-scm.com/docs/
GitLogOrder string
// This determines whether the git graph is rendered in the commits panel
// One of 'always' | 'never' | 'when-maximised'
GitLogShowGraph string
}
func getDefaultAppState() *AppState {
@ -694,8 +674,6 @@ func getDefaultAppState() *AppState {
RecentRepos: []string{},
StartupPopupVersion: 0,
LastVersion: "",
GitLogOrder: "", // should be "topo-order" eventually
GitLogShowGraph: "", // should be "always" eventually
}
}

8
pkg/config/user_config.go
View File

@ -346,13 +346,13 @@ type LogConfig struct {
// 'topo-order' makes it easier to read the git log graph, but commits may not
// appear chronologically. See https://git-scm.com/docs/
//
// Deprecated: Configure this with `Log menu -> Commit sort order` (<c-l> in the commits window by default).
Order string `yaml:"order" jsonschema:"deprecated,enum=date-order,enum=author-date-order,enum=topo-order,enum=default,deprecated"`
// Can be changed from within Lazygit with `Log menu -> Commit sort order` (`<c-l>` in the commits window by default).
Order string `yaml:"order" jsonschema:"enum=date-order,enum=author-date-order,enum=topo-order,enum=default"`
// This determines whether the git graph is rendered in the commits panel
// One of 'always' | 'never' | 'when-maximised'
//
// Deprecated: Configure this with `Log menu -> Show git graph` (<c-l> in the commits window by default).
ShowGraph string `yaml:"showGraph" jsonschema:"deprecated,enum=always,enum=never,enum=when-maximised"`
// Can be toggled from within lazygit with `Log menu -> Show git graph` (`<c-l>` in the commits window by default).
ShowGraph string `yaml:"showGraph" jsonschema:"enum=always,enum=never,enum=when-maximised"`
// displays the whole git graph by default in the commits view (equivalent to passing the `--all` argument to `git log`)
ShowWholeGraph bool `yaml:"showWholeGraph"`
}

2
pkg/gui/context/local_commits_context.go
View File

@ -251,7 +251,7 @@ func shouldShowGraph(c *ContextCommon) bool {
return false
}
value := c.GetAppState().GitLogShowGraph
value := c.UserConfig().Git.Log.ShowGraph
switch value {
case "always":

10
pkg/gui/controllers/local_commits_controller.go
View File

@ -1182,11 +1182,10 @@ func (self *LocalCommitsController) handleOpenLogMenu() error {
Label: self.c.Tr.ShowGitGraph,
OpensMenu: true,
OnPress: func() error {
currentValue := self.c.GetAppState().GitLogShowGraph
currentValue := self.c.UserConfig().Git.Log.ShowGraph
onPress := func(value string) func() error {
return func() error {
self.c.GetAppState().GitLogShowGraph = value
self.c.SaveAppStateAndLogError()
self.c.UserConfig().Git.Log.ShowGraph = value
self.c.PostRefreshUpdate(self.c.Contexts().LocalCommits)
self.c.PostRefreshUpdate(self.c.Contexts().SubCommits)
return nil
@ -1218,11 +1217,10 @@ func (self *LocalCommitsController) handleOpenLogMenu() error {
Label: self.c.Tr.SortCommits,
OpensMenu: true,
OnPress: func() error {
currentValue := self.c.GetAppState().GitLogOrder
currentValue := self.c.UserConfig().Git.Log.Order
onPress := func(value string) func() error {
return func() error {
self.c.GetAppState().GitLogOrder = value
self.c.SaveAppStateAndLogError()
self.c.UserConfig().Git.Log.Order = value
return self.c.WithWaitingStatus(self.c.Tr.LoadingCommits, func(gocui.Task) error {
self.c.Refresh(
types.RefreshOptions{

2
pkg/integration/tests/bisect/basic.go
View File

@ -15,7 +15,7 @@ var Basic = NewIntegrationTest(NewIntegrationTestArgs{
CreateNCommits(10)
},
SetupConfig: func(cfg *config.AppConfig) {
cfg.GetAppState().GitLogShowGraph = "never"
cfg.GetUserConfig().Git.Log.ShowGraph = "never"
},
Run: func(t *TestDriver, keys config.KeybindingConfig) {
markCommitAsBad := func() {

2
pkg/integration/tests/bisect/choose_terms.go
View File

@ -15,7 +15,7 @@ var ChooseTerms = NewIntegrationTest(NewIntegrationTestArgs{
CreateNCommits(10)
},
SetupConfig: func(cfg *config.AppConfig) {
cfg.GetAppState().GitLogShowGraph = "never"
cfg.GetUserConfig().Git.Log.ShowGraph = "never"
},
Run: func(t *TestDriver, keys config.KeybindingConfig) {
markCommitAsFixed := func() {

2
pkg/integration/tests/bisect/skip.go
View File

@ -14,7 +14,7 @@ var Skip = NewIntegrationTest(NewIntegrationTestArgs{
CreateNCommits(10)
},
SetupConfig: func(cfg *config.AppConfig) {
cfg.GetAppState().GitLogShowGraph = "never"
cfg.GetUserConfig().Git.Log.ShowGraph = "never"
},
Run: func(t *TestDriver, keys config.KeybindingConfig) {
t.Views().Commits().

2
pkg/integration/tests/branch/rebase_copied_branch.go
View File

@ -11,7 +11,7 @@ var RebaseCopiedBranch = NewIntegrationTest(NewIntegrationTestArgs{
Skip: false,
GitVersion: AtLeast("2.38.0"),
SetupConfig: func(config *config.AppConfig) {
config.GetAppState().GitLogShowGraph = "never"
config.GetUserConfig().Git.Log.ShowGraph = "never"
},
SetupRepo: func(shell *Shell) {
shell.

2
pkg/integration/tests/cherry_pick/cherry_pick_during_rebase.go
View File

@ -10,7 +10,7 @@ var CherryPickDuringRebase = NewIntegrationTest(NewIntegrationTestArgs{
ExtraCmdArgs: []string{},
Skip: false,
SetupConfig: func(config *config.AppConfig) {
config.GetAppState().GitLogShowGraph = "never"
config.GetUserConfig().Git.Log.ShowGraph = "never"
config.GetUserConfig().Git.LocalBranchSortOrder = "recency"
},
SetupRepo: func(shell *Shell) {

2
pkg/integration/tests/commit/do_not_show_branch_marker_for_head_commit.go
View File

@ -11,7 +11,7 @@ var DoNotShowBranchMarkerForHeadCommit = NewIntegrationTest(NewIntegrationTestAr
Skip: false,
GitVersion: AtLeast("2.38.0"),
SetupConfig: func(config *config.AppConfig) {
config.GetAppState().GitLogShowGraph = "never"
config.GetUserConfig().Git.Log.ShowGraph = "never"
},
SetupRepo: func(shell *Shell) {
shell.EmptyCommit("one")

2
pkg/integration/tests/commit/highlight.go
View File

@ -10,7 +10,7 @@ var Highlight = NewIntegrationTest(NewIntegrationTestArgs{
ExtraCmdArgs: []string{},
Skip: false,
SetupConfig: func(config *config.AppConfig) {
config.GetAppState().GitLogShowGraph = "always"
config.GetUserConfig().Git.Log.ShowGraph = "always"
config.GetUserConfig().Gui.AuthorColors = map[string]string{
"CI": "red",
}

2
pkg/integration/tests/filter_by_author/select_author.go
View File

@ -10,7 +10,7 @@ var SelectAuthor = NewIntegrationTest(NewIntegrationTestArgs{
ExtraCmdArgs: []string{},
Skip: false,
SetupConfig: func(config *config.AppConfig) {
config.GetAppState().GitLogShowGraph = "never"
config.GetUserConfig().Git.Log.ShowGraph = "never"
},
SetupRepo: func(shell *Shell) {
commonSetup(shell)

2
pkg/integration/tests/interactive_rebase/dont_show_branch_heads_for_todo_items.go
View File

@ -11,7 +11,7 @@ var DontShowBranchHeadsForTodoItems = NewIntegrationTest(NewIntegrationTestArgs{
Skip: false,
GitVersion: AtLeast("2.38.0"),
SetupConfig: func(config *config.AppConfig) {
config.GetAppState().GitLogShowGraph = "never"
config.GetUserConfig().Git.Log.ShowGraph = "never"
},
SetupRepo: func(shell *Shell) {
shell.

2
pkg/integration/tests/interactive_rebase/drop_commit_in_copied_branch_with_update_ref.go
View File

@ -11,7 +11,7 @@ var DropCommitInCopiedBranchWithUpdateRef = NewIntegrationTest(NewIntegrationTes
Skip: false,
GitVersion: AtLeast("2.38.0"),
SetupConfig: func(config *config.AppConfig) {
config.GetAppState().GitLogShowGraph = "never"
config.GetUserConfig().Git.Log.ShowGraph = "never"
},
SetupRepo: func(shell *Shell) {
shell.

2
pkg/integration/tests/interactive_rebase/drop_todo_commit_with_update_ref.go
View File

@ -12,7 +12,7 @@ var DropTodoCommitWithUpdateRef = NewIntegrationTest(NewIntegrationTestArgs{
GitVersion: AtLeast("2.38.0"),
SetupConfig: func(config *config.AppConfig) {
config.GetUserConfig().Git.MainBranches = []string{"master"}
config.GetAppState().GitLogShowGraph = "never"
config.GetUserConfig().Git.Log.ShowGraph = "never"
},
SetupRepo: func(shell *Shell) {
shell.

2
pkg/integration/tests/interactive_rebase/edit_last_commit_of_stacked_branch.go
View File

@ -12,7 +12,7 @@ var EditLastCommitOfStackedBranch = NewIntegrationTest(NewIntegrationTestArgs{
GitVersion: AtLeast("2.38.0"),
SetupConfig: func(config *config.AppConfig) {
config.GetUserConfig().Git.MainBranches = []string{"master"}
config.GetAppState().GitLogShowGraph = "never"
config.GetUserConfig().Git.Log.ShowGraph = "never"
},
SetupRepo: func(shell *Shell) {
shell.

2
pkg/integration/tests/interactive_rebase/interactive_rebase_of_copied_branch.go
View File

@ -11,7 +11,7 @@ var InteractiveRebaseOfCopiedBranch = NewIntegrationTest(NewIntegrationTestArgs{
Skip: false,
GitVersion: AtLeast("2.38.0"),
SetupConfig: func(config *config.AppConfig) {
config.GetAppState().GitLogShowGraph = "never"
config.GetUserConfig().Git.Log.ShowGraph = "never"
},
SetupRepo: func(shell *Shell) {
shell.

2
pkg/integration/tests/interactive_rebase/move_across_branch_boundary_outside_rebase.go
View File

@ -12,7 +12,7 @@ var MoveAcrossBranchBoundaryOutsideRebase = NewIntegrationTest(NewIntegrationTes
GitVersion: AtLeast("2.38.0"),
SetupConfig: func(config *config.AppConfig) {
config.GetUserConfig().Git.MainBranches = []string{"master"}
config.GetAppState().GitLogShowGraph = "never"
config.GetUserConfig().Git.Log.ShowGraph = "never"
},
SetupRepo: func(shell *Shell) {
shell.

2
pkg/integration/tests/interactive_rebase/quick_start_keep_selection.go
View File

@ -12,7 +12,7 @@ var QuickStartKeepSelection = NewIntegrationTest(NewIntegrationTestArgs{
GitVersion: AtLeast("2.38.0"),
SetupConfig: func(config *config.AppConfig) {
config.GetUserConfig().Git.MainBranches = []string{"master"}
config.GetAppState().GitLogShowGraph = "never"
config.GetUserConfig().Git.Log.ShowGraph = "never"
},
SetupRepo: func(shell *Shell) {
shell.

2
pkg/integration/tests/interactive_rebase/quick_start_keep_selection_range.go
View File

@ -12,7 +12,7 @@ var QuickStartKeepSelectionRange = NewIntegrationTest(NewIntegrationTestArgs{
GitVersion: AtLeast("2.38.0"),
SetupConfig: func(config *config.AppConfig) {
config.GetUserConfig().Git.MainBranches = []string{"master"}
config.GetAppState().GitLogShowGraph = "never"
config.GetUserConfig().Git.Log.ShowGraph = "never"
},
SetupRepo: func(shell *Shell) {
shell.

2
pkg/integration/tests/interactive_rebase/reword_last_commit_of_stacked_branch.go
View File

@ -12,7 +12,7 @@ var RewordLastCommitOfStackedBranch = NewIntegrationTest(NewIntegrationTestArgs{
GitVersion: AtLeast("2.38.0"),
SetupConfig: func(config *config.AppConfig) {
config.GetUserConfig().Git.MainBranches = []string{"master"}
config.GetAppState().GitLogShowGraph = "never"
config.GetUserConfig().Git.Log.ShowGraph = "never"
},
SetupRepo: func(shell *Shell) {
shell.

2
pkg/integration/tests/interactive_rebase/view_files_of_todo_entries.go
View File

@ -11,7 +11,7 @@ var ViewFilesOfTodoEntries = NewIntegrationTest(NewIntegrationTestArgs{
Skip: false,
GitVersion: AtLeast("2.38.0"),
SetupConfig: func(config *config.AppConfig) {
config.GetAppState().GitLogShowGraph = "never"
config.GetUserConfig().Git.Log.ShowGraph = "never"
},
SetupRepo: func(shell *Shell) {
shell.

2
pkg/integration/tests/patch_building/move_to_new_commit_in_last_commit_of_stacked_branch.go
View File

@ -11,7 +11,7 @@ var MoveToNewCommitInLastCommitOfStackedBranch = NewIntegrationTest(NewIntegrati
Skip: false,
GitVersion: AtLeast("2.38.0"),
SetupConfig: func(config *config.AppConfig) {
config.GetAppState().GitLogShowGraph = "never"
config.GetUserConfig().Git.Log.ShowGraph = "never"
},
SetupRepo: func(shell *Shell) {
shell.

2
pkg/integration/tests/reflog/do_not_show_branch_markers_in_reflog_subcommits.go
View File

@ -10,7 +10,7 @@ var DoNotShowBranchMarkersInReflogSubcommits = NewIntegrationTest(NewIntegration
ExtraCmdArgs: []string{},
Skip: false,
SetupConfig: func(config *config.AppConfig) {
config.GetAppState().GitLogShowGraph = "never"
config.GetUserConfig().Git.Log.ShowGraph = "never"
},
SetupRepo: func(shell *Shell) {
shell.NewBranch("branch1")

4
schema/config.json
View File

@ -1532,7 +1532,7 @@
"topo-order",
"default"
],
"description": "One of: 'date-order' | 'author-date-order' | 'topo-order' | 'default'\n'topo-order' makes it easier to read the git log graph, but commits may not\nappear chronologically. See https://git-scm.com/docs/\n\nDeprecated: Configure this with `Log menu -\u003e Commit sort order` (\u003cc-l\u003e in the commits window by default).",
"description": "One of: 'date-order' | 'author-date-order' | 'topo-order' | 'default'\n'topo-order' makes it easier to read the git log graph, but commits may not\nappear chronologically. See https://git-scm.com/docs/\n\nCan be changed from within Lazygit with `Log menu -\u003e Commit sort order` (`\u003cc-l\u003e` in the commits window by default).",
"default": "topo-order"
},
"showGraph": {
@ -1542,7 +1542,7 @@
"never",
"when-maximised"
],
"description": "This determines whether the git graph is rendered in the commits panel\nOne of 'always' | 'never' | 'when-maximised'\n\nDeprecated: Configure this with `Log menu -\u003e Show git graph` (\u003cc-l\u003e in the commits window by default).",
"description": "This determines whether the git graph is rendered in the commits panel\nOne of 'always' | 'never' | 'when-maximised'\n\nCan be toggled from within lazygit with `Log menu -\u003e Show git graph` (`\u003cc-l\u003e` in the commits window by default).",
"default": "always"
},
"showWholeGraph": {