Add 'ShowTags' configuration option

When working on projects that make heavy use of tags (ie. every commit
has multiple tags), it would be nice to be able to hide commit tags.

This commit adds this option.

Discussion with interest for the feature:
#3294

Author: Cway14

pkg/config/app_config.go

@@ -117,6 +117,9 @@ func NewAppConfig(
 	if appState.GitLogShowGraph == "" {
 		appState.GitLogShowGraph = userConfig.Git.Log.ShowGraph
 	}
+	if appState.GitLogShowTags == "" {
+		appState.GitLogShowTags = userConfig.Git.Log.ShowTags
+	}
 
 	appConfig := &AppConfig{
 		name:                  name,
@@ -691,6 +694,9 @@ type AppState struct {
 	// This determines whether the git graph is rendered in the commits panel
 	// One of 'always' | 'never' | 'when-maximised'
 	GitLogShowGraph string
+	// This determines whether the commit tags are rendered in the commits panel
+	// One of 'always' | 'never' | 'when-maximised'
+	GitLogShowTags string
 }
 
 func getDefaultAppState() *AppState {
@@ -705,6 +711,7 @@ func getDefaultAppState() *AppState {
 		RemoteBranchSortOrder:     "alphabetical",
 		GitLogOrder:               "", // should be "topo-order" eventually
 		GitLogShowGraph:           "", // should be "always" eventually
+		GitLogShowTags:            "", // should be "always" eventually
 	}
 }
 

pkg/config/app_config_test.go

@@ -698,6 +698,9 @@ git:
     # displays the whole git graph by default in the commits view (equivalent to passing the --all argument to git log)
     showWholeGraph: false
 
+    # Configure this with Log menu -> 'Show commit tags' (<c-l> in the commits window by default).
+    showTags: always
+
   # When copying commit hashes to the clipboard, truncate them to this
   # length. Set to 40 to disable truncation.
   truncateCopiedCommitHashesTo: 12

pkg/config/user_config.go

@@ -337,6 +337,8 @@ type LogConfig struct {
 	ShowGraph string `yaml:"showGraph" jsonschema:"deprecated,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"`
+	// Configure this with `Log menu -> Show tags` (<c-l> in the commits window by default).
+	ShowTags string `yaml:"showTags" jsonschema:"enum=always,enum=never,enum=when-maximised"`
 }
 
 type CommitPrefixConfig struct {
@@ -815,6 +817,7 @@ func GetDefaultConfig() *UserConfig {
 				Order:          "topo-order",
 				ShowGraph:      "always",
 				ShowWholeGraph: false,
+				ShowTags:       "always",
 			},
 			SkipHookPrefix:               "WIP",
 			MainBranches:                 []string{"master", "main"},

pkg/gui/context/local_commits_context.go

@@ -61,6 +61,7 @@ func NewLocalCommitsContext(c *ContextCommon) *LocalCommitsContext {
 			startIdx,
 			endIdx,
 			shouldShowGraph(c),
+			shouldShowTags(c),
 			c.Model().BisectInfo,
 		)
 	}
@@ -247,12 +248,18 @@ func (self *LocalCommitsViewModel) GetCommits() []*models.Commit {
 }
 
 func shouldShowGraph(c *ContextCommon) bool {
+	return shouldShowBasedOnAppState(c, c.GetAppState().GitLogShowGraph)
+}
+
+func shouldShowTags(c *ContextCommon) bool {
+	return shouldShowBasedOnAppState(c, c.GetAppState().GitLogShowTags)
+}
+
+func shouldShowBasedOnAppState(c *ContextCommon, value string) bool {
 	if c.Modes().Filtering.Active() {
 		return false
 	}
 
-	value := c.GetAppState().GitLogShowGraph
-
 	switch value {
 	case "always":
 		return true
@@ -262,7 +269,7 @@ func shouldShowGraph(c *ContextCommon) bool {
 		return c.State().GetRepoState().GetScreenMode() != types.SCREEN_NORMAL
 	}
 
-	log.Fatalf("Unknown value for git.log.showGraph: %s. Expected one of: 'always', 'never', 'when-maximised'", value)
+	log.Fatalf("Unknown value: %s. Expected one of: 'always', 'never', 'when-maximised'", value)
 	return false
 }
 

pkg/gui/context/sub_commits_context.go

@@ -76,6 +76,7 @@ func NewSubCommitsContext(
 			startIdx,
 			endIdx,
 			shouldShowGraph(c),
+			shouldShowTags(c),
 			git_commands.NewNullBisectInfo(),
 		)
 	}

pkg/gui/controllers/local_commits_controller.go

@@ -1192,6 +1192,42 @@ func (self *LocalCommitsController) handleOpenLogMenu() error {
 					})
 				},
 			},
+			{
+				Label:     self.c.Tr.ShowTags,
+				OpensMenu: true,
+				OnPress: func() error {
+					currentValue := self.c.GetAppState().GitLogShowTags
+					onPress := func(value string) func() error {
+						return func() error {
+							self.c.GetAppState().GitLogShowTags = value
+							self.c.SaveAppStateAndLogError()
+							self.c.PostRefreshUpdate(self.c.Contexts().LocalCommits)
+							self.c.PostRefreshUpdate(self.c.Contexts().SubCommits)
+							return nil
+						}
+					}
+					return self.c.Menu(types.CreateMenuOptions{
+						Title: self.c.Tr.LogMenuTitle,
+						Items: []*types.MenuItem{
+							{
+								Label:   "always",
+								OnPress: onPress("always"),
+								Widget:  types.MakeMenuRadioButton(currentValue == "always"),
+							},
+							{
+								Label:   "never",
+								OnPress: onPress("never"),
+								Widget:  types.MakeMenuRadioButton(currentValue == "never"),
+							},
+							{
+								Label:   "when maximised",
+								OnPress: onPress("when-maximised"),
+								Widget:  types.MakeMenuRadioButton(currentValue == "when-maximised"),
+							},
+						},
+					})
+				},
+			},
 			{
 				Label:     self.c.Tr.SortCommits,
 				OpensMenu: true,

pkg/gui/presentation/commits.go

@@ -2,6 +2,7 @@ package presentation
 
 import (
 	"fmt"
+	"regexp"
 	"strings"
 	"time"
 
@@ -55,6 +56,7 @@ func GetCommitListDisplayStrings(
 	startIdx int,
 	endIdx int,
 	showGraph bool,
+	showTags bool,
 	bisectInfo *git_commands.BisectInfo,
 ) [][]string {
 	mutex.Lock()
@@ -203,6 +205,7 @@ func GetCommitListDisplayStrings(
 			parseEmoji,
 			getGraphLine(unfilteredIdx),
 			fullDescription,
+			showTags,
 			bisectStatus,
 			bisectInfo,
 		))
@@ -355,6 +358,7 @@ func displayCommit(
 	parseEmoji bool,
 	graphLine string,
 	fullDescription bool,
+	showTags bool,
 	bisectStatus BisectStatus,
 	bisectInfo *git_commands.BisectInfo,
 ) []string {
@@ -391,12 +395,18 @@ func displayCommit(
 	}
 
 	tagString := ""
-	if fullDescription {
-		if commit.ExtraInfo != "" {
-			tagString = style.FgMagenta.SetBold().Sprint(commit.ExtraInfo) + " "
+	if fullDescription && commit.ExtraInfo != "" {
+		extraInfo := commit.ExtraInfo
+		if !showTags {
+			// Remove tags from the extra info
+			extraInfo = regexp.MustCompile(`tag: [^,)\s]+,?\s*`).ReplaceAllString(commit.ExtraInfo, "")
+			extraInfo = strings.Replace(extraInfo, "()", "", 1)
+		}
+		if extraInfo != "" {
+			tagString = style.FgMagenta.SetBold().Sprint(extraInfo) + " "
 		}
 	} else {
-		if len(commit.Tags) > 0 {
+		if showTags && len(commit.Tags) > 0 {
 			tagString = theme.DiffTerminalColor.SetBold().Sprint(strings.Join(commit.Tags, " ")) + " "
 		}
 

pkg/i18n/english.go

@@ -779,6 +779,7 @@ type TranslationSet struct {
 	LogMenuTitle                             string
 	ToggleShowGitGraphAll                    string
 	ShowGitGraph                             string
+	ShowTags                                 string
 	SortOrder                                string
 	SortAlphabetical                         string
 	SortByDate                               string
@@ -1868,6 +1869,7 @@ func EnglishTranslationSet() *TranslationSet {
 		LogMenuTitle:                             "Commit Log Options",
 		ToggleShowGitGraphAll:                    "Toggle show whole git graph (pass the `--all` flag to `git log`)",
 		ShowGitGraph:                             "Show git graph",
+		ShowTags:                                 "Show tags",
 		SortOrder:                                "Sort order",
 		SortAlphabetical:                         "Alphabetical",
 		SortByDate:                               "Date",

schema/config.json

@@ -1502,6 +1502,16 @@
           "type": "boolean",
           "description": "displays the whole git graph by default in the commits view (equivalent to passing the `--all` argument to `git log`)",
           "default": false
+        },
+        "showTags": {
+          "type": "string",
+          "enum": [
+            "always",
+            "never",
+            "when-maximised"
+          ],
+          "description": "Configure this with `Log menu -\u003e Show tags` (\u003cc-l\u003e in the commits window by default).",
+          "default": "always"
         }
       },
       "additionalProperties": false,