Support C# format strings in config #4605

9swampy · 2025-06-28T16:25:27Z

Description

Support C# format strings in config

Related Issue

Motivation and Context

How Has This Been Tested?

I've implemented a number of formatters and added scenario coverage for implementation but a 4-eyes verification and feedback on appropriateness of scenarios included (or not) would be welcome. The specific scenrio noted on the wish-issue tested here and here.

I've an aversion to Helper classes but that's where I've dropped all this as an extension of the original StringFormatWith but please redirect if it should live elsewhere (or just needs some structure).

Screenshots (if appropriate):

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.

arturcic · 2025-06-29T10:19:03Z

please rebase and resolve the conflicts

asbjornu

Awesome work! ❤️

src/GitVersion.Core/Helpers/DateFormatter.cs

src/GitVersion.Core/Helpers/FormattableFormatter.cs

src/GitVersion.Core/Helpers/DateFormatter.cs

src/GitVersion.Core/Helpers/NumericFormatter.cs

src/GitVersion.Core/Helpers/ValueFormatter.cs

src/GitVersion.Core/Helpers/StringFormatWith.cs

src/GitVersion.Core/Helpers/ExpressionCompiler.cs

src/GitVersion.Core/Helpers/FormattableFormatter.cs

src/GitVersion.Core/Helpers/DateFormatter.cs

asbjornu

Besides the build failure, this is looking really good! The only missing part is documentation.

src/GitVersion.Core/Formatting/StringFormatter.cs

arturcic · 2025-07-20T13:12:36Z

@9swampy if you don't mind I'll have a review of this in 2 weeks time as I'm on vacation. I need to understand it a bit in detail the changes as there is a chance we will need to maintain these changes.

phatcher · 2025-07-26T08:26:52Z

Can I also suggest adding some tests that use the zero-suppression syntax so that we can get versions without a commits number e.g.

[TestCase(0, "{0:0000}", "0000")]
[TestCase(1, "{0:0000}", "0001")]
[TestCase(0, "{0:-0000;;''}", "")]
[TestCase(1, "{0:-0000;;''}", "-0001")]
public void ZeroFormatting(int value, string template, string expected)
{
    var candidate = string.Format(template, value);

    Assert.That(candidate, Is.EqualTo(expected));
}

arturcic · 2025-07-28T12:08:11Z

@9swampy could you please rebase your branch onto latest main and fix the conflict?

arturcic · 2025-07-30T18:51:48Z

@9swampy I had a look on the code, looks amazing. There are a couple of things that I think we can do to make it merge-able:
IInputSanitizer and the InputSanitizer as well as StringFormatWithExtension please move them into the Formatting folder as they are all related. Now, the Formatting folder is used only by the Output module so I'd suggest to move the entire Formatting folder to the Output module, as the corresponding unit tests to their Output tests. but first of all can you please rebase onto main?

arturcic

Move IInputSanitizer and the InputSanitizer as well as StringFormatWithExtension to Formatting folder

9swampy · 2025-07-30T21:09:30Z

Move IInputSanitizer and the InputSanitizer as well as StringFormatWithExtension to Formatting folder

Done, with Tests. Took liberty of renaming StringFormatWith filename to match contents. Aligns with other extension[s] filenames.

Saw you'd an extra omit under with rebase done. To fix the "conflict" I presume? Sorry I wasn't sure what was going on there, neither option worked so I just left it.

Green now - not - docs blowing up?

9swampy · 2025-07-30T21:28:13Z

Now, the Formatting folder is used only by the Output module so I'd suggest to move the entire Formatting folder to the Output module, as the corresponding unit tests to their Output tests.

Not familiar with the codebase but this is rumbling up quite a ripple effect; dependency inversion, new()s in the extension. Sure you want me to continue?

arturcic · 2025-07-31T05:24:38Z

Now, the Formatting folder is used only by the Output module so I'd suggest to move the entire Formatting folder to the Output module, as the corresponding unit tests to their Output tests.

Not familiar with the codebase but this is rumbling up quite a ripple effect; dependency inversion, new()s in the extension. Sure you want me to continue?

I see there is also another usage within the Core, let's keep it in the core then

arturcic · 2025-07-31T05:36:31Z

@9swampy I approved the changes, @asbjornu may you have a look again?

asbjornu

🤏🏼 so close now! Only a few more nits. Great work! ❤️

asbjornu · 2025-07-31T08:49:55Z

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

+## Verified Examples
+
+The following examples are verified by actual unit tests in the GitVersion codebase:
+
+### Zero-Padded Numeric Formatting
+
+```yaml
+assembly-informational-format: "{Major}.{Minor}.{Patch}-{CommitsSinceVersionSource:0000}"
+```
+
+**Test**: `VariableProviderTests.Format_Allows_CSharp_FormatStrings()`
+**Input**: `CommitsSinceVersionSource = 42`
+**Output**: `"1.2.3-0042"`
+
+### String Case Transformations
+
+```csharp
+// From StringFormatterTests.cs
+[TestCase("hello world", "c", "HelloWorld")]  // PascalCase
+[TestCase("hello", "u", "HELLO")]             // Uppercase
+[TestCase("HELLO", "l", "hello")]             // Lowercase
+[TestCase("hello world", "t", "Hello World")] // Title Case
+[TestCase("hELLO", "s", "Hello")]             // Sentence Case
+```
+
+### Numeric Format Specifiers
+
+```csharp
+// From NumericFormatterTests.cs
+[TestCase("1234.5678", "n", "1,234.57")]      // Number format
+[TestCase("1234.5678", "f2", "1234.57")]      // Fixed-point format
+[TestCase("1234.5678", "f0", "1235")]         // No decimals
+```
+
+### Date Formatting
+
+```csharp
+// From DateFormatterTests.cs
+[TestCase("2021-01-01", "yyyy-MM-dd", "2021-01-01")]
+[TestCase("2021-01-01T12:00:00Z", "yyyy-MM-ddTHH:mm:ssZ", "2021-01-01T12:00:00Z")]
+```
+
+### Currency and Percentage (InvariantCulture)
+
+```csharp
+// From FormattableFormatterTests.cs
+[TestCase(123.456, "C", "¤123.46")]           // Generic currency symbol
+[TestCase(123.456, "P", "12,345.60 %")]       // Percentage format
+[TestCase(1234567890, "N0", "1,234,567,890")] // Thousands separators
+```


I don't think we need to advertise code coverage in our documentation. If the test cases contain essential information, we should provide them in a more human-friendly format.

@9swampy I left only this change on you, all the other requested changes were addressed

I don't think we need to advertise code coverage in our documentation. If the test cases contain essential information, we should provide them in a more human-friendly format.

If that's the worst criticism you had on "my" AI generated ramblings, that's a win. Did you check the links are good?

@9swampy please fix the docs and then I guess we can merge

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

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

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

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

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

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

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

src/GitVersion.Core/Formatting/StringFormatWithExtension.cs

…n.cs

Renames `PascalCase` to `ToPascalCase` and moves `TextInfo` parameter to improve clarity and usability. Refactors related calls to align with the updated method signature.

9swampy · 2025-08-01T17:29:12Z

🤏🏼 so close now! Only a few more nits. Great work! ❤️

Dang. Sry, missed those. I'm debateably OCD to the point editorconfig's become a crutch I depend on, clearly fall over without.

arturcic · 2025-08-04T12:50:43Z

@9swampy will you have time to finalize this one? We want to have a new release and would be nice to include this PR as well

asbjornu

Having now spun up the documentation and read through it, there's one thing I don't quite understand. In what looks like code examples, we find stuff like this:

# GitVersion.yml
template: "{Major}.{Minor}.{Patch:F2}-{PreReleaseLabel}"

This gives the impression that template is a supported configuration key in GitVersion.yml. Afaik, it is not? Fixing the examples so they only provide code that actually works in GitVersion.yml and removing the test cases and I think we're good!

9swampy · 2025-08-05T21:53:11Z

Having now spun up the documentation and read through it, there's one thing I don't quite understand. In what looks like code examples, we find stuff like this:
# GitVersion.yml
template: "{Major}.{Minor}.{Patch:F2}-{PreReleaseLabel}"
This gives the impression that template is a supported configuration key in GitVersion.yml. Afaik, it is not? Fixing the examples so they only provide code that actually works in GitVersion.yml and removing the test cases and I think we're good!

No worries, it was AI generated. The way I read it was:

template = the key being set, from all possible valid keys
"{Major}.{Minor}.{Patch:F2}-{PreReleaseLabel}" = the template being set

It didn't mean to imply there was a configuration key called template, but I see where you're coming from. This and the test verified examples: gone.

Really wasn't comfortable with the docs, that's why I marked them "draft". would be nice to make it in to the imminent release so if there's more tweaks don't be shy.

arturcic · 2025-08-05T22:59:03Z

Having now spun up the documentation and read through it, there's one thing I don't quite understand. In what looks like code examples, we find stuff like this:
# GitVersion.yml
template: "{Major}.{Minor}.{Patch:F2}-{PreReleaseLabel}"
This gives the impression that template is a supported configuration key in GitVersion.yml. Afaik, it is not? Fixing the examples so they only provide code that actually works in GitVersion.yml and removing the test cases and I think we're good!
No worries, it was AI generated. The way I read it was:

template = the key being set, from all possible valid keys

"{Major}.{Minor}.{Patch:F2}-{PreReleaseLabel}" = the template being set

It didn't mean to imply there was a configuration key called template, but I see where you're coming from. This and the test verified examples: gone.

Really wasn't comfortable with the docs, that's why I marked them "draft". would be nice to make it in to the imminent release so if there's more tweaks don't be shy.

@asbjornu if you find all these changes good, please merge this PR

9swampy mentioned this pull request Jun 28, 2025

[ISSUE]: There's no NuGetVersionV2 anymore, and no zero-padded PreReleaseNumber #4153

Closed

2 tasks

9swampy marked this pull request as ready for review June 28, 2025 17:15

9swampy force-pushed the SupportFormatStringsInConfig branch 7 times, most recently from f192c56 to 92fa63f Compare June 28, 2025 22:21

arturcic self-requested a review June 29, 2025 09:27

9swampy force-pushed the SupportFormatStringsInConfig branch from 92fa63f to 9a18634 Compare June 29, 2025 11:21

9swampy force-pushed the SupportFormatStringsInConfig branch 2 times, most recently from e7652ec to 16f557c Compare July 9, 2025 20:40

asbjornu requested changes Jul 15, 2025

View reviewed changes

9swampy commented Jul 15, 2025

View reviewed changes

src/GitVersion.Core/Helpers/StringFormatWith.cs Outdated Show resolved Hide resolved

9swampy requested a review from asbjornu July 15, 2025 18:55

asbjornu reviewed Jul 17, 2025

View reviewed changes

src/GitVersion.Core/Helpers/ExpressionCompiler.cs Outdated Show resolved Hide resolved

src/GitVersion.Core/Helpers/FormattableFormatter.cs Outdated Show resolved Hide resolved

src/GitVersion.Core/Helpers/DateFormatter.cs Outdated Show resolved Hide resolved

9swampy force-pushed the SupportFormatStringsInConfig branch from 3e5bf0e to 65a39f5 Compare July 19, 2025 22:19

asbjornu requested changes Jul 19, 2025

View reviewed changes

src/GitVersion.Core/Formatting/StringFormatter.cs Outdated Show resolved Hide resolved

9swampy force-pushed the SupportFormatStringsInConfig branch 2 times, most recently from c7fbede to 646a634 Compare July 19, 2025 22:53

9swampy requested a review from asbjornu July 20, 2025 01:19

9swampy force-pushed the SupportFormatStringsInConfig branch 3 times, most recently from 53547ee to 625c32f Compare July 20, 2025 12:39

9swampy force-pushed the SupportFormatStringsInConfig branch from 0c3e0c0 to f0e2983 Compare July 26, 2025 18:41

arturcic requested changes Jul 30, 2025

View reviewed changes

arturcic force-pushed the SupportFormatStringsInConfig branch 4 times, most recently from c125c9a to 77a4d38 Compare July 30, 2025 19:53

arturcic approved these changes Jul 31, 2025

View reviewed changes

asbjornu requested changes Jul 31, 2025

View reviewed changes

arturcic force-pushed the SupportFormatStringsInConfig branch from 67d7562 to d68e4a6 Compare July 31, 2025 10:39

9swampy and others added 10 commits July 31, 2025 13:50

Support C# format strings in config

96d8ba6

Address PR comments.

532fdbc

Address PR comments II. Apply SOLI>>D<< to ValueFormatter.

11a9737

Draft documentation proposal.

146e229

Add ZeroFormatting tests to cover zero-suppression syntax

61163ef

Align tests with moved InputSanitizer.cs and StringFormatWithExtensio…

9e97bfe

…n.cs

Renames and updates PascalCase extension method

a147b37

Renames `PascalCase` to `ToPascalCase` and moves `TextInfo` parameter to improve clarity and usability. Refactors related calls to align with the updated method signature.

Fix table alignment and remove trailing whitespaces

7d8bc62

Moves formatting tests to correct namespace

1e890a3

address PR comments

cc37e2b

arturcic force-pushed the SupportFormatStringsInConfig branch from b69d323 to cc37e2b Compare July 31, 2025 11:50

asbjornu requested changes Aug 4, 2025

View reviewed changes

Remove questionable documentation

7efaeb7

Support C# format strings in config #4605

Are you sure you want to change the base?

Support C# format strings in config #4605

Conversation

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

Uh oh!

Description

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Checklist:

Uh oh!

arturcic commented Jun 29, 2025

Uh oh!

asbjornu left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

asbjornu left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

arturcic commented Jul 20, 2025

Uh oh!

phatcher commented Jul 26, 2025

Uh oh!

arturcic commented Jul 28, 2025

Uh oh!

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

Uh oh!

Uh oh!

arturcic left a comment

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Uh oh!

9swampy commented Jul 30, 2025

Uh oh!

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

Uh oh!

Uh oh!

arturcic commented Jul 31, 2025

Uh oh!

asbjornu left a comment

Choose a reason for hiding this comment

Uh oh!

asbjornu Jul 31, 2025

Choose a reason for hiding this comment

Uh oh!

arturcic Jul 31, 2025

Choose a reason for hiding this comment

Uh oh!

9swampy Aug 1, 2025

Choose a reason for hiding this comment

Uh oh!

arturcic Aug 1, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

9swampy commented Aug 1, 2025

Uh oh!

9swampy commented Jun 28, 2025 •

edited

Loading

arturcic commented Jul 30, 2025 •

edited

Loading

9swampy commented Jul 30, 2025 •

edited

Loading

arturcic commented Jul 31, 2025 •

edited

Loading