Add validation to options and use CommandException instead of custom one

Author: edumserrano

GitHubIssueFormsParser/.editorconfig

@@ -143,6 +143,9 @@ dotnet_diagnostic.IDE0061.severity = silent             # Use expression body fo
 # Expression-level preferences
 csharp_style_implicit_object_creation_when_type_is_apparent = false:silent
 dotnet_diagnostic.IDE0090.severity = suggestion
+# Expression-level preferences
+dotnet_diagnostic.IDE0046.severity = silent
+
 
 ##########################################
 # Unnecessary Code Rules

GitHubIssueFormsParser/src/GitHubIssuesParserCli/CliCommands/ParseGitHubIssueFormCommandException.cs

@@ -0,0 +1,13 @@
+namespace GitHubIssuesParserCli.CliCommands.ParseIssueForm.OptionValidators;
+
+#pragma warning disable CA1812 // Avoid uninstantiated internal classes. Referenced via typeof(IssueFormBodyOptionValidator) usage
+internal class IssueFormBodyOptionValidator : BindingValidator<string>
+{
+    public override BindingValidationError? Validate(string? value)
+    {
+        return string.IsNullOrWhiteSpace(value)
+            ? new BindingValidationError("Cannot be null or whitespace.")
+            : null;
+    }
+}
+#pragma warning restore CA1812 // Avoid uninstantiated internal classes. Referenced via typeof(TemplateFilepathOptionValidator) usage

GitHubIssueFormsParser/src/GitHubIssuesParserCli/CliCommands/ParseIssueForm/OptionValidators/IssueFormBodyOptionValidator.cs

@@ -0,0 +1,18 @@
+namespace GitHubIssuesParserCli.CliCommands.ParseIssueForm.OptionValidators;
+
+#pragma warning disable CA1812 // Avoid uninstantiated internal classes. Referenced via typeof(TemplateFilepathOptionValidator) usage
+internal class TemplateFilepathOptionValidator : BindingValidator<string>
+{
+    public override BindingValidationError? Validate(string? value)
+    {
+        if (string.IsNullOrWhiteSpace(value))
+        {
+            return new BindingValidationError("Cannot be null or whitespace.");
+        }
+
+        return !File.Exists(value)
+            ? new BindingValidationError("File does not exist.")
+            : null;
+    }
+}
+#pragma warning restore CA1812 // Avoid uninstantiated internal classes. Referenced via typeof(TemplateFilepathOptionValidator) usage

GitHubIssueFormsParser/src/GitHubIssuesParserCli/CliCommands/ParseIssueForm/OptionValidators/IssueFormYamlTemplateOptionValidator.cs

@@ -1,12 +1,22 @@
-namespace GitHubIssuesParserCli.CliCommands;
+namespace GitHubIssuesParserCli.CliCommands.ParseIssueForm;
 
 [Command("parse-issue-form")]
 public class ParseIssueFormCommand : ICommand
 {
-    [CommandOption("issue-body", 'i', IsRequired = true, Description = "The body of the GitHub issue form.")]
+    [CommandOption(
+        "issue-body",
+        'i',
+        IsRequired = true,
+        Validators = new Type[] { typeof(IssueFormBodyOptionValidator) },
+        Description = "The body of the GitHub issue form.")]
     public string IssueFormBody { get; init; } = default!;
 
-    [CommandOption("template-filepath", 't', IsRequired = true, Description = "The filepath for the GitHub issue form YAML template.")]
+    [CommandOption(
+        "template-filepath",
+        't',
+        IsRequired = true,
+        Validators = new Type[] { typeof(TemplateFilepathOptionValidator) },
+        Description = "The filepath for the GitHub issue form YAML template.")]
     public string TemplateFilepath { get; init; } = default!;
 
     public async ValueTask ExecuteAsync(IConsole console)
@@ -27,7 +37,10 @@ public async ValueTask ExecuteAsync(IConsole console)
         }
         catch (Exception e)
         {
-            throw new ParseGitHubIssueFormCommandException(e);
+            var message = @$"An error occurred trying to execute the command to parse a GitHub issue form.
+Error:
+- {e.Message}";
+            throw new CommandException(message, innerException: e);
         }
     }
 }

…Cli/CliCommands/ParseIssueFormCommand.cs …/ParseIssueForm/ParseIssueFormCommand.csGitHubIssueFormsParser/src/GitHubIssuesParserCli/CliCommands/ParseIssueFormCommand.cs renamed to GitHubIssueFormsParser/src/GitHubIssuesParserCli/CliCommands/ParseIssueForm/ParseIssueFormCommand.cs GitHubIssueFormsParser/src/GitHubIssuesParserCli/CliCommands/ParseIssueFormCommand.cs renamed to GitHubIssueFormsParser/src/GitHubIssuesParserCli/CliCommands/ParseIssueForm/ParseIssueFormCommand.cs

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <OutputType>Exe</OutputType>

GitHubIssueFormsParser/src/GitHubIssuesParserCli/GitHubIssuesParserCli.csproj

@@ -4,8 +4,11 @@
 global using System.Text.Json.Serialization;
 global using CliFx;
 global using CliFx.Attributes;
+global using CliFx.Exceptions;
+global using CliFx.Extensibility;
 global using CliFx.Infrastructure;
 global using GitHubIssuesParserCli.ArgumentValidations;
+global using GitHubIssuesParserCli.CliCommands.ParseIssueForm.OptionValidators;
 global using GitHubIssuesParserCli.IssueFormBody;
 global using GitHubIssuesParserCli.IssueFormBody.IssueFormItems;
 global using GitHubIssuesParserCli.IssueFormBody.IssueFormItems.Checkboxes;
@@ -15,4 +18,5 @@
 global using GitHubIssuesParserCli.IssueFormTemplates;
 global using GitHubIssuesParserCli.IssueFormTemplates.Parsing;
 global using SlugGenerator;
+global using YamlDotNet.Core;
 global using YamlDotNet.Serialization;

GitHubIssueFormsParser/src/GitHubIssuesParserCli/GlobalUsings.cs

@@ -5,10 +5,7 @@ internal static class IssueFormYamlTemplateParser
     public static IssueFormYamlTemplate Parse(IssueFormYamlTemplateText yamlTemplate)
     {
         yamlTemplate.NotNull();
-        var deserializer = new DeserializerBuilder()
-            .IgnoreUnmatchedProperties()
-            .Build();
-        var templateDto = deserializer.Deserialize<IssueFormYamlTemplateDto>(yamlTemplate);
+        var templateDto = DeserializeYaml(yamlTemplate);
         if (templateDto?.Body is null)
         {
             throw IssueFormYamlTemplateParserException.InvalidYmlTemplate();
@@ -37,4 +34,19 @@ public static IssueFormYamlTemplate Parse(IssueFormYamlTemplateText yamlTemplate
             .ToList();
         return new IssueFormYamlTemplate(items);
     }
+
+    public static IssueFormYamlTemplateDto? DeserializeYaml(this string yamlTemplate)
+    {
+        try
+        {
+            var deserializer = new DeserializerBuilder()
+                .IgnoreUnmatchedProperties()
+                .Build();
+            return deserializer.Deserialize<IssueFormYamlTemplateDto>(yamlTemplate);
+        }
+        catch (YamlException)
+        {
+            return null;
+        }
+    }
 }

GitHubIssueFormsParser/src/GitHubIssuesParserCli/IssueFormTemplates/Parsing/IssueFormYamlTemplateParser.cs

@@ -1,7 +1,8 @@
 {
   "profiles": {
     "GitHubIssuesParserCli": {
-      "commandName": "Project"
+      "commandName": "Project",
+      "commandLineArgs": "parse-issue-form --issue-body some --template-filepath D:/Dev/edumserrano/github-issue-forms-parser/GitHubIssueFormsParser/src/GitHubIssuesParserCli/bin/Debug/net6.0/test.txt"
     }
   }
 }

GitHubIssueFormsParser/src/GitHubIssuesParserCli/Properties/launchSettings.json

@@ -38,11 +38,12 @@ public async Task ParseIssueFormCommandTest1()
 
     /// <summary>
     /// Tests that the <see cref="ParseIssueFormCommand"/> produces the expected JSON output
-    /// when the line endings are only newLine.
+    /// regardless of the line endings on the issue form body.
     /// </summary>
     [Theory]
     [InlineData(CR)]
     [InlineData(LF)]
+    [InlineData(CR + LF)]
     public async Task ParseIssueFormCommandTest2(string newLine)
     {
         var issueFormBody = $"### What NuGet package do you want to release?{newLine}{newLine}dotnet-sdk-extensions{newLine}{newLine}### What is the new version for the NuGet package?{newLine}{newLine}1.0.13-alpha{newLine}{newLine}### Auto-generate release notes?{newLine}{newLine}Yes{newLine}{newLine}### Push to NuGet.org?{newLine}{newLine}_No response_{newLine}{newLine}### Custom release notes?{newLine}{newLine}## Custom release notes {newLine}{newLine}Test 123{newLine}{newLine}Another line:{newLine}- point 1{newLine}- point 2{newLine}- point 3{newLine}{newLine}### Which operating systems have you used?{newLine}{newLine}- [X] macOS{newLine}- [X] Windows{newLine}- [ ] Linux{newLine}- [ ] I don't know{newLine}";