Add "precision" settting to the "nugetPackageVersion" section in the version.json file

Author: ap0llo

doc/versionJson.md

@@ -39,6 +39,7 @@ The content of the version.json file is a JSON serialized object with these prop
   "gitCommitIdShortAutoMinimum": 0, // optional. Set to use the short commit ID abbreviation provided by the git repository.
   "nugetPackageVersion": {
      "semVer": 1 // optional. Set to either 1 or 2 to control how the NuGet package version string is generated. Default is 1.
+     "precision": "build" // optional. Use when you want to a more or less precise package version than the default major.minor.build.
   },
   "pathFilters": [
     // optional list of paths to consider when calculating version height.

src/NerdBank.GitVersioning.Tests/VersionFileTests.cs

@@ -608,6 +608,38 @@ public void GetVersion_ProducesAbsolutePath()
         Assert.True(Path.IsPathRooted(actualDirectory));
     }
 
+
+    [Theory]
+    [InlineData(1)]
+    [InlineData(2)]
+    public void GetVersion_ReadNuGetPackageVersionSettings_SemVer(int semVer)
+    {
+        var json = $@"{{ ""version"" : ""1.0"", ""nugetPackageVersion"" : {{ ""semVer"" : {semVer}  }} }}";
+        var path = Path.Combine(this.RepoPath, "version.json");
+        File.WriteAllText(path, json);
+
+        var versionOptions = this.Context.VersionFile.GetVersion();
+
+        Assert.NotNull(versionOptions.NuGetPackageVersion);
+        Assert.NotNull(versionOptions.NuGetPackageVersion.SemVer);
+        Assert.Equal(semVer, versionOptions.NuGetPackageVersion.SemVer);
+    }
+
+    [Theory]
+    [CombinatorialData]
+    public void GetVersion_ReadNuGetPackageVersionSettings_Precision(VersionOptions.VersionPrecision precision)
+    {
+        var json = $@"{{ ""version"" : ""1.0"", ""nugetPackageVersion"" : {{ ""precision"" : ""{precision}""  }} }}";
+        var path = Path.Combine(this.RepoPath, "version.json");
+        File.WriteAllText(path, json);
+
+        var versionOptions = this.Context.VersionFile.GetVersion();
+
+        Assert.NotNull(versionOptions.NuGetPackageVersion);
+        Assert.NotNull(versionOptions.NuGetPackageVersion.Precision);
+        Assert.Equal(precision, versionOptions.NuGetPackageVersion.Precision);
+    }
+
     private void AssertPathHasVersion(string committish, string absolutePath, VersionOptions expected)
     {
         var actual = this.GetVersionOptions(absolutePath, committish);

src/NerdBank.GitVersioning.Tests/VersionOptionsTests.cs

@@ -178,6 +178,7 @@ public void CannotWriteToDefaultInstances()
         Assert.Throws<InvalidOperationException>(() => options.CloudBuildOrDefault.BuildNumberOrDefault.IncludeCommitIdOrDefault.Where = VersionOptions.CloudBuildNumberCommitWhere.BuildMetadata);
         Assert.Throws<InvalidOperationException>(() => options.CloudBuildOrDefault.SetVersionVariables = true);
         Assert.Throws<InvalidOperationException>(() => options.NuGetPackageVersionOrDefault.SemVer = 2);
+        Assert.Throws<InvalidOperationException>(() => options.NuGetPackageVersionOrDefault.Precision = VersionOptions.VersionPrecision.Revision);
         Assert.Throws<InvalidOperationException>(() => options.ReleaseOrDefault.BranchName = "BranchName");
         Assert.Throws<InvalidOperationException>(() => options.ReleaseOrDefault.VersionIncrement = VersionOptions.ReleaseVersionIncrement.Major);
         Assert.Throws<InvalidOperationException>(() => options.ReleaseOrDefault.FirstUnstableTag = "-tag");
@@ -226,4 +227,30 @@ public void ReleaseOptions_Equality()
         Assert.NotEqual(ro3, ro5);
         Assert.NotEqual(ro5, ro6);
     }
+
+    [Fact]
+    public void NuGetPackageVersionOptions_Equality()
+    {
+        var npvo1a = new VersionOptions.NuGetPackageVersionOptions { };
+        var npvo1b = new VersionOptions.NuGetPackageVersionOptions { };
+        Assert.Equal(npvo1a, npvo1b);
+
+        var npvo2a = new VersionOptions.NuGetPackageVersionOptions
+        {
+            SemVer = 2
+        };
+        Assert.NotEqual(npvo2a, npvo1a);
+
+        var npvo3a = new VersionOptions.NuGetPackageVersionOptions
+        {
+            Precision = VersionOptions.VersionPrecision.Revision
+        };
+        Assert.NotEqual(npvo3a, npvo1a);
+
+        var npvo4a = new VersionOptions.NuGetPackageVersionOptions
+        {
+            Precision = VersionOptions.VersionPrecision.Build
+        };
+        Assert.Equal(npvo4a, npvo1a); // Equal because we haven't changed defaults.
+    }
 }

src/NerdBank.GitVersioning/VersionOptions.cs

@@ -584,6 +584,7 @@ public class NuGetPackageVersionOptions : IEquatable<NuGetPackageVersionOptions>
             {
                 isFrozen = true,
                 semVer = 1.0f,
+                precision = VersionPrecision.Build
             };
 
             [DebuggerBrowsable(DebuggerBrowsableState.Never)]
@@ -592,6 +593,9 @@ public class NuGetPackageVersionOptions : IEquatable<NuGetPackageVersionOptions>
             [DebuggerBrowsable(DebuggerBrowsableState.Never)]
             private float? semVer;
 
+            [DebuggerBrowsable(DebuggerBrowsableState.Never)]
+            private VersionPrecision? precision;
+
             /// <summary>
             /// Initializes a new instance of the <see cref="NuGetPackageVersionOptions" /> class.
             /// </summary>
@@ -623,6 +627,22 @@ public float? SemVer
             [JsonIgnore]
             public float? SemVerOrDefault => this.SemVer ?? DefaultInstance.SemVer;
 
+            /// <summary>
+            /// Gets or sets number of version components to include when generating the package version.
+            /// </summary>
+            [JsonProperty(DefaultValueHandling = DefaultValueHandling.Ignore)]
+            public VersionPrecision? Precision
+            {
+                get => this.precision;
+                set => this.SetIfNotReadOnly(ref this.precision, value);
+            }
+
+            /// <summary>
+            /// Gets the number of version components to include when generating the package version.
+            /// </summary>
+            [JsonIgnore]
+            public VersionPrecision PrecisionOrDefault => this.Precision ?? DefaultInstance.Precision!.Value;
+
             /// <summary>
             /// Gets a value indicating whether this instance rejects all attempts to mutate it.
             /// </summary>
@@ -679,13 +699,22 @@ public bool Equals(NuGetPackageVersionOptions? x, NuGetPackageVersionOptions? y)
                         return false;
                     }
 
-                    return x.SemVerOrDefault == y.SemVerOrDefault;
+                    return x.SemVerOrDefault == y.SemVerOrDefault &&
+                           x.PrecisionOrDefault == y.PrecisionOrDefault;
                 }
 
                 /// <inheritdoc />
                 public int GetHashCode(NuGetPackageVersionOptions? obj)
                 {
-                    return obj?.SemVerOrDefault.GetHashCode() ?? 0;
+                    if (obj is null)
+                        return 0;
+
+                    unchecked
+                    {
+                        var hash = obj.SemVerOrDefault.GetHashCode() * 397;
+                        hash ^= obj.PrecisionOrDefault.GetHashCode();
+                        return hash;
+                    }
                 }
             }
         }

src/NerdBank.GitVersioning/version.schema.json

@@ -108,6 +108,12 @@
               "default": 1,
               "minimum": 1,
               "maximum": 2
+            },
+            "precision": {
+              "type": "string",
+              "description": "Specifies the number of components to include in the NuGet package version.",
+              "enum": [ "major", "minor", "build", "revision" ],
+              "default": "build"
             }
           }
         },