cleanup

Author: arturcic

schemas/6.0/GitVersion.configuration.json

@@ -10,7 +10,7 @@
       "type": "string"
     },
     "assembly-file-versioning-scheme": {
-      "description": "The scheme to use when setting AssemblyFileVersion attribute. Can be \u0027MajorMinorPatchTag\u0027, \u0027MajorMinorPatch\u0027, \u0027MajorMinor\u0027, \u0027Major\u0027, \u0027None\u0027. Defaults to \u0027MajorMinorPatch\u0027.",
+      "description": "The scheme to use when setting AssemblyFileVersion attribute. Can be 'MajorMinorPatchTag', 'MajorMinorPatch', 'MajorMinor', 'Major', 'None'. Defaults to 'MajorMinorPatch'.",
       "default": "MajorMinorPatch",
       "enum": [
         "MajorMinorPatchTag",
@@ -21,16 +21,16 @@
       ]
     },
     "assembly-informational-format": {
-      "description": "Specifies the format of AssemblyInformationalVersion. Defaults to \u0027{InformationalVersion}\u0027.",
-      "default": "{InformationalVersion}",
+      "description": "Specifies the format of AssemblyInformationalVersion. Defaults to '{InformationalVersion}'.",
+      "default": "'{InformationalVersion}'",
       "type": "string"
     },
     "assembly-versioning-format": {
       "description": "Specifies the format of AssemblyVersion and overwrites the value of assembly-versioning-scheme.",
       "type": "string"
     },
     "assembly-versioning-scheme": {
-      "description": "The scheme to use when setting AssemblyVersion attribute. Can be \u0027MajorMinorPatchTag\u0027, \u0027MajorMinorPatch\u0027, \u0027MajorMinor\u0027, \u0027Major\u0027, \u0027None\u0027. Defaults to \u0027MajorMinorPatch\u0027.",
+      "description": "The scheme to use when setting AssemblyVersion attribute. Can be 'MajorMinorPatchTag', 'MajorMinorPatch', 'MajorMinor', 'Major', 'None'. Defaults to 'MajorMinorPatch'.",
       "default": "MajorMinorPatch",
       "enum": [
         "MajorMinorPatchTag",
@@ -48,7 +48,7 @@
       }
     },
     "commit-date-format": {
-      "description": "The format to use when calculating the commit date. Defaults to \u0027yyyy-MM-dd\u0027. See [Standard Date and Time Format Strings](https://learn.microsoft.com/en-us/dotnet/standard/base-types/standard-date-and-time-format-strings) and [Custom Date and Time Format Strings](https://learn.microsoft.com/en-us/dotnet/standard/base-types/standard-date-and-time-format-strings).",
+      "description": "The format to use when calculating the commit date. Defaults to 'yyyy-MM-dd'. See [Standard Date and Time Format Strings](https://learn.microsoft.com/en-us/dotnet/standard/base-types/standard-date-and-time-format-strings) and [Custom Date and Time Format Strings](https://learn.microsoft.com/en-us/dotnet/standard/base-types/standard-date-and-time-format-strings).",
       "default": "yyyy-MM-dd",
       "type": "string"
     },
@@ -86,8 +86,9 @@
       "$ref": "#/$defs/string1"
     },
     "major-version-bump-message": {
-      "description": "The regular expression to match commit messages with to perform a major version increment. Defaults to \u0027\\\u002Bsemver:\\s?(breaking|major)\u0027",
-      "default": "\\\u002Bsemver:\\s?(breaking|major)",
+      "format": "regex",
+      "description": "The regular expression to match commit messages with to perform a major version increment. Defaults to '\\+semver:\\s?(breaking|major)'",
+      "default": "\\+semver:\\s?(breaking|major)",
       "type": "string"
     },
     "merge-message-formats": {
@@ -98,22 +99,25 @@
       }
     },
     "minor-version-bump-message": {
-      "description": "The regular expression to match commit messages with to perform a minor version increment. Defaults to \u0027\\\u002Bsemver:\\s?(feature|minor)\u0027",
-      "default": "\\\u002Bsemver:\\s?(feature|minor)",
+      "format": "regex",
+      "description": "The regular expression to match commit messages with to perform a minor version increment. Defaults to '\\+semver:\\s?(feature|minor)'",
+      "default": "\\+semver:\\s?(feature|minor)",
       "type": "string"
     },
     "next-version": {
       "description": "Allows you to bump the next version explicitly. Useful for bumping main or a feature branch with breaking changes",
       "type": "string"
     },
     "no-bump-message": {
-      "description": "Used to tell GitVersion not to increment when in Mainline development mode. Defaults to \u0027\\\u002Bsemver:\\s?(none|skip)\u0027",
-      "default": "\\\u002Bsemver:\\s?(none|skip)",
+      "format": "regex",
+      "description": "Used to tell GitVersion not to increment when in Mainline development mode. Defaults to '\\+semver:\\s?(none|skip)'",
+      "default": "\\+semver:\\s?(none|skip)",
       "type": "string"
     },
     "patch-version-bump-message": {
-      "description": "The regular expression to match commit messages with to perform a patch version increment. Defaults to \u0027\\\u002Bsemver:\\s?(fix|patch)\u0027",
-      "default": "\\\u002Bsemver:\\s?(fix|patch)",
+      "format": "regex",
+      "description": "The regular expression to match commit messages with to perform a patch version increment. Defaults to '\\+semver:\\s?(fix|patch)'",
+      "default": "\\+semver:\\s?(fix|patch)",
       "type": "string"
     },
     "pre-release-weight": {
@@ -126,7 +130,7 @@
       "$ref": "#/$defs/string2"
     },
     "semantic-version-format": {
-      "description": "Specifies the semantic version format that is used when parsing the string. Can be \u0027Strict\u0027 or \u0027Loose\u0027. Defaults to \u0027Strict\u0027.",
+      "description": "Specifies the semantic version format that is used when parsing the string. Can be 'Strict' or 'Loose'. Defaults to 'Strict'.",
       "default": "Strict",
       "enum": [
         "Strict",
@@ -137,7 +141,8 @@
       "$ref": "#/$defs/hashSetOfString1"
     },
     "tag-prefix": {
-      "description": "A regular expression which is used to trim Git tags before processing. Defaults to \u0027[vV]?\u0027",
+      "format": "regex",
+      "description": "A regular expression which is used to trim Git tags before processing. Defaults to '[vV]?'",
       "default": "[vV]?",
       "type": "string"
     },
@@ -163,15 +168,16 @@
       "type": "boolean"
     },
     "version-in-branch-pattern": {
-      "description": "A regular expression which is used to determine the version number in the branch name or commit message (e.g., v1.0.0-LTS). Defaults to \u0027(?\u003Cversion\u003E[vV]?\\d\u002B(\\.\\d\u002B)?(\\.\\d\u002B)?).*\u0027.",
-      "default": "(?\u003Cversion\u003E[vV]?\\d\u002B(\\.\\d\u002B)?(\\.\\d\u002B)?).*",
+      "format": "regex",
+      "description": "A regular expression which is used to determine the version number in the branch name or commit message (e.g., v1.0.0-LTS). Defaults to '(?<version>[vV]?\\d+(\\.\\d+)?(\\.\\d+)?).*'.",
+      "default": "(?<version>[vV]?\\d+(\\.\\d+)?(\\.\\d+)?).*",
       "type": "string"
     },
     "mode": {
       "$ref": "#/$defs/nullableOfVersioningMode"
     },
     "workflow": {
-      "description": "The base template of the configuration to use. Possible values are: \u0027GitFlow/v1\u0027 or \u0027GitHubFlow/v1\u0027",
+      "description": "The base template of the configuration to use. Possible values are: 'GitFlow/v1' or 'GitHubFlow/v1'",
       "type": "string"
     }
   },
@@ -227,15 +233,15 @@
       }
     },
     "nullableOfCommitMessageIncrementMode": {
-      "description": "Sets whether it should be possible to increment the version with special syntax in the commit message. Can be \u0027Disabled\u0027, \u0027Enabled\u0027 or \u0027MergeMessageOnly\u0027.",
+      "description": "Sets whether it should be possible to increment the version with special syntax in the commit message. Can be 'Disabled', 'Enabled' or 'MergeMessageOnly'.",
       "enum": [
         "Enabled",
         "Disabled",
         "MergeMessageOnly"
       ]
     },
     "incrementStrategy": {
-      "description": "The increment strategy for this branch. Can be \u0027Inherit\u0027, \u0027Patch\u0027, \u0027Minor\u0027, \u0027Major\u0027, \u0027None\u0027.",
+      "description": "The increment strategy for this branch. Can be 'Inherit', 'Patch', 'Minor', 'Major', 'None'.",
       "enum": [
         "None",
         "Major",
@@ -271,8 +277,9 @@
       "type": "string"
     },
     "string1": {
-      "description": "The regular expression pattern to use to extract the number from the branch name. Defaults to \u0027[/-](?\u003Cnumber\u003E\\d\u002B)\u0027.",
-      "default": "[/-](?\u003Cnumber\u003E\\d\u002B)",
+      "format": "regex",
+      "description": "The regular expression pattern to use to extract the number from the branch name. Defaults to '[/-](?<number>\\d+)'.",
+      "default": "[/-](?<number>\\d+)",
       "type": "string"
     },
     "nullableOfInt32": {
@@ -290,6 +297,7 @@
       ]
     },
     "string2": {
+      "format": "regex",
       "description": "The regular expression pattern to use to match this branch.",
       "type": "string"
     },
@@ -323,7 +331,7 @@
       ]
     },
     "nullableOfVersioningMode": {
-      "description": "The versioning mode for this branch. Can be \u0027ContinuousDelivery\u0027, \u0027ContinuousDeployment\u0027, \u0027Mainline\u0027.",
+      "description": "The versioning mode for this branch. Can be 'ContinuousDelivery', 'ContinuousDeployment', 'Mainline'.",
       "enum": [
         "ContinuousDelivery",
         "ContinuousDeployment",

schemas/6.0/GitVersion.json

@@ -59,7 +59,7 @@
       ]
     },
     "MajorMinorPatch": {
-      "description": "Major, Minor and Patch joined together, separated by \u0027.\u0027.",
+      "description": "Major, Minor and Patch joined together, separated by '.'.",
       "type": "string"
     },
     "Minor": {

src/GitVersion.Configuration/BranchConfiguration.cs

@@ -25,6 +25,7 @@ internal record BranchConfiguration : IBranchConfiguration
     [JsonPropertyName("label-number-pattern")]
     [JsonPropertyDescription($"The regular expression pattern to use to extract the number from the branch name. Defaults to '{ConfigurationConstants.DefaultLabelNumberPattern}'.")]
     [JsonPropertyDefault(ConfigurationConstants.DefaultLabelNumberPattern)]
+    [JsonPropertyFormat(Format.Regex)]
     public string? LabelNumberPattern { get; internal set; }
 
     [JsonPropertyName("track-merge-target")]
@@ -41,6 +42,7 @@ internal record BranchConfiguration : IBranchConfiguration
 
     [JsonPropertyName("regex")]
     [JsonPropertyDescription("The regular expression pattern to use to match this branch.")]
+    [JsonPropertyFormat(Format.Regex)]
     public string? RegularExpression { get; internal set; }
 
     [JsonIgnore]

src/GitVersion.Configuration/ConfigurationSerializer.cs

@@ -43,7 +43,7 @@ public override IEnumerable<IPropertyDescriptor> GetProperties(Type type, object
             {
                 var descriptor = new PropertyDescriptor(p);
                 var member = p.GetCustomAttribute<JsonPropertyNameAttribute>();
-                if (member is { Name: { } })
+                if (member is { Name: not null })
                 {
                     descriptor.Name = member.Name;
                 }

src/GitVersion.Configuration/GitVersionConfiguration.cs

@@ -25,7 +25,7 @@ internal sealed record GitVersionConfiguration : BranchConfiguration, IGitVersio
 
     [JsonPropertyName("assembly-informational-format")]
     [JsonPropertyDescription($"Specifies the format of AssemblyInformationalVersion. Defaults to '{DefaultAssemblyInformationalFormat}'.")]
-    [JsonPropertyDefault(DefaultAssemblyInformationalFormat)]
+    [JsonPropertyDefault($"'{DefaultAssemblyInformationalFormat}'")]
     public string? AssemblyInformationalFormat { get; internal set; }
 
     [JsonPropertyName("assembly-versioning-format")]
@@ -39,11 +39,13 @@ internal sealed record GitVersionConfiguration : BranchConfiguration, IGitVersio
     [JsonPropertyName("tag-prefix")]
     [JsonPropertyDescription($"A regular expression which is used to trim Git tags before processing. Defaults to '{DefaultTagPrefix}'")]
     [JsonPropertyDefault(DefaultTagPrefix)]
+    [JsonPropertyFormat(Format.Regex)]
     public string? TagPrefix { get; internal set; }
 
     [JsonPropertyName("version-in-branch-pattern")]
     [JsonPropertyDescription($"A regular expression which is used to determine the version number in the branch name or commit message (e.g., v1.0.0-LTS). Defaults to '{DefaultVersionInBranchPattern}'.")]
     [JsonPropertyDefault(DefaultVersionInBranchPattern)]
+    [JsonPropertyFormat(Format.Regex)]
     public string? VersionInBranchPattern { get; internal set; }
 
     [JsonIgnore]
@@ -72,21 +74,25 @@ public string? NextVersion
     [JsonPropertyName("major-version-bump-message")]
     [JsonPropertyDescription($"The regular expression to match commit messages with to perform a major version increment. Defaults to '{IncrementStrategyFinder.DefaultMajorPattern}'")]
     [JsonPropertyDefault(IncrementStrategyFinder.DefaultMajorPattern)]
+    [JsonPropertyFormat(Format.Regex)]
     public string? MajorVersionBumpMessage { get; internal set; }
 
     [JsonPropertyName("minor-version-bump-message")]
     [JsonPropertyDescription($"The regular expression to match commit messages with to perform a minor version increment. Defaults to '{IncrementStrategyFinder.DefaultMinorPattern}'")]
     [JsonPropertyDefault(IncrementStrategyFinder.DefaultMinorPattern)]
+    [JsonPropertyFormat(Format.Regex)]
     public string? MinorVersionBumpMessage { get; internal set; }
 
     [JsonPropertyName("patch-version-bump-message")]
     [JsonPropertyDescription($"The regular expression to match commit messages with to perform a patch version increment. Defaults to '{IncrementStrategyFinder.DefaultPatchPattern}'")]
     [JsonPropertyDefault(IncrementStrategyFinder.DefaultPatchPattern)]
+    [JsonPropertyFormat(Format.Regex)]
     public string? PatchVersionBumpMessage { get; internal set; }
 
     [JsonPropertyName("no-bump-message")]
     [JsonPropertyDescription($"Used to tell GitVersion not to increment when in Mainline development mode. Defaults to '{IncrementStrategyFinder.DefaultNoBumpPattern}'")]
     [JsonPropertyDefault(IncrementStrategyFinder.DefaultNoBumpPattern)]
+    [JsonPropertyFormat(Format.Regex)]
     public string? NoBumpMessage { get; internal set; }
 
     [JsonPropertyName("tag-pre-release-weight")]

src/GitVersion.Core/Configuration/ConfigurationConstants.cs

@@ -4,22 +4,23 @@ namespace GitVersion.Configuration;
 
 internal static class ConfigurationConstants
 {
-    public const AssemblyVersioningScheme DefaultAssemblyVersioningScheme = AssemblyVersioningScheme.MajorMinorPatch;
     internal const string NameOfDefaultAssemblyVersioningScheme = nameof(AssemblyVersioningScheme.MajorMinorPatch);
-    public const AssemblyFileVersioningScheme DefaultAssemblyFileVersioningScheme = AssemblyFileVersioningScheme.MajorMinorPatch;
     internal const string NameOfDefaultAssemblyFileVersioningScheme = nameof(AssemblyFileVersioningScheme.MajorMinorPatch);
+    internal const string StringDefaultSemanticVersionFormat = nameof(SemanticVersionFormat.Strict);
+    internal const string StringDefaultTagPreReleaseWeight = "60000";
+    internal const string StringDefaultUpdateBuildNumber = "true";
+
+    public const AssemblyVersioningScheme DefaultAssemblyVersioningScheme = AssemblyVersioningScheme.MajorMinorPatch;
+    public const AssemblyFileVersioningScheme DefaultAssemblyFileVersioningScheme = AssemblyFileVersioningScheme.MajorMinorPatch;
+    public const SemanticVersionFormat DefaultSemanticVersionFormat = SemanticVersionFormat.Strict;
     public const string DefaultAssemblyInformationalFormat = "{InformationalVersion}";
     public const string DefaultTagPrefix = "[vV]?";
     public const string DefaultVersionInBranchPattern = @"(?<version>[vV]?\d+(\.\d+)?(\.\d+)?).*";
-    public const int DefaultTagPreReleaseWeight = 60000;
-    internal const string StringDefaultTagPreReleaseWeight = "60000";
     public const string DefaultCommitDateFormat = "yyyy-MM-dd";
     public const string BranchNamePlaceholder = "{BranchName}";
-    public const bool DefaultUpdateBuildNumber = true;
-    internal const string StringDefaultUpdateBuildNumber = "true";
-    public const SemanticVersionFormat DefaultSemanticVersionFormat = SemanticVersionFormat.Strict;
-    internal const string StringDefaultSemanticVersionFormat = nameof(SemanticVersionFormat.Strict);
     public const string DefaultLabelNumberPattern = @"[/-](?<number>\d+)";
+    public const bool DefaultUpdateBuildNumber = true;
+    public const int DefaultTagPreReleaseWeight = 60000;
 
     public const string MainBranchKey = "main";
     public const string MasterBranchKey = "master";

src/GitVersion.Core/Core/Attributes/JsonPropertyDefaultAttribute.cs

@@ -24,7 +24,7 @@ public JsonPropertyDefaultAttribute(AssemblyFileVersioningScheme value) : this(v
 
     /// <inheritdoc cref="JsonPropertyDefaultAttribute(string)"/>
     /// <remarks>Depending on the Type of the boxed value, the resulting string will be automatically enclosed with single-quotes. If the boxed value is NOT a string and is converted to a string from a numeric , object, array, boolean, or null-only type, then it will NOT be enclosed with single-quotes.</remarks>
-    public JsonPropertyDefaultAttribute(object boxedValue)
+    public JsonPropertyDefaultAttribute(object? boxedValue)
     {
         if (boxedValue is not null)
         {