Update version

Changelog.md

@@ -1,3 +1,17 @@
+### v2.0.3 (09-Apr-2021)
+
+- Improved help text by showing valid values for non-scalar enum parameters and options. (Thanks [@Robert Dailey](https://github.com/rcdailey))
+
+### v2.0.2 (31-Mar-2021)
+
+- Fixed an issue where having a transitive reference to CliFx sometimes resulted in `SystemConsoleShouldBeAvoidedAnalyzer` throwing `NullReferenceException` during build.
+- Fixed some documentation typos and inconsistencies.
+
+### v2.0.1 (24-Mar-2021)
+
+- Fixed an issue where some exceptions with async stack traces generated on .NET 3.1 or earlier were not parsed and formatted correctly.
+- Fixed an issue where help text applied slightly incorrect formatting when displaying choices for enum-based parameters and properties.
+
 ### v2.0 (21-Mar-2021)
 
 > Note: this major release includes many breaking changes.

CliFx.Analyzers.Tests/SystemConsoleShouldBeAvoidedAnalyzerSpecs.cs

@@ -104,5 +104,24 @@ public class MyCommand : ICommand
             // Act & assert
             Analyzer.Should().NotProduceDiagnostics(code);
         }
+
+        [Fact]
+        public void Analyzer_does_not_report_an_error_if_a_command_does_not_access_SystemConsole()
+        {
+            // Arrange
+            // language=cs
+            const string code = @"
+[Command]
+public class MyCommand : ICommand
+{
+    public ValueTask ExecuteAsync(IConsole console)
+    {
+        return default;
+    }
+}";
+
+            // Act & assert
+            Analyzer.Should().NotProduceDiagnostics(code);
+        }
     }
 }

CliFx.Analyzers/OptionMustBeInsideCommandAnalyzer.cs

@@ -22,6 +22,9 @@ namespace CliFx.Analyzers
             PropertyDeclarationSyntax propertyDeclaration,
             IPropertySymbol property)
         {
+            if (property.ContainingType is null)
+                return;
+
             if (property.ContainingType.IsAbstract)
                 return;
 

CliFx.Analyzers/OptionMustHaveUniqueNameAnalyzer.cs

@@ -23,6 +23,9 @@ namespace CliFx.Analyzers
             PropertyDeclarationSyntax propertyDeclaration,
             IPropertySymbol property)
         {
+            if (property.ContainingType is null)
+                return;
+
             var option = CommandOptionSymbol.TryResolve(property);
             if (option is null)
                 return;

CliFx.Analyzers/OptionMustHaveUniqueShortNameAnalyzer.cs

@@ -22,6 +22,9 @@ namespace CliFx.Analyzers
             PropertyDeclarationSyntax propertyDeclaration,
             IPropertySymbol property)
         {
+            if (property.ContainingType is null)
+                return;
+
             var option = CommandOptionSymbol.TryResolve(property);
             if (option is null)
                 return;

CliFx.Analyzers/ParameterMustBeInsideCommandAnalyzer.cs

@@ -22,6 +22,9 @@ namespace CliFx.Analyzers
             PropertyDeclarationSyntax propertyDeclaration,
             IPropertySymbol property)
         {
+            if (property.ContainingType is null)
+                return;
+
             if (property.ContainingType.IsAbstract)
                 return;
 

CliFx.Analyzers/ParameterMustBeLastIfNonScalarAnalyzer.cs

@@ -29,6 +29,9 @@ namespace CliFx.Analyzers
             PropertyDeclarationSyntax propertyDeclaration,
             IPropertySymbol property)
         {
+            if (property.ContainingType is null)
+                return;
+
             if (IsScalar(property.Type))
                 return;
 

CliFx.Analyzers/ParameterMustBeSingleIfNonScalarAnalyzer.cs

@@ -29,6 +29,9 @@ namespace CliFx.Analyzers
             PropertyDeclarationSyntax propertyDeclaration,
             IPropertySymbol property)
         {
+            if (property.ContainingType is null)
+                return;
+
             if (!CommandParameterSymbol.IsParameterProperty(property))
                 return;
 

CliFx.Analyzers/ParameterMustHaveUniqueNameAnalyzer.cs

@@ -23,6 +23,9 @@ namespace CliFx.Analyzers
             PropertyDeclarationSyntax propertyDeclaration,
             IPropertySymbol property)
         {
+            if (property.ContainingType is null)
+                return;
+
             var parameter = CommandParameterSymbol.TryResolve(property);
             if (parameter is null)
                 return;

CliFx.Analyzers/ParameterMustHaveUniqueOrderAnalyzer.cs

@@ -22,6 +22,9 @@ namespace CliFx.Analyzers
             PropertyDeclarationSyntax propertyDeclaration,
             IPropertySymbol property)
         {
+            if (property.ContainingType is null)
+                return;
+
             var parameter = CommandParameterSymbol.TryResolve(property);
             if (parameter is null)
                 return;

CliFx.Analyzers/SystemConsoleShouldBeAvoidedAnalyzer.cs

@@ -27,9 +27,9 @@ namespace CliFx.Analyzers
 
             while (currentNode is MemberAccessExpressionSyntax memberAccess)
             {
-                var symbol = context.SemanticModel.GetSymbolInfo(memberAccess).Symbol;
+                var member = context.SemanticModel.GetSymbolInfo(memberAccess).Symbol;
 
-                if (symbol is not null && symbol.ContainingType.DisplayNameMatches("System.Console"))
+                if (member?.ContainingType?.DisplayNameMatches("System.Console") == true)
                 {
                     return memberAccess;
                 }
@@ -53,7 +53,8 @@ namespace CliFx.Analyzers
                 return;
 
             // Check if IConsole is available in scope as an alternative to System.Console
-            var isConsoleInterfaceAvailable = context.Node
+            var isConsoleInterfaceAvailable = context
+                .Node
                 .Ancestors()
                 .OfType<MethodDeclarationSyntax>()
                 .SelectMany(m => m.ParameterList.Parameters)

CliFx.Analyzers/Utils/Extensions/RoslynExtensions.cs

@@ -9,11 +9,16 @@ namespace CliFx.Analyzers.Utils.Extensions
     internal static class RoslynExtensions
     {
         public static bool DisplayNameMatches(this ISymbol symbol, string name) =>
-            string.Equals(symbol.ToDisplayString(), name, StringComparison.Ordinal);
+            string.Equals(
+                // Fully qualified name, without `global::`
+                symbol.ToDisplayString(SymbolDisplayFormat.CSharpErrorMessageFormat),
+                name,
+                StringComparison.Ordinal
+            );
 
         public static void HandleClassDeclaration(
             this AnalysisContext analysisContext,
-            Action<SyntaxNodeAnalysisContext, ClassDeclarationSyntax, ITypeSymbol> handler)
+            Action<SyntaxNodeAnalysisContext, ClassDeclarationSyntax, ITypeSymbol> analyze)
         {
             analysisContext.RegisterSyntaxNodeAction(ctx =>
             {
@@ -24,13 +29,13 @@ namespace CliFx.Analyzers.Utils.Extensions
                 if (type is null)
                     return;
 
-                handler(ctx, classDeclaration, type);
+                analyze(ctx, classDeclaration, type);
             }, SyntaxKind.ClassDeclaration);
         }
 
         public static void HandlePropertyDeclaration(
             this AnalysisContext analysisContext,
-            Action<SyntaxNodeAnalysisContext, PropertyDeclarationSyntax, IPropertySymbol> handler)
+            Action<SyntaxNodeAnalysisContext, PropertyDeclarationSyntax, IPropertySymbol> analyze)
         {
             analysisContext.RegisterSyntaxNodeAction(ctx =>
             {
@@ -41,7 +46,7 @@ namespace CliFx.Analyzers.Utils.Extensions
                 if (property is null)
                     return;
 
-                handler(ctx, propertyDeclaration, property);
+                analyze(ctx, propertyDeclaration, property);
             }, SyntaxKind.PropertyDeclaration);
         }
     }

CliFx.Tests/HelpTextSpecs.cs

@@ -577,6 +577,51 @@ public class Command : ICommand
             );
         }
 
+        [Fact]
+        public async Task Help_text_shows_all_valid_values_for_non_scalar_enum_parameters_and_options()
+        {
+            // Arrange
+            var commandType = DynamicCommandBuilder.Compile(
+                // language=cs
+                @"
+public enum CustomEnum { One, Two, Three }
+
+[Command]
+public class Command : ICommand
+{
+    [CommandParameter(0)]
+    public List<CustomEnum> Foo { get; set; }
+
+    [CommandOption(""bar"")]
+    public List<CustomEnum> Bar { get; set; }
+
+    public ValueTask ExecuteAsync(IConsole console) => default;
+}
+");
+
+            var application = new CliApplicationBuilder()
+                .AddCommand(commandType)
+                .UseConsole(FakeConsole)
+                .Build();
+
+            // Act
+            var exitCode = await application.RunAsync(
+                new[] {"--help"},
+                new Dictionary<string, string>()
+            );
+
+            var stdOut = FakeConsole.ReadOutputString();
+
+            // Assert
+            exitCode.Should().Be(0);
+            stdOut.Should().ContainAllInOrder(
+                "PARAMETERS",
+                "foo", "Choices:", "One", "Two", "Three",
+                "OPTIONS",
+                "--bar", "Choices:", "One", "Two", "Three"
+            );
+        }
+
         [Fact]
         public async Task Help_text_shows_environment_variables_for_options_that_have_them_configured_as_fallback()
         {
@@ -875,4 +920,4 @@ public class SecondCommandSecondChildCommand : ICommand
             stdOut.Trim().Should().Be("v6.9");
         }
     }
-}
+}

CliFx/ApplicationMetadata.cs

@@ -16,7 +16,7 @@
         public string ExecutableName { get; }
 
         /// <summary>
-        /// Application version text.
+        /// Application version.
         /// </summary>
         public string Version { get; }
 

CliFx/Attributes/CommandAttribute.cs

@@ -6,7 +6,7 @@ namespace CliFx.Attributes
     /// Annotates a type that defines a command.
     /// </summary>
     [AttributeUsage(AttributeTargets.Class, Inherited = false)]
-    public class CommandAttribute : Attribute
+    public sealed class CommandAttribute : Attribute
     {
         /// <summary>
         /// Command's name.

CliFx/Attributes/CommandOptionAttribute.cs

@@ -7,7 +7,7 @@ namespace CliFx.Attributes
     /// Annotates a property that defines a command option.
     /// </summary>
     [AttributeUsage(AttributeTargets.Property)]
-    public class CommandOptionAttribute : Attribute
+    public sealed class CommandOptionAttribute : Attribute
     {
         /// <summary>
         /// Option name.

CliFx/Attributes/CommandParameterAttribute.cs

@@ -7,7 +7,7 @@ namespace CliFx.Attributes
     /// Annotates a property that defines a command parameter.
     /// </summary>
     [AttributeUsage(AttributeTargets.Property)]
-    public class CommandParameterAttribute : Attribute
+    public sealed class CommandParameterAttribute : Attribute
     {
         /// <summary>
         /// Parameter order.

CliFx/CliApplication.cs

@@ -99,7 +99,7 @@ namespace CliFx
             // Handle preview directive
             if (IsPreviewModeEnabled(commandInput))
             {
-                _console.WriteCommandInput(commandInput);
+                _console.Output.WriteCommandInput(commandInput);
                 return 0;
             }
 
@@ -125,7 +125,7 @@ namespace CliFx
             // Handle help option
             if (ShouldShowHelpText(commandSchema, commandInput))
             {
-                _console.WriteHelpText(helpContext);
+                _console.Output.WriteHelpText(helpContext);
                 return 0;
             }
 
@@ -150,12 +150,12 @@ namespace CliFx
             }
             catch (CliFxException ex)
             {
-                _console.WriteException(ex);
+                _console.Error.WriteException(ex);
 
                 if (ex.ShowHelp)
                 {
                     _console.Output.WriteLine();
-                    _console.WriteHelpText(helpContext);
+                    _console.Output.WriteHelpText(helpContext);
                 }
 
                 return ex.ExitCode;
@@ -200,7 +200,7 @@ namespace CliFx
             // developer, so we don't swallow them in that case.
             catch (Exception ex) when (!Debugger.IsAttached)
             {
-                _console.WriteException(ex);
+                _console.Error.WriteException(ex);
                 return 1;
             }
         }

CliFx/CliApplicationBuilder.cs

@@ -37,7 +37,7 @@ namespace CliFx
         }
 
         /// <summary>
-        /// Adds a command the application.
+        /// Adds a command to the application.
         /// </summary>
         public CliApplicationBuilder AddCommand<TCommand>() where TCommand : ICommand =>
             AddCommand(typeof(TCommand));

CliFx/CliFx.csproj

@@ -28,20 +28,10 @@
     <PackageReference Include="System.Threading.Tasks.Extensions" Version="4.5.4" />
   </ItemGroup>
 
-  <!-- The following elements are responsible for embedding the analyzer assembly within the output NuGet package -->
-
+  <!-- Pack the analyzer assembly inside the package -->
   <ItemGroup>
-    <ProjectReference Include="..\CliFx.Analyzers\CliFx.Analyzers.csproj" ReferenceOutputAssembly="true" IncludeAssets="CliFx.Analyzers.dll" />
+    <ProjectReference Include="../CliFx.Analyzers/CliFx.Analyzers.csproj" ReferenceOutputAssembly="false" OutputItemType="Analyzer" />
+    <None Include="../CliFx.Analyzers/bin/$(Configuration)/netstandard2.0/CliFx.Analyzers.dll" Pack="true" PackagePath="analyzers/dotnet/cs" Visible="false" />
   </ItemGroup>
 
-  <PropertyGroup>
-    <TargetsForTfmSpecificContentInPackage>$(TargetsForTfmSpecificContentInPackage);CopyAnalyzerToPackage</TargetsForTfmSpecificContentInPackage>
-  </PropertyGroup>
-
-  <Target Name="CopyAnalyzerToPackage">
-    <ItemGroup>
-      <TfmSpecificPackageFile Include="$(OutDir)/CliFx.Analyzers.dll" PackagePath="analyzers/dotnet/cs" BuildAction="none" />
-    </ItemGroup>
-  </Target>
-
 </Project>

CliFx/Formatting/CommandInputConsoleFormatter.cs

@@ -93,7 +93,7 @@ namespace CliFx.Formatting
 
     internal static class CommandInputConsoleFormatterExtensions
     {
-        public static void WriteCommandInput(this IConsole console, CommandInput commandInput) =>
-            new CommandInputConsoleFormatter(console.Output).WriteCommandInput(commandInput);
+        public static void WriteCommandInput(this ConsoleWriter consoleWriter, CommandInput commandInput) =>
+            new CommandInputConsoleFormatter(consoleWriter).WriteCommandInput(commandInput);
     }
 }

CliFx/Formatting/ExceptionConsoleFormatter.cs

@@ -129,7 +129,7 @@ namespace CliFx.Formatting
 
     internal static class ExceptionConsoleFormatterExtensions
     {
-        public static void WriteException(this IConsole console, Exception exception) =>
-            new ExceptionConsoleFormatter(console.Error).WriteException(exception);
+        public static void WriteException(this ConsoleWriter consoleWriter, Exception exception) =>
+            new ExceptionConsoleFormatter(consoleWriter).WriteException(exception);
     }
 }

CliFx/Formatting/HelpConsoleFormatter.cs

@@ -191,7 +191,7 @@ namespace CliFx.Formatting
                         }
 
                         Write(ConsoleColor.DarkGray, '"');
-                        Write(ConsoleColor.White, validValue.ToString());
+                        Write(validValue.ToString());
                         Write(ConsoleColor.DarkGray, '"');
                     }
 
@@ -270,7 +270,7 @@ namespace CliFx.Formatting
                         }
 
                         Write(ConsoleColor.DarkGray, '"');
-                        Write(ConsoleColor.White, validValue.ToString());
+                        Write(validValue.ToString());
                         Write(ConsoleColor.DarkGray, '"');
                     }
 
@@ -443,7 +443,7 @@ namespace CliFx.Formatting
 
     internal static class HelpConsoleFormatterExtensions
     {
-        public static void WriteHelpText(this IConsole console, HelpContext context) =>
-            new HelpConsoleFormatter(console.Output, context).WriteHelpText();
+        public static void WriteHelpText(this ConsoleWriter consoleWriter, HelpContext context) =>
+            new HelpConsoleFormatter(consoleWriter, context).WriteHelpText();
     }
 }

CliFx/Infrastructure/IConsole.cs

@@ -70,12 +70,16 @@ namespace CliFx.Infrastructure
         /// Subsequent calls to this method have no side-effects and return the same token.
         /// </summary>
         /// <remarks>
+        /// <para>
         /// Calling this method effectively makes the command cancellation-aware, which
-        /// means that sending an interrupt signal won't immediately terminate the application,
+        /// means that sending the interrupt signal won't immediately terminate the application,
         /// but will instead trigger a token that the command can use to exit more gracefully.
-        ///
-        /// If the user sends a second interrupt signal after the first one, the application
-        /// will terminate immediately.
+        /// </para>
+        /// <para>
+        /// Note that the handler is only respected when the user sends the interrupt signal for the first time.
+        /// If the user decides to issue the signal again, the application will terminate immediately
+        /// regardless of whether the command is cancellation-aware.
+        /// </para>
         /// </remarks>
         CancellationToken RegisterCancellationHandler();
     }
@@ -116,16 +120,10 @@ namespace CliFx.Infrastructure
         public static IDisposable WithColors(
             this IConsole console,
             ConsoleColor foregroundColor,
-            ConsoleColor backgroundColor)
-        {
-            var foregroundColorRegistration = console.WithForegroundColor(foregroundColor);
-            var backgroundColorRegistration = console.WithBackgroundColor(backgroundColor);
-
-            return Disposable.Create(() =>
-            {
-                foregroundColorRegistration.Dispose();
-                backgroundColorRegistration.Dispose();
-            });
-        }
+            ConsoleColor backgroundColor) =>
+            Disposable.Merge(
+                console.WithForegroundColor(foregroundColor),
+                console.WithBackgroundColor(backgroundColor)
+            );
     }
 }

CliFx/Schema/BindablePropertyDescriptor.cs

@@ -21,7 +21,10 @@ namespace CliFx.Schema
 
         public IReadOnlyList<object?> GetValidValues()
         {
-            var underlyingType = Type.TryGetNullableUnderlyingType() ?? Type;
+            var underlyingType =
+                Type.TryGetNullableUnderlyingType() ??
+                Type.TryGetEnumerableUnderlyingType() ??
+                Type;
 
             // We can only get valid values for enums
             if (underlyingType.IsEnum)
@@ -30,4 +33,4 @@ namespace CliFx.Schema
             return Array.Empty<object?>();
         }
     }
-}
+}

CliFx/Utils/Disposable.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Generic;
 
 namespace CliFx.Utils
 {
@@ -14,5 +15,14 @@ namespace CliFx.Utils
     internal partial class Disposable
     {
         public static IDisposable Create(Action dispose) => new Disposable(dispose);
+
+        public static IDisposable Merge(IEnumerable<IDisposable> disposables) => Create(() =>
+        {
+            foreach (var disposable in disposables)
+                disposable.Dispose();
+        });
+
+        public static IDisposable Merge(params IDisposable[] disposables) =>
+            Merge((IEnumerable<IDisposable>) disposables);
     }
 }

CliFx/Utils/StackFrame.cs

@@ -91,12 +91,7 @@ namespace CliFx.Utils
         {
             var matches = Pattern.Matches(stackTrace).Cast<Match>().ToArray();
 
-            // Ensure success (all lines should be parsed)
-            var isSuccess =
-                matches.Length ==
-                stackTrace.Split('\n', StringSplitOptions.RemoveEmptyEntries).Length;
-
-            if (!isSuccess)
+            if (matches.Length <= 0 || matches.Any(m => !m.Success))
             {
                 // If parsing fails, we include the original stacktrace in the
                 // exception so that it's shown to the user.

Directory.Build.props

@@ -1,7 +1,7 @@
 <Project>
 
   <PropertyGroup>
-    <Version>2.0</Version>
+    <Version>2.0.3</Version>
     <Company>Tyrrrz</Company>
     <Copyright>Copyright (C) Alexey Golub</Copyright>
     <LangVersion>latest</LangVersion>

Readme.md

@@ -129,7 +129,8 @@ public class LogCommand : ICommand
     [CommandParameter(0, Description = "Value whose logarithm is to be found.")]
     public double Value { get; init; }
 
-    // Name: --base | Short name: -b
+    // Name: --base
+    // Short name: -b
     [CommandOption("base", 'b', Description = "Logarithm base.")]
     public double Base { get; init; } = 10;