Format no format #4657

9swampy · 2025-08-13T23:02:50Z

Fix legacy .NET composite format syntax

Description

Fixes legacy .NET format syntax {CommitsSinceVersionSource:0000;;''} that was outputting literal text instead of formatted values.

Added LegacyCompositeFormatter for semicolon-separated format sections
Updated ValueFormatter and RegexPatterns to support semicolons
Maintains compatibility with existing ?? syntax

Before: 6.13.54-gv6-CommitsSinceVersionSource-0000-----
After: 6.13.54-gv60002

Related Issue

Fixes #4654

Motivation and Context

Legacy .NET semicolon format syntax stopped working, breaking existing GitVersion configurations.

How Has This Been Tested?

Added comprehensive test suites:

BackwardCompatibilityTests.cs - 8 tests covering legacy format scenarios
Issue4654Tests.cs - 4 tests for the specific issue

All 12 new tests pass. No regression in existing tests.

Screenshots (if appropriate):

N/A

Checklist:

My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have added tests to cover my changes.
All new and existing tests passed.

9swampy · 2025-08-13T23:06:36Z

@phatcher #4654

9swampy · 2025-08-13T23:46:04Z

src/GitVersion.Core/Core/RegexPatterns.cs

                    (?<member>[A-Za-z_][A-Za-z0-9_]*)                   # member/property name
                    (?:                                                 # Optional format specifier
-                        :(?<format>[A-Za-z0-9\.\-,]+)                   # Colon followed by format string (no spaces, ?, or }), format cannot contain colon
+                        :(?<format>[A-Za-z0-9\.\-,;'"]+)                # Colon followed by format string (including semicolons and quotes)


sonarqubecloud · 2025-08-14T02:48:01Z

Quality Gate passed

Issues
3 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

9swampy · 2025-08-14T03:04:40Z

Apologies. Two passes is already more time than I had. The first pass was comfortable, the second's expanded in to assumptions that likely warrant a review & retrospect on regression pack coverage? Rollback & regroup the wise call?

asbjornu

Fantastic work! 🎉 Thank you so much for jumping on this so quickly, @9swampy! ❤️

asbjornu · 2025-08-14T12:00:31Z

docs/input/docs/reference/custom-formatting.md

+# Three-section format: positive;negative;zero
+assembly-informational-format: "{Value:positive;negative;zero}"
+
+# Two-section format: positive;negative
+assembly-informational-format: "{Value:pos;neg}"


Could these last two examples be modified to be more practical and real-world relevant, with a line showing the result, as in the first code example?

asbjornu · 2025-08-14T12:01:26Z

docs/input/docs/reference/custom-formatting.md

+- **Third section**: Used for zero values (optional)
+- **Empty quotes** (`''` or `""`) create empty output
+
+**Mixed Syntax:** You can combine legacy semicolon syntax with modern `??` fallback syntax in the same template.


How would ;; and ?? be combined? Can we give a code example for this as well?

asbjornu · 2025-08-14T12:01:59Z

src/GitVersion.Core.Tests/Formatting/BackwardCompatibilityTests.cs

I love the added tests! 🤩 Could we please have a test for the combination of ;; and ?? as well?

asbjornu · 2025-08-14T12:02:22Z

src/GitVersion.Core.Tests/Formatting/DateFormatterTests.cs

 using GitVersion.Formatting;

-namespace GitVersion.Tests.Formatting;
+namespace GitVersion.Core.Tests.Formatting;


GitVersion.Core should not be a namespace. :)

Suggested change

namespace GitVersion.Core.Tests.Formatting;

namespace GitVersion.Tests.Formatting;

asbjornu · 2025-08-14T12:04:24Z

src/GitVersion.Core.Tests/Formatting/LegacyFormatterProblemTests.cs

+
+        // Currently this will throw or behave unexpectedly
+        // Should either throw meaningful error or handle gracefully
+        Assert.Throws<ArgumentException>(() => template.FormatWith(semanticVersion, environment));


I think it's a good practice to test the returned ArgumentException to ensure that the right guard clause is throwing it. This just ensures that an ArgumentException is being thrown anywhere by the code path, not necessarily by our own code.

asbjornu · 2025-08-14T12:06:03Z

src/GitVersion.Core.Tests/Formatting/StringFormatterTests.cs

 using GitVersion.Formatting;

-namespace GitVersion.Tests.Formatting;
+namespace GitVersion.Core.Tests.Formatting;


Suggested change

namespace GitVersion.Core.Tests.Formatting;

namespace GitVersion.Tests.Formatting;

asbjornu · 2025-08-14T12:06:09Z

src/GitVersion.Core.Tests/Formatting/ValueFormatterTests.cs

 using GitVersion.Formatting;

-namespace GitVersion.Tests.Formatting;
+namespace GitVersion.Core.Tests.Formatting;


Suggested change

namespace GitVersion.Core.Tests.Formatting;

namespace GitVersion.Tests.Formatting;

asbjornu · 2025-08-14T12:07:00Z

src/GitVersion.Core/Core/RegexPatterns.cs

                    (?<member>[A-Za-z_][A-Za-z0-9_]*)                   # member/property name
                    (?:                                                 # Optional format specifier
-                        :(?<format>[A-Za-z0-9\.\-,]+)                   # Colon followed by format string (no spaces, ?, or }), format cannot contain colon
+                        :(?<format>[A-Za-z0-9\.\-,;'"]+)                # Colon followed by format string (including semicolons and quotes)


phatcher · 2025-09-17T10:16:27Z

@9swampy You mention "modern ?? fallback syntax" - what do you mean by that, AFAIK ?? is just the null coalescing operation and nothing to do with string formatting?

9swampy · 2025-09-17T13:39:05Z

Honestly I'm embarrassed I've not got back to fixing this. It's been maniac at my day job and I've maxed the AI tooling out repeatedly so haven't had capacity to revisit.

The reason to call that out now is to answer the question; don't get hung up on the modern quip. AIism.

I will get a poke at the fix as soon as I can.

phatcher · 2025-09-18T11:41:15Z

@9swampy No worries - reason I was asking was to see if I could do the same idea of suppressing the commit number when it's zero via a different syntax

arturcic · 2025-10-25T14:57:43Z

@9swampy any updates on this one?

9swampy · 2025-11-01T13:22:14Z

Sorry, not yet. I will.

This commit fixes the bug where legacy .NET composite format syntax like {CommitsSinceVersionSource:0000;;''} was not working correctly. The issue was that the formatter would output literal text instead of properly formatted values. For example, it would output: "6.13.54-gv6-CommitsSinceVersionSource-0000-----" instead of: "6.13.54-gv60002" Changes: 1. Updated RegexPatterns.cs to allow semicolons and quotes in format strings by changing the format pattern from [A-Za-z0-9\.\-,]+ to [A-Za-z0-9\.\-,;'"]+ 2. Added LegacyCompositeFormatter.cs to properly handle the three-section composite format syntax (positive;negative;zero) with support for: - Zero-suppression using empty string ('') - Proper handling of negative values (no double negative) - Numeric formatting in all sections 3. Updated ValueFormatter.cs to register LegacyCompositeFormatter with priority 1 and allow null values to be processed by formatters 4. Updated StringFormatWithExtension.cs to not return early for null values when legacy syntax is detected 5. Added Issue4654Tests.cs to verify the fix works correctly The fix ensures backward compatibility with legacy .NET composite format syntax while maintaining support for modern format strings.

Adds all test files from the FormatNoFormat branch to ensure complete coverage of the LegacyCompositeFormatter functionality: - BackwardCompatibilityTests.cs (2 tests): Tests regex pattern parsing for legacy semicolon syntax and mixed new/old syntax - LegacyFormatterProblemTests.cs (9 tests): Comprehensive edge case tests covering: * Null value handling * Missing property error handling * Double negative prevention * Positive/negative/zero section selection * Numeric formatting in all sections * Invalid format handling * Issue GitTools#4654 verification tests - LegacyFormattingSyntaxTests.cs (7 tests): Tests for legacy format syntax parsing and behavior Also fixes namespace from GitVersion.Tests.Formatting to GitVersion.Core.Tests.Formatting in: - ValueFormatterTests.cs - StringFormatterTests.cs - DateFormatterTests.cs Total: 21 tests covering legacy composite format functionality

sonarqubecloud · 2025-11-05T01:03:11Z

Quality Gate passed

Issues
3 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

9swampy force-pushed the FormatNoFormat branch from 7048ae1 to 5e1c165 Compare August 13, 2025 23:05

9swampy force-pushed the FormatNoFormat branch 4 times, most recently from 8a331e5 to 3629aef Compare August 13, 2025 23:25

9swampy commented Aug 13, 2025

View reviewed changes

arturcic requested review from arturcic and asbjornu and removed request for arturcic August 14, 2025 04:43

asbjornu requested changes Aug 14, 2025

View reviewed changes

asbjornu mentioned this pull request Aug 15, 2025

[ISSUE] Incorrect output for assembly-informational-version #4654

Open

2 tasks

arturcic force-pushed the main branch from 2ccd7b4 to 164f981 Compare November 2, 2025 20:25

9swampy force-pushed the FormatNoFormat branch from 0708d23 to f6570b5 Compare November 4, 2025 20:57

9swampy marked this pull request as draft November 4, 2025 21:08

9swampy force-pushed the FormatNoFormat branch from f6570b5 to ac9485d Compare November 4, 2025 21:47

9swampy force-pushed the FormatNoFormat branch from 6560a97 to b638fe2 Compare November 5, 2025 01:00

	namespace GitVersion.Core.Tests.Formatting;
	namespace GitVersion.Tests.Formatting;

Format no format #4657

Are you sure you want to change the base?

Format no format #4657

Conversation

9swampy commented Aug 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Fix legacy .NET composite format syntax

Description

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Checklist:

Uh oh!

9swampy commented Aug 13, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud bot commented Aug 14, 2025

Quality Gate passed

Uh oh!

9swampy commented Aug 14, 2025

Uh oh!

asbjornu left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

phatcher commented Sep 17, 2025

Uh oh!

9swampy commented Sep 17, 2025

Uh oh!

phatcher commented Sep 18, 2025

Uh oh!

arturcic commented Oct 25, 2025

Uh oh!

9swampy commented Nov 1, 2025

Uh oh!

sonarqubecloud bot commented Nov 5, 2025

Quality Gate passed

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

9swampy commented Aug 13, 2025 •

edited

Loading