fix: switch default version property back to Version + add CLI option

Merge pull request #111 from skarpdev/bugfix-not-reading-version-tag

Author: nover

src/Program.cs

@@ -65,6 +65,11 @@ static int Main(string[] args)
                 "Set tag's name - default is 'v<version>'. Available variables: $projName, $oldVer, $newVer",
                 CommandOptionType.SingleValue);
 
+            var projectFilePropertyName = commandLineApplication.Option(
+                "-v | --version-property-name <property-name>",
+                "Specify which tag from <PropertyGroup> to use as the version tag. Default is Version. Available values: Version, PackageVersion.",
+                CommandOptionType.SingleValue);
+
             commandLineApplication.OnExecute(() =>
             {
                 try
@@ -103,7 +108,8 @@ static int Main(string[] args)
                         buildMetaOption.Value(),
                         prefixOption.Value(),
                         commitMessage.Value(),
-                        vcsTag.Value()
+                        vcsTag.Value(),
+                        projectFilePropertyName.Value()
                     );
                     _cli.Execute(cliArgs);
 
@@ -143,7 +149,8 @@ internal static VersionCliArgs GetVersionBumpFromRemainingArgs(
             string userSpecifiedBuildMeta,
             string preReleasePrefix,
             string commitMessage,
-            string vcsTag
+            string vcsTag,
+            string projectFilePropertyName
         )
         {
             if (remainingArguments == null || !remainingArguments.Any())
@@ -162,8 +169,9 @@ string vcsTag
                 BuildMeta = userSpecifiedBuildMeta,
                 PreReleasePrefix = preReleasePrefix,
                 CommitMessage = commitMessage,
-                VersionControlTag = vcsTag,
+                VersionControlTag = vcsTag
             };
+            
             var bump = VersionBump.Patch;
 
             foreach (var arg in remainingArguments)
@@ -177,6 +185,11 @@ string vcsTag
 
             args.VersionBump = bump;
             args.CsProjFilePath = userSpecifiedCsProjFilePath;
+            
+            if (!string.IsNullOrEmpty(projectFilePropertyName))
+            {
+                args.ProjectFilePropertyName = Enum.Parse<ProjectFileProperty>(projectFilePropertyName, ignoreCase: true);
+            }
 
             return args;
         }

src/VersionCliArgs.cs

@@ -44,8 +44,8 @@ public class VersionCliArgs
         public string VersionControlTag { get; set; }
 
         /// <summary>
-        /// Specify the Version-Tag that should be targeted. Default is PackageVersion
+        /// Specify the Version-Tag that should be targeted. Default is Version.
         /// </summary>
-        public ProjectFileProperty ProjectFilePropertyName { get; set; } = ProjectFileProperty.PackageVersion;
+        public ProjectFileProperty ProjectFilePropertyName { get; set; } = ProjectFileProperty.Version;
     }
 }

test/ProgramTest.cs

@@ -1,9 +1,6 @@
 using System;
 using System.Collections.Generic;
-using System.Text;
-using FakeItEasy;
-using Microsoft.Extensions.CommandLineUtils;
-using Microsoft.VisualStudio.TestPlatform.TestHost;
+using Skarp.Version.Cli.CsProj;
 using Xunit;
 
 namespace Skarp.Version.Cli.Test
@@ -21,7 +18,7 @@ public class ProgramTest
         [InlineData("1.0.1-0", VersionBump.Specific)]
         [InlineData("1.0.1-0+master", VersionBump.Specific)]
         [InlineData("1.0.1-alpha.43+4432fsd", VersionBump.Specific)]
-        public void GetVersionBumpFromRemaingArgsWork(string strVersionBump, VersionBump expectedBump)
+        public void GetVersionBumpFromRemainingArgsWork(string strVersionBump, VersionBump expectedBump)
         {
             var args = Program.GetVersionBumpFromRemainingArgs(
                 new List<string>() {strVersionBump},
@@ -32,6 +29,7 @@ public void GetVersionBumpFromRemaingArgsWork(string strVersionBump, VersionBump
                 string.Empty,
                 string.Empty,
                 string.Empty,
+                string.Empty,
                 string.Empty
             );
             Assert.Equal(expectedBump, args.VersionBump);
@@ -54,6 +52,7 @@ public void Get_version_bump_throws_on_missing_value()
                     string.Empty,
                     string.Empty,
                     string.Empty,
+                    string.Empty,
                     string.Empty
                 )
             );
@@ -77,12 +76,55 @@ public void Get_version_bump_throws_on_invalid_value()
                     string.Empty,
                     string.Empty,
                     string.Empty,
+                    string.Empty,
                     string.Empty
                 )
             );
             Assert.Contains($"Invalid SemVer version string: {invalidVersion}",
                 ex.Message);
             Assert.Equal("versionString", ex.ParamName);
         }
+        
+        [Fact]
+        public void DefaultsToReadingVersionStringFromVersionProperty()
+        {
+            var args = Program.GetVersionBumpFromRemainingArgs(
+                new List<string>() {"patch"},
+                OutputFormat.Text,
+                true,
+                true,
+                string.Empty,
+                string.Empty,
+                string.Empty,
+                string.Empty,
+                string.Empty,
+                string.Empty
+            );
+            
+            Assert.Equal(ProjectFileProperty.Version, args.ProjectFilePropertyName);
+        }
+        
+        [Theory]
+        [InlineData(null, ProjectFileProperty.Version)]
+        [InlineData("", ProjectFileProperty.Version)]
+        [InlineData("verSION", ProjectFileProperty.Version)]
+        [InlineData("packageversion", ProjectFileProperty.PackageVersion)]
+        public void CanOverrideTheVersionPropertyName(string input, ProjectFileProperty expected)
+        {
+            var args = Program.GetVersionBumpFromRemainingArgs(
+                new List<string>() {"patch"},
+                OutputFormat.Text,
+                true,
+                true,
+                string.Empty,
+                string.Empty,
+                string.Empty,
+                string.Empty,
+                string.Empty,
+                input
+            );
+            
+            Assert.Equal(expected, args.ProjectFilePropertyName);
+        }
     }
 }