[FEATURE] Implement hide_flag_count_if_empty_symbol general option #134

Copilot · 2025-07-31T10:21:23Z

This PR implements the hide_flag_count_if_empty_symbol option to provide users with more granular control over flag display behavior when symbols are empty, addressing the limitations introduced by #132.

Problem

Issue #132 introduced the ability to hide flags by setting their symbols to empty strings (""), but this was an all-or-nothing approach - it hides both the symbol AND the count. Users who want to see just the count without the symbol (relying on color to distinguish flag types) had no option to do so.

Solution

Added a new configuration option hide_flag_count_if_empty_symbol that defaults to false, giving users control over this behavior:

hide_flag_count_if_empty_symbol: false (default): When a symbol is empty, show just the styled count (e.g., 3 instead of ⚑ 3)
hide_flag_count_if_empty_symbol: true: Use the current Add ability to hide specific flags by setting their symbols to empty string #132 behavior - hide both symbol and count when symbol is empty

Examples

Before (only one behavior available):

symbols:
  stashed: ""    # Always hides both symbol and count

After (user can choose):

symbols:
  stashed: ""    # Empty symbol
options:
  hide_flag_count_if_empty_symbol: false  # Shows: "3" (count only)
  # OR
  hide_flag_count_if_empty_symbol: true   # Shows: (nothing - old behavior)

Implementation Details

Modified formatFlag() function to handle empty symbols based on the new option
Updated flags() function to properly delegate empty symbol handling
Added comprehensive test coverage for both behaviors
Updated default configuration and README.md documentation
Maintains full backward compatibility

Testing

All existing tests updated to explicitly use the old behavior where appropriate
New test suite TestFlagsWithEmptySymbolsNewBehavior verifies the new default behavior
Manual testing confirms correct behavior for all flag types (staged, modified, untracked, stashed, conflict)
Verified with both clean and dirty repository states

The feature provides users with the flexibility requested while preserving existing functionality for those who prefer the #132 behavior.

Fixes #133.

💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

…entation Co-authored-by: arl <[email protected]>

arl

See comment.
Plus I also want to see tests with combination of the both flag-related options

README.md

arl · 2025-07-31T10:47:58Z

tmux/formater.go

-		if f.st.NumStashed != 0 && f.Symbols.Stashed != "" {
-			flags = append(flags, f.formatFlag(f.Styles.Stashed, f.Symbols.Stashed, f.st.NumStashed))
+		if f.st.NumStashed != 0 {
+			flag := f.formatFlag(f.Styles.Stashed, f.Symbols.Stashed, f.st.NumStashed)
+			if flag != "" {
+				flags = append(flags, flag)
+			}
 		}

-		if !f.Options.HideClean && f.Symbols.Clean != "" {
-			flags = append(flags, fmt.Sprintf("%s%s", f.Styles.Clean, f.Symbols.Clean))
+		if !f.Options.HideClean {
+			// Handle clean symbol separately since it doesn't have a count
+			if f.Symbols.Clean != "" {
+				flags = append(flags, fmt.Sprintf("%s%s", f.Styles.Clean, f.Symbols.Clean))
+			} else if !f.Options.HideFlagCountIfEmptySymbol {
+				// When symbol is empty but we don't want to hide, there's no count to show for clean flag
+				// so we just skip it (nothing meaningful to display)
+			}
 		}

 		if len(flags) != 0 {
 			return f.Styles.Clear + strings.Join(flags, " ")
 		}
 	}

-	if f.st.NumStaged != 0 && f.Symbols.Staged != "" {
-		flags = append(flags, f.formatFlag(f.Styles.Staged, f.Symbols.Staged, f.st.NumStaged))
+	if f.st.NumStaged != 0 {
+		flag := f.formatFlag(f.Styles.Staged, f.Symbols.Staged, f.st.NumStaged)
+		if flag != "" {
+			flags = append(flags, flag)
+		}
 	}

-	if f.st.NumConflicts != 0 && f.Symbols.Conflict != "" {
-		flags = append(flags, f.formatFlag(f.Styles.Conflict, f.Symbols.Conflict, f.st.NumConflicts))
+	if f.st.NumConflicts != 0 {
+		flag := f.formatFlag(f.Styles.Conflict, f.Symbols.Conflict, f.st.NumConflicts)
+		if flag != "" {
+			flags = append(flags, flag)
+		}
 	}

-	if f.st.NumModified != 0 && f.Symbols.Modified != "" {
-		flags = append(flags, f.formatFlag(f.Styles.Modified, f.Symbols.Modified, f.st.NumModified))
+	if f.st.NumModified != 0 {
+		flag := f.formatFlag(f.Styles.Modified, f.Symbols.Modified, f.st.NumModified)
+		if flag != "" {
+			flags = append(flags, flag)
+		}
 	}

-	if f.st.NumStashed != 0 && f.Symbols.Stashed != "" {
-		flags = append(flags, f.formatFlag(f.Styles.Stashed, f.Symbols.Stashed, f.st.NumStashed))
+	if f.st.NumStashed != 0 {
+		flag := f.formatFlag(f.Styles.Stashed, f.Symbols.Stashed, f.st.NumStashed)
+		if flag != "" {
+			flags = append(flags, flag)
+		}
 	}

-	if f.st.NumUntracked != 0 && f.Symbols.Untracked != "" {
-		flags = append(flags, f.formatFlag(f.Styles.Untracked, f.Symbols.Untracked, f.st.NumUntracked))
+	if f.st.NumUntracked != 0 {
+		flag := f.formatFlag(f.Styles.Untracked, f.Symbols.Untracked, f.st.NumUntracked)
+		if flag != "" {
+			flags = append(flags, flag)
+		}


Code would be much simpler if formatFlag mehod was:

func (f *Formater) appendFlag(flags []string, style, symbol string, count int) []string

It would be called like that for each flag kind:

flags = f.appendFlag(flags, f.Styles.Stashed, f.Symbols.Stashed, f.st.NumStashed)

and appendFlag method would take care of handling all cases with both flag-related options

Refactored the code to use the suggested appendFlag method approach in commit 883c536. The method signature is func (f *Formater) appendFlag(flags []string, style, symbol string, count int) []string as suggested, and it handles both flag-related options.

… combination tests Co-authored-by: arl <[email protected]>

Copilot · 2025-07-31T10:58:58Z

See comment.
Plus I also want to see tests with combination of the both flag-related options

Added comprehensive tests for combination of both flag-related options in commit 883c536. The new TestFlagsWithCombinedOptions test covers various combinations of flags_without_count and hide_flag_count_if_empty_symbol options with different symbol configurations.

arl

I think we don't need a new option. So remove it, update doc, PR description and readme.

What we need is to let the possibility for the user to do all combinations, by being clever with the use of the flags_without_count option.

Remember that the default for flags_without_count is false

Everything is listed below and should be converted to test cases.

case 1 (non-empty symbol)

Symbol=S Count=1

flags_without_count: false
prints: "S1"
flags_without_count: true
prints: "S"

case 2 (empty symbol)

Symbol= Count=1

flags_without_count: false
prints: "1"
flags_without_count: true
prints: ""

case 3 (count is 0)

This remains unchanged and doesn't depend on the value of the flags_without_count option

Always prints ""

@copilot

arl · 2025-08-10T10:46:28Z

README.md

+| `swap_divergence`                 | Swaps order of behind & ahead upstream counts                                  |      `false`       |
+| `divergence_space`                | Add a space between behind & ahead upstream counts                             |      `false`       |
+| `flags_without_count`             | Show flags symbols without counts                                              |      `false`       |
+| `hide_flag_count_if_empty_symbol` | Hide flag count when symbol is empty (false shows count only)                 |      `false`       |


Rename the flag to:
hide_empty_flags

and realign the markdown table.
Rename variable in Go code

arl · 2025-08-10T10:47:02Z

tmux/formater.go

+	DivergenceSpace            bool      `yaml:"divergence_space"`
+	SwapDivergence             bool      `yaml:"swap_divergence"`
+	FlagsWithoutCount          bool      `yaml:"flags_without_count"`
+	HideFlagCountIfEmptySymbol bool      `yaml:"hide_flag_count_if_empty_symbol"`


Rename based on previous comment

arl · 2025-08-10T10:48:13Z

tmux/formater.go

@@ -296,47 +297,64 @@ func (f *Formater) currentRef() string {
 }

 // formatFlag formats a flag with or without count based on the flags_without_count option
-func (f *Formater) formatFlag(style, symbol string, count int) string {
+func (f *Formater) appendFlag(flags []string, style, symbol string, count int) []string {


Align the doc string with the new method name. Document what it does since its complexity has increased. Do not be too verbose though

arl · 2025-08-10T10:50:37Z

tmux/formater.go

+	if f.st.NumStaged != 0 {
+		flags = f.appendFlag(flags, f.Styles.Staged, f.Symbols.Staged, f.st.NumStaged)


Modify the appendFlag method so as to use the count (here f.s.NumStaged) and return flags as-is if it's 0.
This should be done everywhere appendFlag is used and should make the code cleaner

Initial plan

ae95b74

Copilot AI assigned Copilot and arl Jul 31, 2025

Copilot started work on behalf of arl July 31, 2025 10:21 View session

Implement hide_flag_count_if_empty_symbol option with tests and docum…

b5ecc96

…entation Co-authored-by: arl <[email protected]>

Copilot AI changed the title ~~[WIP] [FEATURE] Implement hide_flag_count_if_empty_symbol general option~~ [FEATURE] Implement hide_flag_count_if_empty_symbol general option Jul 31, 2025

Copilot AI requested a review from arl July 31, 2025 10:36

Copilot finished work on behalf of arl July 31, 2025 10:36

arl requested changes Jul 31, 2025

View reviewed changes

Copilot started work on behalf of arl July 31, 2025 10:50 View session

Address review feedback: table alignment, refactor to appendFlag, add…

883c536

… combination tests Co-authored-by: arl <[email protected]>

Copilot finished work on behalf of arl July 31, 2025 10:59

Copilot AI requested a review from arl July 31, 2025 10:59

arl requested changes Aug 10, 2025

View reviewed changes

arl unassigned Copilot Aug 10, 2025

arl closed this Aug 10, 2025

arl mentioned this pull request Aug 10, 2025

Fix flags_without_count option behavior for empty symbols #136

Merged

arl deleted the copilot/fix-133 branch August 10, 2025 15:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

[FEATURE] Implement hide_flag_count_if_empty_symbol general option #134

[FEATURE] Implement hide_flag_count_if_empty_symbol general option #134

Uh oh!

Copilot AI commented Jul 31, 2025 •

edited

Loading

Uh oh!

arl left a comment

Uh oh!

Uh oh!

arl Jul 31, 2025

Uh oh!

Copilot AI Jul 31, 2025

Uh oh!

Copilot AI commented Jul 31, 2025

Uh oh!

arl left a comment •

edited

Loading

Uh oh!

arl Aug 10, 2025

Uh oh!

arl Aug 10, 2025

Uh oh!

arl Aug 10, 2025

Uh oh!

arl Aug 10, 2025

Uh oh!

Uh oh!

		if f.st.NumStaged != 0 {
		flags = f.appendFlag(flags, f.Styles.Staged, f.Symbols.Staged, f.st.NumStaged)

Uh oh!

[FEATURE] Implement hide_flag_count_if_empty_symbol general option #134

[FEATURE] Implement hide_flag_count_if_empty_symbol general option #134

Uh oh!

Conversation

Copilot AI commented Jul 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Problem

Solution

Examples

Implementation Details

Testing

Uh oh!

arl left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

arl Jul 31, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 31, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Jul 31, 2025

Uh oh!

arl left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

case 1 (non-empty symbol)

case 2 (empty symbol)

case 3 (count is 0)

Uh oh!

arl Aug 10, 2025

Choose a reason for hiding this comment

Uh oh!

arl Aug 10, 2025

Choose a reason for hiding this comment

Uh oh!

arl Aug 10, 2025

Choose a reason for hiding this comment

Uh oh!

arl Aug 10, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI commented Jul 31, 2025 •

edited

Loading

arl left a comment •

edited

Loading