Version 2.8.1

- **Fixed:** Help was no longer printed for subcommands with a required argument with v2.8.0.
  This happened due to the update to `2.0.0-rc.1.25451.107` of System.CommandLine.
  There is a new property `ClearsParseErrors` in `SynchronousCommandLineAction`
  which from now on, should be overridden to return `true` for our custom actions like `CustomHelpAction` and `VersionOptionAction`.
  Normally our `CliHelpBuilder` checks for `ParseResult.Errors.Count > 0` to avoid printing help when there is a parsing error.
  So as `ClearsParseErrors` was not set to `true`, `CliHelpBuilder` was not printing help as it thought there was a parse error
  i.e. `Required argument missing for command`, even though `-?` or `-h` was passed.

Author: calacayir

src/Directory.Build.props

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

src/DotMake.CommandLine/CliContext.cs

@@ -92,6 +92,9 @@ public void ShowHelp()
 
             var action = (SynchronousCommandLineAction)helpOption.Action;
 
+            //Note that currently there is a check in CliHelpBuilder.Write; it does not print help if ParseResult.Errors.Count > 0
+            //if in future forcing help is required then either errors can be cleared in  here
+            //or a custom force parameter can be passed
             action?.Invoke(parseResult);
         }
 

src/DotMake.CommandLine/CliHelpBuilder.cs

@@ -81,6 +81,12 @@ public override void Write(HelpContext helpContext)
                 throw new ArgumentNullException(nameof(helpContext));
             }
 
+            //Important: After 2.0.0-rc.1.25451.107 property SynchronousCommandLineAction.ClearsParseErrors
+            //should be set to true for custom actions like Help and Version
+            //Otherwise Errors.Count was 1 for a command that required at least one argument.
+            //Note that this can also be called from CliContext.ShowHelp() to show help
+            //however still checking  Errors.Count here, if in future forcing help is required
+            //then either errors can be cleared in CliContext.ShowHelp() or a custom force parameter can be passed
             if (helpContext.Command.Hidden || helpContext.ParseResult.Errors.Count > 0)
             {
                 return;

src/DotMake.CommandLine/CliParser.cs

@@ -279,6 +279,9 @@ public override int Invoke(ParseResult parseResult)
                 parseResult.InvocationConfiguration.Output.WriteLine(ExecutableInfo.Version);
                 return 0;
             }
+
+            //Important: After 2.0.0-rc.1.25451.107 this new property to should be set to true for custom actions like Help and Version
+            public override bool ClearsParseErrors => true;
         }
     }
 }

src/DotMake.CommandLine/DotMake.CommandLine.csproj

@@ -21,9 +21,13 @@
     <PackageTags>command-line CLI console System.CommandLine declarative attributes parsing command argument option generator</PackageTags>
     <PackageReleaseNotes>
       <![CDATA[
-        - **Improved:** Updated to version `2.0.0-rc.1.25451.107` of System.CommandLine.
-        - **Added:** `MaxWidth`property to `CustomHelpAction`
-          and ensure correct `maxWidth` parameter in `CliHelpBuilder` constructor if not specified.
+        - **Fixed:** Help was no longer printed for subcommands with a required argument with v2.8.0.
+          This happened due to the update to `2.0.0-rc.1.25451.107` of System.CommandLine.
+          There is a new property `ClearsParseErrors` in `SynchronousCommandLineAction`
+          which from now on, should be overridden to return `true` for our custom actions like `CustomHelpAction` and `VersionOptionAction`.
+          Normally our `CliHelpBuilder` checks for `ParseResult.Errors.Count > 0` to avoid printing help when there is a parsing error.
+          So as `ClearsParseErrors` was not set to `true`, `CliHelpBuilder` was not printing help as it thought there was a parse error
+          i.e. `Required argument missing for command`, even though `-?` or `-h` was passed.
       ]]>
      </PackageReleaseNotes>
   </PropertyGroup>

src/DotMake.CommandLine/Help/CustomHelpAction.cs

@@ -70,5 +70,9 @@ public override int Invoke(ParseResult parseResult)
 
             return 0;
         }
+
+        //Important: After 2.0.0-rc.1.25451.107 this new property to should be set to true for custom actions like Help and Version
+        /// <inheritdoc />
+        public override bool ClearsParseErrors => true;
     }
 }

src/TestApp/GeneratedFiles/net472/DotMake.CommandLine.SourceGeneration/DotMake.CommandLine.SourceGeneration.CliIncrementalGenerator/(ModuleInitializerAttribute).g.cs

@@ -1,5 +1,5 @@
 // <auto-generated />
-// Generated by DotMake.CommandLine.SourceGeneration v2.8.0.0
+// Generated by DotMake.CommandLine.SourceGeneration v2.8.1.0
 // Roslyn (Microsoft.CodeAnalysis) v4.1400.25.41305
 // Generation: 1
 

src/TestApp/GeneratedFiles/net472/DotMake.CommandLine.SourceGeneration/DotMake.CommandLine.SourceGeneration.CliIncrementalGenerator/(RequiredMemberAttribute).g.cs

@@ -1,5 +1,5 @@
 // <auto-generated />
-// Generated by DotMake.CommandLine.SourceGeneration v2.8.0.0
+// Generated by DotMake.CommandLine.SourceGeneration v2.8.1.0
 // Roslyn (Microsoft.CodeAnalysis) v4.1400.25.41305
 // Generation: 1
 

src/TestApp/GeneratedFiles/net472/DotMake.CommandLine.SourceGeneration/DotMake.CommandLine.SourceGeneration.CliIncrementalGenerator/ArgumentConverterCliCommandBuilder-3j0trcm.g.cs

@@ -1,5 +1,5 @@
 // <auto-generated />
-// Generated by DotMake.CommandLine.SourceGeneration v2.8.0.0
+// Generated by DotMake.CommandLine.SourceGeneration v2.8.1.0
 // Roslyn (Microsoft.CodeAnalysis) v4.1400.25.41305
 // Generation: 1
 

src/TestApp/GeneratedFiles/net472/DotMake.CommandLine.SourceGeneration/DotMake.CommandLine.SourceGeneration.CliIncrementalGenerator/CamelCaseCliCommandBuilder-2ntm48g.g.cs

@@ -1,5 +1,5 @@
 // <auto-generated />
-// Generated by DotMake.CommandLine.SourceGeneration v2.8.0.0
+// Generated by DotMake.CommandLine.SourceGeneration v2.8.1.0
 // Roslyn (Microsoft.CodeAnalysis) v4.1400.25.41305
 // Generation: 1