Better error messages and fix double quote problem

- Updated to latest daily build `2.0.0-beta4.24123.1` of System.CommandLine.
- Better error message when a passed class does not have a `[CliCommand]` attribute ot it's a nested class and one of its parents
  does not have a `[CliCommand]` attribute.
- On Windows platform, backslash + double quote (`\"`) at the end of an argument,
  is usually a path separator and not an escape for double quote, so it will be trimmed to prevent unnecessary path errors.
  Related to dotnet/command-line-api#2334, dotnet/command-line-api#2276, dotnet/command-line-api#354

Author: calacayir

docs/README.md

@@ -902,10 +902,11 @@ Options:
   -v, --version              Show version information
   -?, -h, --help             Show help and usage information
 ```
-First line comes from `AssemblyProductAttribute` or `AssemblyName`. 
-Version comes from `AssemblyInformationalVersionAttribute` or `AssemblyFileVersionAttribute` or `AssemblyVersionAttribute`.
-Second line comes from `AssemblyCopyrightAttribute`.
-Third line comes from `CliCommand.Description` or `AssemblyDescriptionAttribute`.
+- First line comes from `AssemblyProductAttribute` or `AssemblyName` (`<Product>` tag in your .csproj file).  
+  Version comes from `AssemblyInformationalVersionAttribute` or `AssemblyFileVersionAttribute` or `AssemblyVersionAttribute`
+  (`<InformationalVersion>` or `<FileVersion >` or `<Version>` tag in your .csproj file).
+- Second line comes from `AssemblyCopyrightAttribute` (`<Copyright>` tag in your .csproj file).
+- Third line comes from `Description` property of `[CliCommand]` or for root commands, `AssemblyDescriptionAttribute` (`<Description>` tag in your .csproj file).
 
 Note, how command/option/argument names, descriptions and default values are automatically populated.
 

src/Directory.Build.props

@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <!-- https://learn.microsoft.com/en-us/dotnet/core/project-sdk/msbuild-props#generateassemblyinfo -->
-    <VersionPrefix>1.8.1</VersionPrefix>
+    <VersionPrefix>1.8.2</VersionPrefix>
     <Product>DotMake Command-Line</Product>
     <Company>DotMake</Company>
     <!-- Copyright is also used for NuGet metadata -->

src/DotMake.CommandLine.SourceGeneration/CliArgumentInfo.cs

@@ -26,7 +26,7 @@ public CliArgumentInfo(ISymbol symbol, SyntaxNode syntaxNode, AttributeData attr
             Symbol = (IPropertySymbol)symbol;
             Parent = parent;
 
-            ParseInfo = new CliArgumentParseInfo(Symbol, syntaxNode, semanticModel, this);
+            ParseInfo = new CliArgumentParserInfo(Symbol, syntaxNode, semanticModel, this);
 
             Analyze();
 
@@ -61,7 +61,7 @@ public CliArgumentInfo(GeneratorAttributeSyntaxContext attributeSyntaxContext)
 
         public bool Required { get; }
 
-        public CliArgumentParseInfo ParseInfo { get; set; }
+        public CliArgumentParserInfo ParseInfo { get; set; }
 
         private void Analyze()
         {
@@ -124,9 +124,12 @@ public void AppendCSharpCreateString(CodeStringBuilder sb, string varName, strin
                             break;
                     }
                 }
-            }
 
-            ParseInfo.AppendCSharpCallString(sb, $"{varName}.CustomParser");
+                if (!Required)
+                    sb.AppendLine($"DefaultValueFactory = _ => {varDefaultValue},");
+
+                ParseInfo.AppendCSharpCallString(sb, "CustomParser", ",");
+            }
 
             if (AttributeArguments.TryGetTypedConstant(nameof(CliArgumentAttribute.AllowedValues), out var allowedValuesTypedConstant))
                 sb.AppendLine($"{varName}.AcceptOnlyFromAmong(new[] {allowedValuesTypedConstant.ToCSharpString()});");
@@ -142,9 +145,6 @@ public void AppendCSharpCreateString(CodeStringBuilder sb, string varName, strin
                     sb.AppendLine($"DotMake.CommandLine.CliValidationExtensions.AddValidator({varName}, {validationPatternTypedConstant.ToCSharpString()});");
             }
 
-            if (!Required)
-                sb.AppendLine($"{varName}.DefaultValueFactory = _ => {varDefaultValue};");
-
             //In ArgumentArity.Default, Arity is set to ZeroOrMore for IEnumerable if parent is command,
             //but we want to enforce OneOrMore so that Required is consistent
             if (Required

src/DotMake.CommandLine.SourceGeneration/CliArgumentParseInfo.cs renamed to src/DotMake.CommandLine.SourceGeneration/CliArgumentParserInfo.cs

@@ -5,7 +5,7 @@
 
 namespace DotMake.CommandLine.SourceGeneration
 {
-    public class CliArgumentParseInfo : CliSymbolInfo, IEquatable<CliArgumentParseInfo>
+    public class CliArgumentParserInfo : CliSymbolInfo, IEquatable<CliArgumentParserInfo>
     {
         private static readonly HashSet<string> SupportedConverters = new HashSet<string>
         {
@@ -43,7 +43,7 @@ public class CliArgumentParseInfo : CliSymbolInfo, IEquatable<CliArgumentParseIn
             "System.Net.IPEndPoint"
         };
 
-        public CliArgumentParseInfo(IPropertySymbol symbol, SyntaxNode syntaxNode, SemanticModel semanticModel, CliSymbolInfo parent)
+        public CliArgumentParserInfo(IPropertySymbol symbol, SyntaxNode syntaxNode, SemanticModel semanticModel, CliSymbolInfo parent)
             : base(symbol, syntaxNode, semanticModel)
         {
             Symbol = symbol;
@@ -109,11 +109,11 @@ private void Analyze()
             }
         }
 
-        public void AppendCSharpCallString(CodeStringBuilder sb, string varCustomParser)
+        public void AppendCSharpCallString(CodeStringBuilder sb, string varCustomParser, string afterBlock)
         {
             if (ItemType != null)
             {
-                using (sb.AppendParamsBlockStart($"{varCustomParser} = GetParseArgument<{Type.ToReferenceString()}, {ItemType.ToReferenceString()}>", ";"))
+                using (sb.AppendParamsBlockStart($"{varCustomParser} = GetArgumentParser<{Type.ToReferenceString()}, {ItemType.ToReferenceString()}>", afterBlock))
                 {
                     if (Converter == null)
                         sb.AppendLine("null,");
@@ -141,7 +141,7 @@ public void AppendCSharpCallString(CodeStringBuilder sb, string varCustomParser)
             {
                 //Even if argument type does not need a converter, use a ParseArgument method,
                 //so that our custom converter is used for supporting all collection compatible types.
-                using (sb.AppendParamsBlockStart($"{varCustomParser} = GetParseArgument<{Type.ToReferenceString()}>", ";"))
+                using (sb.AppendParamsBlockStart($"{varCustomParser} = GetArgumentParser<{Type.ToReferenceString()}>", afterBlock))
                 {
                     if (Converter == null)
                         sb.AppendLine("null");
@@ -153,7 +153,7 @@ public void AppendCSharpCallString(CodeStringBuilder sb, string varCustomParser)
             }
         }
 
-        public bool Equals(CliArgumentParseInfo other)
+        public bool Equals(CliArgumentParserInfo other)
         {
             return base.Equals(other);
         }

src/DotMake.CommandLine.SourceGeneration/CliCommandAsDelegateInfo.cs

@@ -11,7 +11,7 @@ namespace DotMake.CommandLine.SourceGeneration
     public class CliCommandAsDelegateInfo : CliSymbolInfo, IEquatable<CliCommandAsDelegateInfo>
     {
         private const string TaskFullName = "System.Threading.Tasks.Task";
-        public static readonly string CliCommandAsDelegateDefinitionFullName = "DotMake.CommandLine.CliCommandAsDelegateDefinition";
+        public static readonly string CliCommandAsDelegateFullName = "DotMake.CommandLine.CliCommandAsDelegate";
 
         public CliCommandAsDelegateInfo(ISymbol symbol, SyntaxNode syntaxNode, SemanticModel semanticModel)
             : base(symbol, syntaxNode, semanticModel)
@@ -109,7 +109,7 @@ public string GenerateHash()
             return GenerateString().GetStableStringHashCode32();
         }
 
-        //The generated string should match the one generated in DotMake.CommandLine.CliCommandAsDelegateDefinition
+        //The generated string should match the one generated in DotMake.CommandLine.CliCommandAsDelegate
         //So that the generated hash matches.
         public string GenerateString()
         {
@@ -199,7 +199,7 @@ public void AppendCSharpDefineString(CodeStringBuilder sb)
             else
                 sb.AppendLine($"[{CliCommandInfo.AttributeFullName}]");
 
-            using (sb.AppendBlockStart($"public class {GeneratedClassName} : {CliCommandAsDelegateDefinitionFullName}"))
+            using (sb.AppendBlockStart($"public class {GeneratedClassName} : {CliCommandAsDelegateFullName}"))
             {
                 for (var index = 0; index < ParameterInfos.Count; index++)
                 {

src/DotMake.CommandLine.SourceGeneration/CliOptionInfo.cs

@@ -26,7 +26,7 @@ public CliOptionInfo(ISymbol symbol, SyntaxNode syntaxNode, AttributeData attrib
             Symbol = (IPropertySymbol)symbol;
             Parent = parent;
 
-            ParseInfo = new CliArgumentParseInfo(Symbol, syntaxNode, semanticModel, this);
+            ParseInfo = new CliArgumentParserInfo(Symbol, syntaxNode, semanticModel, this);
 
             Analyze();
 
@@ -62,7 +62,7 @@ public CliOptionInfo(GeneratorAttributeSyntaxContext attributeSyntaxContext)
 
         public bool Required { get; }
 
-        public CliArgumentParseInfo ParseInfo { get; set; }
+        public CliArgumentParserInfo ParseInfo { get; set; }
 
         private void Analyze()
         {
@@ -132,9 +132,11 @@ public void AppendCSharpCreateString(CodeStringBuilder sb, string varName, strin
 
                 //Required is special as it can be calculated when CliOptionAttribute.Required is missing (not forced)
                 sb.AppendLine($"Required = {Required.ToString().ToLowerInvariant()},");
-            }
+                if (!Required)
+                    sb.AppendLine($"DefaultValueFactory = _ => {varDefaultValue},");
 
-            ParseInfo.AppendCSharpCallString(sb, $"{varName}.CustomParser");
+                ParseInfo.AppendCSharpCallString(sb, "CustomParser", ",");
+            }
 
             if (AttributeArguments.TryGetTypedConstant(nameof(CliOptionAttribute.AllowedValues), out var allowedValuesTypedConstant))
                 sb.AppendLine($"{varName}.AcceptOnlyFromAmong(new[] {allowedValuesTypedConstant.ToCSharpString()});");
@@ -150,9 +152,6 @@ public void AppendCSharpCreateString(CodeStringBuilder sb, string varName, strin
                     sb.AppendLine($"DotMake.CommandLine.CliValidationExtensions.AddValidator({varName}, {validationPatternTypedConstant.ToCSharpString()});");
             }
 
-            if (!Required)
-                sb.AppendLine($"{varName}.DefaultValueFactory = _ => {varDefaultValue};");
-
             var shortForm = optionName.RemovePrefix();
             if (Parent.Settings.ShortFormAutoGenerate && shortForm.Length >= 2)
             {

src/DotMake.CommandLine.SourceGeneration/DotMake.CommandLine.SourceGeneration.csproj

@@ -53,8 +53,4 @@
     <EmbeddedResource Remove="..\DotMake.CommandLine.SourceGeneration.Embedded\obj\**\*" />
   </ItemGroup>
 
-  <ItemGroup>
-    <EmbeddedResource Remove="..\DotMake.CommandLine.SourceGeneration.Embedded\CliServiceExtensions.cs" />
-  </ItemGroup>
-
 </Project>

src/DotMake.CommandLine/Cli.cs

@@ -4,6 +4,7 @@
 using System.CommandLine.Help;
 using System.CommandLine.Invocation;
 using System.Linq;
+using System.Runtime.InteropServices;
 using System.Threading;
 using System.Threading.Tasks;
 
@@ -41,16 +42,20 @@ public static class Cli
 
         /// <summary>
         /// Returns a string array containing the command-line arguments for the current process.
+        /// <para>
         /// Uses <see cref="Environment.GetCommandLineArgs"/> but skips the first element which is the executable file name,
         /// so the following zero or more elements that contain the remaining command-line arguments are returned,
         /// i.e. returns the same as the special variable <c>args</c> available in <c>Program.cs</c> (new style with top-level statements)
         /// or as the string array passed to the program's <c>Main</c> method (old style).
+        /// </para>
+        /// <para>Also on Windows platform, backslash + double quote (<c>\&quot;</c>) at the end of an argument,
+        /// is usually a path separator and not an escape for double quote, so it will be trimmed to prevent unnecessary path errors.</para>
         /// </summary>
         /// <returns>An array of strings where each element contains a command-line argument.</returns>
         public static string[] GetArgs()
         {
             if (Environment.GetCommandLineArgs() is { Length: > 0 } args)
-                return args.Skip(1).ToArray();
+                return FixArgs(args.Skip(1).ToArray());
 
             return Array.Empty<string>();
         }
@@ -156,7 +161,7 @@ public static int Run<TDefinition>(string[] args = null, CliSettings settings =
         {
             var configuration = GetConfiguration<TDefinition>(settings);
 
-            return configuration.Invoke(args ?? GetArgs());
+            return configuration.Invoke(FixArgs(args) ?? GetArgs());
         }
 
         /// <summary>
@@ -200,7 +205,7 @@ public static int Run<TDefinition>(string commandLine, CliSettings settings = nu
         /// </example>
         public static int Run(Delegate cliCommandAsDelegate, CliSettings settings = null)
         {
-            var definitionType = CliCommandAsDelegateDefinition.Get(cliCommandAsDelegate);
+            var definitionType = CliCommandAsDelegate.Get(cliCommandAsDelegate);
             var configuration = GetConfiguration(definitionType, settings);
 
             return configuration.Invoke(GetArgs());
@@ -224,7 +229,7 @@ public static async Task<int> RunAsync<TDefinition>(string[] args = null, CliSet
         {
             var configuration = GetConfiguration<TDefinition>(settings);
 
-            return await configuration.InvokeAsync(args ?? GetArgs(), cancellationToken);
+            return await configuration.InvokeAsync(FixArgs(args) ?? GetArgs(), cancellationToken);
         }
 
         /// <summary>
@@ -259,7 +264,7 @@ public static async Task<int> RunAsync<TDefinition>(string commandLine, CliSetti
         /// </example>
         public static async Task<int> RunAsync(Delegate cliCommandAsDelegate, CliSettings settings = null, CancellationToken cancellationToken = default)
         {
-            var definitionType = CliCommandAsDelegateDefinition.Get(cliCommandAsDelegate);
+            var definitionType = CliCommandAsDelegate.Get(cliCommandAsDelegate);
             var configuration = GetConfiguration(definitionType, settings);
 
             return await configuration.InvokeAsync(GetArgs(), cancellationToken);
@@ -281,7 +286,7 @@ public static ParseResult Parse<TDefinition>(string[] args = null, CliSettings s
         {
             var configuration = GetConfiguration<TDefinition>(settings);
 
-            return configuration.Parse(args ?? GetArgs());
+            return configuration.Parse(FixArgs(args) ?? GetArgs());
         }
 
         /// <summary>
@@ -316,6 +321,36 @@ public static TDefinition Bind<TDefinition>(this ParseResult parseResult)
             return (TDefinition)commandBuilder.Bind(parseResult);
         }
 
+        private static string[] FixArgs(string[] args)
+        {
+            if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows)
+                && args != null)
+            {
+                /*
+                  On Windows, trim ending double quote:
+                  For example, if a path parameter is passed like this:
+                   --source "C:\myfiles\"
+                  The value comes as
+                   C:\myfiles"
+                  due to CommandLineToArgvW reading backslash as an escape for double quote character.
+                  As on Windows, backslash at the end is usually a path separator, trim it to prevent unnecessary errors.
+                  Note that this is not required for commandLine string as in that case SplitCommandLine is used,
+                  and it already trims double quote characters
+
+                  https://devblogs.microsoft.com/oldnewthing/20100917-00/?p=12833
+                  https://github.com/dotnet/command-line-api/issues/2334
+                  https://github.com/dotnet/command-line-api/issues/2276
+                  https://github.com/dotnet/command-line-api/issues/354
+                */
+                for (var index = 0; index < args.Length; index++)
+                {
+                    args[index] = args[index].TrimEnd('"');
+                }
+            }
+
+            return args;
+        }
+
         private sealed class VersionOptionAction : SynchronousCliAction
         {
             public override int Invoke(ParseResult parseResult)

src/DotMake.CommandLine/CliCommandAsDelegateDefinition.cs renamed to src/DotMake.CommandLine/CliCommandAsDelegate.cs

@@ -9,7 +9,7 @@ namespace DotMake.CommandLine
     /// <summary>
     /// Represents a definition class generated by the source generator for a command as delegate.
     /// </summary>
-    public class CliCommandAsDelegateDefinition
+    public class CliCommandAsDelegate
     {
         /// <summary>
         /// Invokes the method represented by the command as delegate.
@@ -25,7 +25,7 @@ public object InvokeDelegate(string hash, object[] args)
         {
             if (!RegisteredDelegates.TryGetValue(hash, out var delegateInstance))
                 throw new Exception($"A registered command as delegate instance is not found for hash '{hash}'. " +
-                                    $"Please ensure CliCommandAsDelegateDefinition.Get() is called first.");
+                                    $"Please ensure CliCommandAsDelegate.Get() is called first.");
 
             return delegateInstance.DynamicInvoke(args);
         }