Update version

Closes #135

Changelog.md

@@ -1,28 +1,38 @@
-### v2.3.1 (08-Dec-2022)
+# Changelog
+
+## v2.3.3 (28-Apr-2023)
+
+- Fixed an issue where the analyzers failed to load in some projects, due to targeting a Roslyn version that was too high.
+
+## v2.3.2 (06-Apr-2023)
+
+- Added name-based ordering to subcommands when displayed in the help text. (Thanks [@CartBlanche](https://github.com/CartBlanche))
+
+## v2.3.1 (08-Dec-2022)
 
 - Added support for the `required` keyword introduced in C# 11. Command options bound to required properties are now marked as required by default (equivalent to setting `IsRequired = true` on the attribute). Also added analyzers that prevent marking an option or parameter non-required if it's bound to a required property.
 
-### v2.3 (12-Jul-2022)
+## v2.3 (12-Jul-2022)
 
 - Added console dimension properties `WindowWidth` and `WindowHeight` to `IConsole` interface and implementing classes.
 - Improved inline documentation for members of `IConsole` interface.
 
-### v2.2.6 (14-Jun-2022)
+## v2.2.6 (14-Jun-2022)
 
 - Added an overload of `CliApplicationBuilder.UseTypeActivator(...)` that accepts an instance of `IServiceProvider`. This slightly simplifies integration with many DI containers.
 - Fixed minor grammar mistakes in user-facing error messages.
 
-### v2.2.5 (10-May-2022)
+## v2.2.5 (10-May-2022)
 
 - Updated default value resolution for the application executable name. It will now resolve to `myapp.exe` instead of `dotnet myapp.dll` when the application is launched through the EXE apphost on Windows. On other platforms, or when running the application through the .NET CLI, the behavior will be the same as before.
 
-### v2.2.4 (22-Apr-2022)
+## v2.2.4 (22-Apr-2022)
 
 - Added more contextual information to analyzer diagnostics.
 - Fixed an issue where the analyzer incorrectly reported an error on converters that didn't directly match the target type but were compatible through known built-in conversions.
 - Fixed an issue where MSBuild produced a lot of analyzer-related warnings in certain circumstances.
 
-### v2.2.3 (17-Apr-2022)
+## v2.2.3 (17-Apr-2022)
 
 - Changed method signature of `IConsole.ReadKey()` to return `ConsoleKeyInfo` instead of `void`. The return type was originally defined as `void` by mistake. This change is source-backwards-compatible but may break on binary level if you were previously calling this method indirectly (i.e. through a library).
 - Added `FakeConsole.EnqueueKey(...)` to facilitate the testing of `IConsole.ReadKey()`. You can use this method to simulate key presses in your application.
@@ -30,57 +40,57 @@
 - Improved diagnostics produced by analyzers. Where relevant, highlighted code is now limited to the property or type identifier, instead of the whole property or type declaration. Also extended the diagnostic messages with additional information.
 - Fixed an issue where throwing an exception inside a constructor of a command type resulted in an unrelated error message about the absence of a parameterless constructor.
 
-### v2.2.2 (30-Jan-2022)
+## v2.2.2 (30-Jan-2022)
 
 - Fixed an issue where `ConsoleWriter` and `ConsoleReader` were not properly thread-safe.
 - Fixed an issue where the analyzer failed to load under certain circumstances when running inside Visual Studio.
 
-### v2.2.1 (16-Jan-2022)
+## v2.2.1 (16-Jan-2022)
 
 - Fixed an issue which caused help text to not show default values for optional parameters. (Thanks [@AliReZa Sabouri](https://github.com/alirezanet))
 
-### v2.2 (11-Jan-2022)
+## v2.2 (11-Jan-2022)
 
 - Added support for optional parameters. A parameter can be marked as optional by setting `IsRequired = false` on the attribute. Only one parameter is allowed to be optional and such parameter must be the last in order. (Thanks [@AliReZa Sabouri](https://github.com/alirezanet))
 - Fixed an issue where parameters and options bound to properties implemented as default interface members were not working correctly. (Thanks [@AliReZa Sabouri](https://github.com/alirezanet))
 
-### v2.1 (04-Jan-2022)
+## v2.1 (04-Jan-2022)
 
 - Added `IConsole.Clear()` with corresponding implementations in `SystemConsole`, `FakeConsole`, and `FakeInMemoryConsole`. (Thanks [@Alex Rosenfeld](https://github.com/alexrosenfeld10))
 - Added `IConsole.ReadKey()` with corresponding implementations in `SystemConsole`, `FakeConsole`, and `FakeInMemoryConsole`. (Thanks [@Alex Rosenfeld](https://github.com/alexrosenfeld10))
 - Fixed an issue that caused parameters to appear out of order in the usage format section of the help text. (Thanks [@David Fallah](https://github.com/TAGC))
 
-### v2.0.6 (17-Jul-2021)
+## v2.0.6 (17-Jul-2021)
 
 - Fixed an issue where an exception thrown via reflection during parameter or option binding resulted in `Exception has been thrown by the target of an invocation` error instead of a more useful message. Such exceptions will now be unwrapped to provide better user experience.
 
-### v2.0.5 (09-Jul-2021)
+## v2.0.5 (09-Jul-2021)
 
 - Fixed an issue where calling `IConsole.Output.Encoding.EncodingName` and some other members threw an exception.
 - Added readme file to the package.
 
-### v2.0.4 (24-Apr-2021)
+## v2.0.4 (24-Apr-2021)
 
 - Fixed an issue where output and error streams in `SystemConsole` defaulted to UTF8 encoding with BOM when the application was running with UTF8 codepage. `ConsoleWriter` will now discard preamble from the specified encoding. This fix brings the behavior of `SystemConsole` in line with .NET's own `System.Console` which also discards preamble for output and error streams.
 - Fixed an issue where help text tried to show default values for parameters and options whose type does not override `ToString()` method.
 - Fixed an issue where help text didn't show default values for parameters and options whose type is an enumerable of nullable enums. (Thanks [@Robert Dailey](https://github.com/rcdailey))
 - Fixed an issue where specific parts of the help text weren't legible in some terminals due to low color resolution. Removed the usage of `ConsoleColor.DarkGray` in help text.
 
-### v2.0.3 (09-Apr-2021)
+## 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)
+## 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)
+## 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)
+## v2.0 (21-Mar-2021)
 
 > Note: this major release includes many breaking changes.
 > Please refer to the readme to find updated instructions and usage examples.
@@ -100,7 +110,7 @@
   - Assigned separate colors to parameters and options to make them visually stand out
   - Usage section no longer lists usage formats of all descendant commands
   - Command section now also lists available subcommands for each of the current command's subcommands
-- Changed the behavior of `[preview]` directive. Running the application with this directive will now also print all resolved environment variables, in addition to parsed command line arguments.
+- Changed the behavior of `[preview]` directive. Running the application with this directive will now also print all resolved environment variables, in addition to parsed command-line arguments.
 - Reworked `IArgumentValueConverter`/`ArgumentValueConverter` into `BindingConverter`. Method `ConvertFrom(...)` has been renamed to `Convert(...)`.
 - Reworked `ArgumentValueValidator` into `BindingValidator`. This class exposes an abstract `Validate(...)` method that returns a nullable `BindingValidationError`. This class also provides utility methods `Ok()` and `Error(...)` to help create corresponding validation results.
 - Changed the type of `IConsole.Output` and `IConsole.Error` from `StreamWriter` to `ConsoleWriter`. This type derives from `StreamWriter` and additionally exposes a `Console` property that refers to the console instance that owns the stream. This change enables you to author extension methods scoped specifically to console output and error streams.
@@ -114,34 +124,34 @@
   - `ITypeActivator`/`DefaultTypeActivator`/`DelegateTypeActivator` moved from `CliFx` to `CliFx.Infrastructure`
   - `BindingValidator`/`BindingConverter` moved from `CliFx` to `CliFx.Extensibility`
 
-### v1.6 (06-Dec-2020)
+## v1.6 (06-Dec-2020)
 
 - Added support for custom value validators. You can now create a type that inherits from `CliFx.ArgumentValueValidator<T>` to implement reusable validation logic for command arguments. To use a validator, include it in the `Validators` property on the `CommandOption` or `CommandParameter` attribute. (Thanks [@Oleksandr Shustov](https://github.com/AlexandrShustov))
 - Added `CliFx.ArgumentValueConverter<T>` class that you can inherit from to implement custom value converters. `CliFx.IArgumentValueConverter` interface is still available, but it is recommended to inherit from the generic class instead, due to the type safety it provides. The interface may become internal or get removed in one of the future major versions.
 - Updated requirements for option names and short names: short names now must be letter characters (lowercase or uppercase), while names must now start with a letter character. This means option names can no longer start with a digit or a special character. This change makes it possible to pass negative number values without the need to quote them, i.e. `--my-number -5`.
 
-### v1.5 (23-Oct-2020)
+## v1.5 (23-Oct-2020)
 
 - Added pretty-printing for unhandled exceptions thrown from within the application. This makes the errors easier to parse visually and should help in troubleshooting. This change does not affect `CommandException`, as it already has special treatment. (Thanks [@Mårten Åsberg](https://github.com/89netraM))
 - Added support for custom value converters. You can now create a type that implements `CliFx.IArgumentValueConverter` and specify it as a converter for your parameters or options via the `Converter` named property. This should enable conversion between raw argument values and custom types which are not string-initializable. (Thanks [@Oleksandr Shustov](https://github.com/AlexandrShustov))
 - Improved help text so that it also shows minimal usage examples for child and descendant commands, besides the actual command it was requested on. This should improve user experience for applications with many nested commands. (Thanks [@Nikiforov Alexey](https://github.com/NikiforovAll))
 
-### v1.4 (20-Aug-2020)
+## v1.4 (20-Aug-2020)
 
 - Added `VirtualConsole.CreateBuffered()` method to simplify test setup when using in-memory backing stores for output and error streams. Please refer to the readme for updated recommendations on how to test applications built with CliFx.
 - Added generic `CliApplicationBuilder.AddCommand<TCommand>()`. This overload simplifies adding commands one-by-one as it also checks that the type implements `ICommand`.
 
-### v1.3.2 (31-Jul-2020)
+## v1.3.2 (31-Jul-2020)
 
 - Fixed an issue where a command was incorrectly allowed to execute when the user did not specify any value for a non-scalar parameter. Since they are always required, a parameter needs to be bound to at least one value. (Thanks [@Daniel Hix](https://github.com/ADustyOldMuffin))
 - Fixed an issue where `CliApplication.RunAsync(...)` threw `ArgumentException` if there were two environment variables, whose names differed only in case. Environment variable names are now treated case-sensitively. (Thanks [@Ron Myers](https://github.com/ron-myers))
 
-### v1.3.1 (19-Jul-2020)
+## v1.3.1 (19-Jul-2020)
 
 - Running the application with the debug directive (`myapp [debug]`) will now also try to launch a debugger instance. In most cases it will save time as you won't need to attach the debugger manually. (Thanks [@Volodymyr Shkolka](https://github.com/BlackGad))
 - Fixed an issue where unhandled generic exceptions (i.e. not `CommandException`) sometimes caused the application to incorrectly return successful exit code due to an overflow issue on Unix systems. Starting from this version, all unhandled generic exceptions will produce `1` as the exit code when thrown. Instances of `CommandException` can still be configured to return any specified exit code, but it's recommended to constrain the values between `1` and `255` to avoid overflow issues. (Thanks [@Ihor Nechyporuk](https://github.com/inech))
 
-### v1.3 (23-May-2020)
+## v1.3 (23-May-2020)
 
 - Changed analyzers to report errors instead of warnings. If you find that some analyzer works incorrectly, please report it on GitHub. You can also configure inspection severity overrides in your project if you need to.
 - Improved help text by showing default values for non-required options. This only works on types that have a custom override for `ToString()` method. Additionally, if the type implements `IFormattable`, the overload with a format provider will be used instead. (Thanks [@Domn Werner](https://github.com/domn1995))
@@ -149,7 +159,7 @@
 - Fixed an issue where it was possible to define a command with an option that has the same name or short name as built-in help or version options. Previously it would lead to the user-defined option being ignored in favor of the built-in option. Now this will throw an exception instead.
 - Changed the underlying representation of `StreamReader`/`StreamWriter` objects used in `SystemConsole` and `VirtualConsole` to be thread-safe.
 
-### v1.2 (11-May-2020)
+## v1.2 (11-May-2020)
 
 - Added built-in Roslyn analyzers that help catch incorrect usage of the library. Currently, all analyzers report issues as warnings so as to not prevent the project from building. In the future that may change.
 - Added an optional parameter to `new CommandException(...)` called `showHelp` which can be used to instruct CliFx to show help for the current command after printing the error. (Thanks [@Domn Werner](https://github.com/domn1995))
@@ -160,7 +170,7 @@
 - Improved exception messages.
 - Improved exceptions related to user input by also showing help text after the error message. (Thanks [@Domn Werner](https://github.com/domn1995))
 
-### v1.1 (16-Mar-2020)
+## v1.1 (16-Mar-2020)
 
 - Changed `IConsole` interface (and as a result, `SystemConsole` and `VirtualConsole`) to support writing binary data. Instead of `TextReader`/`TextWriter` instances, the streams are now exposed as `StreamReader`/`StreamWriter` which provide the `BaseStream` property that allows raw access. Existing usages inside commands should remain the same because `StreamReader`/`StreamWriter` are compatible with their base classes `TextReader`/`TextWriter`, but if you were using `VirtualConsole` in tests, you may have to update it to the new API. Refer to the readme for more info.
 - Changed argument binding behavior so that an error is produced if the user provides an argument that doesn't match with any parameter or option. This is done in order to improve user experience, as otherwise the user may make a typo without knowing that their input wasn't taken into account.

CliFx.Analyzers.Tests/CliFx.Analyzers.Tests.csproj

@@ -10,10 +10,10 @@
 
   <ItemGroup>
     <PackageReference Include="Basic.Reference.Assemblies.Net70" Version="1.4.1" />
-    <PackageReference Include="GitHubActionsTestLogger" Version="2.0.1" PrivateAssets="all" />
-    <PackageReference Include="FluentAssertions" Version="6.8.0" />
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.4.0" />
-    <PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.4.0" />
+    <PackageReference Include="GitHubActionsTestLogger" Version="2.0.2" PrivateAssets="all" />
+    <PackageReference Include="FluentAssertions" Version="6.11.0" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.5.0" />
+    <PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.5.0" />
     <PackageReference Include="xunit" Version="2.4.2" />
     <PackageReference Include="xunit.runner.visualstudio" Version="2.4.5" PrivateAssets="all" />
     <PackageReference Include="coverlet.collector" Version="3.2.0" PrivateAssets="all" />

CliFx.Analyzers/CliFx.Analyzers.csproj

@@ -4,6 +4,7 @@
     <TargetFramework>netstandard2.0</TargetFramework>
     <CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies>
     <GenerateDependencyFile>true</GenerateDependencyFile>
+    <EnforceExtendedAnalyzerRules>true</EnforceExtendedAnalyzerRules>
     <NoWarn>$(NoWarn);RS1025;RS1026</NoWarn>
   </PropertyGroup>
 
@@ -16,7 +17,10 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.4.0" PrivateAssets="all" />
+    <!-- Make sure to target the lowest possible version of the compiler for wider support -->
+    <PackageReference Include="Microsoft.CodeAnalysis" Version="3.0.0" PrivateAssets="all" />
+    <PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="3.0.0" PrivateAssets="all" />
+    <PackageReference Include="PolyShim" Version="1.2.0" PrivateAssets="all" />
   </ItemGroup>
 
 </Project>

CliFx.Analyzers/OptionMustBeRequiredIfPropertyRequiredAnalyzer.cs

@@ -24,7 +24,7 @@ public class OptionMustBeRequiredIfPropertyRequiredAnalyzer : AnalyzerBase
         if (property.ContainingType is null)
             return;
 
-        if (!property.IsRequired)
+        if (!property.IsRequired())
             return;
 
         var option = CommandOptionSymbol.TryResolve(property);

CliFx.Analyzers/OptionMustHaveUniqueNameAnalyzer.cs

@@ -39,7 +39,7 @@ public class OptionMustHaveUniqueNameAnalyzer : AnalyzerBase
             .ContainingType
             .GetMembers()
             .OfType<IPropertySymbol>()
-            .Where(m => !m.Equals(property, SymbolEqualityComparer.Default))
+            .Where(m => !m.Equals(property))
             .ToArray();
 
         foreach (var otherProperty in otherProperties)

CliFx.Analyzers/OptionMustHaveUniqueShortNameAnalyzer.cs

@@ -38,7 +38,7 @@ public class OptionMustHaveUniqueShortNameAnalyzer : AnalyzerBase
             .ContainingType
             .GetMembers()
             .OfType<IPropertySymbol>()
-            .Where(m => !m.Equals(property, SymbolEqualityComparer.Default))
+            .Where(m => !m.Equals(property))
             .ToArray();
 
         foreach (var otherProperty in otherProperties)

CliFx.Analyzers/ParameterMustBeLastIfNonRequiredAnalyzer.cs

@@ -37,7 +37,7 @@ public class ParameterMustBeLastIfNonRequiredAnalyzer : AnalyzerBase
             .ContainingType
             .GetMembers()
             .OfType<IPropertySymbol>()
-            .Where(m => !m.Equals(property, SymbolEqualityComparer.Default))
+            .Where(m => !m.Equals(property))
             .ToArray();
 
         foreach (var otherProperty in otherProperties)

CliFx.Analyzers/ParameterMustBeLastIfNonScalarAnalyzer.cs

@@ -37,7 +37,7 @@ public class ParameterMustBeLastIfNonScalarAnalyzer : AnalyzerBase
             .ContainingType
             .GetMembers()
             .OfType<IPropertySymbol>()
-            .Where(m => !m.Equals(property, SymbolEqualityComparer.Default))
+            .Where(m => !m.Equals(property))
             .ToArray();
 
         foreach (var otherProperty in otherProperties)

CliFx.Analyzers/ParameterMustBeRequiredIfPropertyRequiredAnalyzer.cs

@@ -24,7 +24,7 @@ public class ParameterMustBeRequiredIfPropertyRequiredAnalyzer : AnalyzerBase
         if (property.ContainingType is null)
             return;
 
-        if (!property.IsRequired)
+        if (!property.IsRequired())
             return;
 
         var parameter = CommandParameterSymbol.TryResolve(property);

CliFx.Analyzers/ParameterMustBeSingleIfNonRequiredAnalyzer.cs

@@ -37,7 +37,7 @@ public class ParameterMustBeSingleIfNonRequiredAnalyzer : AnalyzerBase
             .ContainingType
             .GetMembers()
             .OfType<IPropertySymbol>()
-            .Where(m => !m.Equals(property, SymbolEqualityComparer.Default))
+            .Where(m => !m.Equals(property))
             .ToArray();
 
         foreach (var otherProperty in otherProperties)

CliFx.Analyzers/ParameterMustBeSingleIfNonScalarAnalyzer.cs

@@ -37,7 +37,7 @@ public class ParameterMustBeSingleIfNonScalarAnalyzer : AnalyzerBase
             .ContainingType
             .GetMembers()
             .OfType<IPropertySymbol>()
-            .Where(m => !m.Equals(property, SymbolEqualityComparer.Default))
+            .Where(m => !m.Equals(property))
             .ToArray();
 
         foreach (var otherProperty in otherProperties)

CliFx.Analyzers/ParameterMustHaveUniqueNameAnalyzer.cs

@@ -39,7 +39,7 @@ public class ParameterMustHaveUniqueNameAnalyzer : AnalyzerBase
             .ContainingType
             .GetMembers()
             .OfType<IPropertySymbol>()
-            .Where(m => !m.Equals(property, SymbolEqualityComparer.Default))
+            .Where(m => !m.Equals(property))
             .ToArray();
 
         foreach (var otherProperty in otherProperties)

CliFx.Analyzers/ParameterMustHaveUniqueOrderAnalyzer.cs

@@ -35,7 +35,7 @@ public class ParameterMustHaveUniqueOrderAnalyzer : AnalyzerBase
             .ContainingType
             .GetMembers()
             .OfType<IPropertySymbol>()
-            .Where(m => !m.Equals(property, SymbolEqualityComparer.Default))
+            .Where(m => !m.Equals(property))
             .ToArray();
 
         foreach (var otherProperty in otherProperties)

CliFx.Analyzers/Utils/Extensions/RoslynExtensions.cs

@@ -34,6 +34,17 @@ internal static class RoslynExtensions
         .FirstOrDefault(i => i.ConstructedFrom.SpecialType == SpecialType.System_Collections_Generic_IEnumerable_T)?
         .TypeArguments[0];
 
+    // Detect if the property is required through roundabout means so as to not have to take dependency
+    // on higher versions of the C# compiler.
+    public static bool IsRequired(this IPropertySymbol property) => property
+        // Can't rely on the RequiredMemberAttribute because it's generated by the compiler, not added by the user,
+        // so we have to check for the presence of the `required` modifier in the syntax tree instead.
+        .DeclaringSyntaxReferences
+        .Select(r => r.GetSyntax())
+        .OfType<PropertyDeclarationSyntax>()
+        .SelectMany(p => p.Modifiers)
+        .Any(m => m.IsKind((SyntaxKind)8447));
+
     public static bool IsAssignable(this Compilation compilation, ITypeSymbol source, ITypeSymbol destination) =>
         compilation.ClassifyConversion(source, destination).Exists;
 

CliFx.Analyzers/Utils/Extensions/StringExtensions.cs

@@ -10,7 +10,7 @@ internal static class StringExtensions
         StringComparison comparison = StringComparison.Ordinal)
     {
         while (str.EndsWith(sub, comparison))
-            str = str.Substring(0, str.Length - sub.Length);
+            str = str[..^sub.Length];
 
         return str;
     }

CliFx.Benchmarks/CliFx.Benchmarks.csproj

@@ -6,12 +6,12 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="BenchmarkDotNet" Version="0.13.2" />
+    <PackageReference Include="BenchmarkDotNet" Version="0.13.5" />
     <PackageReference Include="clipr" Version="1.6.1" />
-    <PackageReference Include="Cocona" Version="2.1.0" />
+    <PackageReference Include="Cocona" Version="2.2.0" />
     <PackageReference Include="CommandLineParser" Version="2.9.1" />
     <PackageReference Include="McMaster.Extensions.CommandLineUtils" Version="4.0.2" />
-    <PackageReference Include="PowerArgs" Version="4.0.0" />
+    <PackageReference Include="PowerArgs" Version="4.0.2" />
     <PackageReference Include="System.CommandLine" Version="2.0.0-beta1.20574.7" />
   </ItemGroup>
 

CliFx.Demo/CliFx.Demo.csproj

@@ -7,7 +7,6 @@
 
   <ItemGroup>
     <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="7.0.0" />
-    <PackageReference Include="Newtonsoft.Json" Version="13.0.2" />
   </ItemGroup>
 
   <ItemGroup>

CliFx.Demo/Domain/Book.cs

@@ -2,21 +2,4 @@
 
 namespace CliFx.Demo.Domain;
 
-public class Book
-{
-    public string Title { get; }
-
-    public string Author { get; }
-
-    public DateTimeOffset Published { get; }
-
-    public Isbn Isbn { get; }
-
-    public Book(string title, string author, DateTimeOffset published, Isbn isbn)
-    {
-        Title = title;
-        Author = author;
-        Published = published;
-        Isbn = isbn;
-    }
-}
+public record Book(string Title, string Author, DateTimeOffset Published, Isbn Isbn);

CliFx.Demo/Domain/Isbn.cs

@@ -2,32 +2,13 @@
 
 namespace CliFx.Demo.Domain;
 
-public partial class Isbn
+public partial record Isbn(int EanPrefix, int RegistrationGroup, int Registrant, int Publication, int CheckDigit)
 {
-    public int EanPrefix { get; }
-
-    public int RegistrationGroup { get; }
-
-    public int Registrant { get; }
-
-    public int Publication { get; }
-
-    public int CheckDigit { get; }
-
-    public Isbn(int eanPrefix, int registrationGroup, int registrant, int publication, int checkDigit)
-    {
-        EanPrefix = eanPrefix;
-        RegistrationGroup = registrationGroup;
-        Registrant = registrant;
-        Publication = publication;
-        CheckDigit = checkDigit;
-    }
-
     public override string ToString() =>
         $"{EanPrefix:000}-{RegistrationGroup:00}-{Registrant:00000}-{Publication:00}-{CheckDigit:0}";
 }
 
-public partial class Isbn
+public partial record Isbn
 {
     public static Isbn Parse(string value, IFormatProvider formatProvider)
     {

CliFx.Demo/Domain/Library.cs

@@ -4,15 +4,8 @@ using System.Linq;
 
 namespace CliFx.Demo.Domain;
 
-public partial class Library
+public partial record Library(IReadOnlyList<Book> Books)
 {
-    public IReadOnlyList<Book> Books { get; }
-
-    public Library(IReadOnlyList<Book> books)
-    {
-        Books = books;
-    }
-
     public Library WithBook(Book book)
     {
         var books = Books.ToList();
@@ -29,7 +22,7 @@ public partial class Library
     }
 }
 
-public partial class Library
+public partial record Library
 {
     public static Library Empty { get; } = new(Array.Empty<Book>());
 }

CliFx.Demo/Domain/LibraryProvider.cs

@@ -1,6 +1,6 @@
 using System.IO;
 using System.Linq;
-using Newtonsoft.Json;
+using System.Text.Json;
 
 namespace CliFx.Demo.Domain;
 
@@ -10,7 +10,7 @@ public class LibraryProvider
 
     private void StoreLibrary(Library library)
     {
-        var data = JsonConvert.SerializeObject(library);
+        var data = JsonSerializer.Serialize(library);
         File.WriteAllText(StorageFilePath, data);
     }
 
@@ -21,7 +21,7 @@ public class LibraryProvider
 
         var data = File.ReadAllText(StorageFilePath);
 
-        return JsonConvert.DeserializeObject<Library>(data) ?? Library.Empty;
+        return JsonSerializer.Deserialize<Library>(data) ?? Library.Empty;
     }
 
     public Book? TryGetBook(string title) => GetLibrary().Books.FirstOrDefault(b => b.Title == title);

CliFx.Demo/Readme.md

@@ -1,5 +1,5 @@
 # CliFx Demo Project
 
-Sample command line interface for managing a library of books.
+Sample command-line interface for managing a library of books.
 
 This demo project showcases basic CliFx functionality such as command routing, argument parsing, and autogenerated help text.

CliFx.Tests.Dummy/Program.cs

@@ -3,12 +3,13 @@ using System.Reflection;
 using System.Threading.Tasks;
 
 namespace CliFx.Tests.Dummy;
+
 // This dummy application is used in tests for scenarios
 // that require an external process to properly verify.
 
 public static partial class Program
 {
-    public static Assembly Assembly { get; } = typeof(Program).Assembly;
+    public static Assembly Assembly { get; } = Assembly.GetExecutingAssembly();
 
     public static string Location { get; } = Assembly.Location;
 }

CliFx.Tests/CancellationSpecs.cs

@@ -16,7 +16,7 @@ public class CancellationSpecs : SpecsBase
     }
 
     [Fact]
-    public async Task Command_can_register_to_receive_a_cancellation_signal_from_the_console()
+    public async Task Command_can_receive_a_cancellation_signal_from_the_console()
     {
         // Arrange
         var commandType = DynamicCommandBuilder.Compile(

CliFx.Tests/CliFx.Tests.csproj

@@ -10,12 +10,12 @@
 
   <ItemGroup>
     <PackageReference Include="Basic.Reference.Assemblies.Net70" Version="1.4.1" />
-    <PackageReference Include="CliWrap" Version="3.5.0" />
-    <PackageReference Include="FluentAssertions" Version="6.8.0" />
-    <PackageReference Include="GitHubActionsTestLogger" Version="2.0.1" PrivateAssets="all" />
-    <PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.4.0" />
+    <PackageReference Include="CliWrap" Version="3.6.1" />
+    <PackageReference Include="FluentAssertions" Version="6.11.0" />
+    <PackageReference Include="GitHubActionsTestLogger" Version="2.0.2" PrivateAssets="all" />
+    <PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.5.0" />
     <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="7.0.0" />
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.4.0" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.5.0" />
     <PackageReference Include="xunit" Version="2.4.2" />
     <PackageReference Include="xunit.runner.visualstudio" Version="2.4.5" PrivateAssets="all" />
     <PackageReference Include="coverlet.collector" Version="3.2.0" PrivateAssets="all" />

CliFx.Tests/ConsoleSpecs.cs

@@ -21,7 +21,7 @@ public class ConsoleSpecs : SpecsBase
     {
     }
 
-    [Fact]
+    [Fact(Timeout = 15000)]
     public async Task Real_console_maps_directly_to_system_console()
     {
         // Can't verify our own console output, so using an

CliFx.Tests/DirectivesSpecs.cs

@@ -19,54 +19,35 @@ public class DirectivesSpecs : SpecsBase
     {
     }
 
-    [Fact]
+    [Fact(Timeout = 15000)]
     public async Task Debug_directive_can_be_specified_to_interrupt_execution_until_a_debugger_is_attached()
     {
         // Arrange
-        var stdOutBuffer = new StringBuilder();
+        using var cts = new CancellationTokenSource();
+
+        // We can't actually attach a debugger, but we can ensure that the process is waiting for one
+        void HandleStdOut(string line)
+        {
+            // Kill the process once it writes the output we expect
+            if (line.Contains("Attach debugger to", StringComparison.OrdinalIgnoreCase))
+                cts.Cancel();
+        }
 
         var command = Cli.Wrap("dotnet")
             .WithArguments(a => a
                 .Add(Dummy.Program.Location)
                 .Add("[debug]")
-            ) | stdOutBuffer;
+            ) | HandleStdOut;
 
-        // Act
+        // Act & assert
         try
         {
-            // This has a timeout just in case the execution hangs forever
-            using var cts = new CancellationTokenSource(TimeSpan.FromSeconds(5));
-
-            var task = command.ExecuteAsync(cts.Token);
-
-            // We can't attach a debugger programmatically, so the application
-            // will hang indefinitely.
-            // To work around it, we will wait until the application writes
-            // something to the standard output and then kill it.
-            while (true)
-            {
-                if (stdOutBuffer.Length > 0)
-                {
-                    cts.Cancel();
-                    break;
-                }
-
-                await Task.Delay(100, cts.Token);
-            }
-
-            await task;
+            await command.ExecuteAsync(cts.Token);
         }
-        catch (OperationCanceledException)
+        catch (OperationCanceledException ex) when (ex.CancellationToken == cts.Token)
         {
-            // This is expected
+            // This means that the process was killed after it wrote the expected output
         }
-
-        var stdOut = stdOutBuffer.ToString();
-
-        // Assert
-        stdOut.Should().Contain("Attach debugger to");
-
-        TestOutput.WriteLine(stdOut);
     }
 
     [Fact]

CliFx.Tests/EnvironmentSpecs.cs

@@ -241,7 +241,7 @@ public class EnvironmentSpecs : SpecsBase
         stdOut.Trim().Should().Be("bar");
     }
 
-    [Fact]
+    [Fact(Timeout = 15000)]
     public async Task Environment_variables_are_extracted_automatically()
     {
         // Ensures that the environment variables are properly obtained from

CliFx/Attributes/CommandOptionAttribute.cs

@@ -40,7 +40,7 @@ public sealed class CommandOptionAttribute : Attribute
 
     /// <summary>
     /// Environment variable whose value will be used as a fallback if the option
-    /// has not been explicitly set through command line arguments.
+    /// has not been explicitly set through command-line arguments.
     /// </summary>
     public string? EnvironmentVariable { get; set; }
 
@@ -51,7 +51,7 @@ public sealed class CommandOptionAttribute : Attribute
     public string? Description { get; set; }
 
     /// <summary>
-    /// Custom converter used for mapping the raw command line argument into
+    /// Custom converter used for mapping the raw command-line argument into
     /// a value expected by the underlying property.
     /// </summary>
     /// <remarks>
@@ -81,7 +81,7 @@ public sealed class CommandOptionAttribute : Attribute
     /// Initializes an instance of <see cref="CommandOptionAttribute" />.
     /// </summary>
     public CommandOptionAttribute(string name, char shortName)
-        : this(name, (char?) shortName)
+        : this(name, (char?)shortName)
     {
     }
 
@@ -97,7 +97,7 @@ public sealed class CommandOptionAttribute : Attribute
     /// Initializes an instance of <see cref="CommandOptionAttribute" />.
     /// </summary>
     public CommandOptionAttribute(char shortName)
-        : this(null, (char?) shortName)
+        : this(null, (char?)shortName)
     {
     }
 }

CliFx/Attributes/CommandParameterAttribute.cs

@@ -47,7 +47,7 @@ public sealed class CommandParameterAttribute : Attribute
     public string? Description { get; set; }
 
     /// <summary>
-    /// Custom converter used for mapping the raw command line argument into
+    /// Custom converter used for mapping the raw command-line argument into
     /// a value expected by the underlying property.
     /// </summary>
     /// <remarks>

CliFx/CliApplication.cs

@@ -2,6 +2,7 @@ using System;
 using System.Collections.Generic;
 using System.Diagnostics;
 using System.Linq;
+using System.Runtime.InteropServices;
 using System.Threading.Tasks;
 using CliFx.Exceptions;
 using CliFx.Formatting;
@@ -14,7 +15,7 @@ using CliFx.Utils.Extensions;
 namespace CliFx;
 
 /// <summary>
-/// Command line application facade.
+/// Command-line application facade.
 /// </summary>
 public class CliApplication
 {
@@ -163,7 +164,7 @@ public class CliApplication
     }
 
     /// <summary>
-    /// Runs the application with the specified command line arguments and environment variables.
+    /// Runs the application with the specified command-line arguments and environment variables.
     /// Returns an exit code which indicates whether the application completed successfully.
     /// </summary>
     /// <remarks>
@@ -206,7 +207,7 @@ public class CliApplication
     }
 
     /// <summary>
-    /// Runs the application with the specified command line arguments.
+    /// Runs the application with the specified command-line arguments.
     /// Environment variables are resolved automatically.
     /// Returns an exit code which indicates whether the application completed successfully.
     /// </summary>
@@ -216,16 +217,18 @@ public class CliApplication
     /// </remarks>
     public async ValueTask<int> RunAsync(IReadOnlyList<string> commandLineArguments) => await RunAsync(
         commandLineArguments,
-        // Use case-sensitive comparison because environment variables are
-        // case-sensitive on Linux and macOS (but not on Windows).
         Environment
             .GetEnvironmentVariables()
-            .ToDictionary<string, string>(StringComparer.Ordinal)
+            .ToDictionary<string, string>(
+                RuntimeInformation.IsOSPlatform(OSPlatform.Windows)
+                    ? StringComparer.OrdinalIgnoreCase
+                    : StringComparer.Ordinal
+            )
     );
 
     /// <summary>
     /// Runs the application.
-    /// Command line arguments and environment variables are resolved automatically.
+    /// Command-line arguments and environment variables are resolved automatically.
     /// Returns an exit code which indicates whether the application completed successfully.
     /// </summary>
     /// <remarks>

CliFx/CliFx.csproj

@@ -1,17 +1,16 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFrameworks>netstandard2.1;netstandard2.0</TargetFrameworks>
+    <TargetFrameworks>netstandard2.0;netstandard2.1</TargetFrameworks>
     <IsPackable>true</IsPackable>
   </PropertyGroup>
 
   <PropertyGroup>
     <Authors>$(Company)</Authors>
-    <Description>Declarative framework for building command line applications</Description>
+    <Description>Class-first framework for building command-line interfaces</Description>
     <PackageTags>command line executable interface framework parser arguments cli app application net core</PackageTags>
     <PackageProjectUrl>https://github.com/Tyrrrz/CliFx</PackageProjectUrl>
     <PackageReleaseNotes>https://github.com/Tyrrrz/CliFx/blob/master/Changelog.md</PackageReleaseNotes>
-    <PackageReadmeFile>Readme.md</PackageReadmeFile>
     <PackageIcon>favicon.png</PackageIcon>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
@@ -21,17 +20,13 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <None Include="../Readme.md" Pack="true" PackagePath="" Visible="false" />
     <None Include="../favicon.png" Pack="true" PackagePath="" Visible="false" />
   </ItemGroup>
 
   <ItemGroup>
     <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1" PrivateAssets="all" />
-    <PackageReference Include="Nullable" Version="1.3.1" PrivateAssets="all" />
-  </ItemGroup>
-
-  <ItemGroup Condition="'$(TargetFramework)' == 'netstandard2.0'">
-    <PackageReference Include="System.Threading.Tasks.Extensions" Version="4.5.4" />
+    <PackageReference Include="PolyShim" Version="1.2.0" PrivateAssets="all" />
+    <PackageReference Include="System.Threading.Tasks.Extensions" Version="4.5.4" Condition="'$(TargetFramework)' == 'netstandard2.0'" />
   </ItemGroup>
 
   <!-- Embed the analyzer inside the package -->

CliFx/CommandBinder.cs

@@ -31,7 +31,7 @@ internal class CommandBinder
             return converter.Convert(rawValue);
         }
 
-        // Assignable from string (e.g. string itself, object, etc)
+        // Assignable from a string (e.g. string itself, object, etc)
         if (targetType.IsAssignableFrom(typeof(string)))
         {
             return rawValue;
@@ -77,7 +77,7 @@ internal class CommandBinder
                 : null;
         }
 
-        // String-constructible (FileInfo, etc)
+        // String-constructable (FileInfo, etc)
         var stringConstructor = targetType.GetConstructor(new[] { typeof(string) });
         if (stringConstructor is not null)
         {
@@ -125,7 +125,7 @@ internal class CommandBinder
             return array;
         }
 
-        // Array-constructible (List<T>, HashSet<T>, etc)
+        // Array-constructable (List<T>, HashSet<T>, etc)
         var arrayConstructor = targetEnumerableType.GetConstructor(new[] { arrayType });
         if (arrayConstructor is not null)
         {
@@ -307,7 +307,7 @@ internal class CommandBinder
 
                 BindMember(optionSchema, commandInstance, rawValues);
 
-                // Required options require at least one value to be set
+                // Required options need at least one value to be set
                 if (rawValues.Any())
                     remainingRequiredOptionSchemas.Remove(optionSchema);
             }
@@ -320,7 +320,7 @@ internal class CommandBinder
 
                 BindMember(optionSchema, commandInstance, rawValues);
 
-                // Required options require at least one value to be set
+                // Required options need at least one value to be set
                 if (rawValues.Any())
                     remainingRequiredOptionSchemas.Remove(optionSchema);
             }

CliFx/Extensibility/BindingConverter.cs

@@ -12,7 +12,7 @@ internal interface IBindingConverter
 public abstract class BindingConverter<T> : IBindingConverter
 {
     /// <summary>
-    /// Parses value from a raw command line argument.
+    /// Parses value from a raw command-line argument.
     /// </summary>
     public abstract T Convert(string? rawValue);
 

CliFx/Formatting/CommandInputConsoleFormatter.cs

@@ -13,7 +13,7 @@ internal class CommandInputConsoleFormatter : ConsoleFormatter
 
     private void WriteCommandLineArguments(CommandInput commandInput)
     {
-        Write("Command line:");
+        Write("Command-line:");
         WriteLine();
 
         WriteHorizontalMargin();

CliFx/Formatting/HelpConsoleFormatter.cs

@@ -367,7 +367,9 @@ internal class HelpConsoleFormatter : ConsoleFormatter
     {
         var childCommandSchemas = _context
             .ApplicationSchema
-            .GetChildCommands(_context.CommandSchema.Name);
+            .GetChildCommands(_context.CommandSchema.Name)
+            .OrderBy(a => a.Name, StringComparer.Ordinal)
+            .ToArray();
 
         if (!childCommandSchemas.Any())
             return;
@@ -402,7 +404,9 @@ internal class HelpConsoleFormatter : ConsoleFormatter
             // Child commands of child command
             var grandChildCommandSchemas = _context
                 .ApplicationSchema
-                .GetChildCommands(childCommandSchema.Name);
+                .GetChildCommands(childCommandSchema.Name)
+                .OrderBy(c => c.Name, StringComparer.Ordinal)
+                .ToArray();
 
             if (grandChildCommandSchemas.Any())
             {

CliFx/ICommand.cs

@@ -4,7 +4,7 @@ using CliFx.Infrastructure;
 namespace CliFx;
 
 /// <summary>
-/// Entry point through which the user interacts with the command line application.
+/// Entry point through which the user interacts with the command-line application.
 /// </summary>
 public interface ICommand
 {

CliFx/Input/CommandInput.cs

@@ -153,7 +153,7 @@ internal partial class CommandInput
                 if (!string.IsNullOrWhiteSpace(lastOptionIdentifier))
                     result.Add(new OptionInput(lastOptionIdentifier, lastOptionValues));
 
-                lastOptionIdentifier = argument.Substring(2);
+                lastOptionIdentifier = argument[2..];
                 lastOptionValues = new List<string>();
             }
             // Short name
@@ -161,7 +161,7 @@ internal partial class CommandInput
                      argument.Length > 1 &&
                      char.IsLetter(argument[1]))
             {
-                foreach (var alias in argument.Substring(1))
+                foreach (var alias in argument[1..])
                 {
                     // Flush previous
                     if (!string.IsNullOrWhiteSpace(lastOptionIdentifier))

CliFx/Schema/CommandSchema.cs

@@ -70,8 +70,7 @@ internal partial class CommandSchema
     public static bool IsCommandType(Type type) =>
         type.Implements(typeof(ICommand)) &&
         type.IsDefined(typeof(CommandAttribute)) &&
-        !type.IsAbstract &&
-        !type.IsInterface;
+        type is { IsAbstract: false, IsInterface: false };
 
     public static CommandSchema? TryResolve(Type type)
     {
@@ -88,7 +87,7 @@ internal partial class CommandSchema
             : new[] {OptionSchema.HelpOption};
 
         var properties = type
-            // Get properties directly on command type
+            // Get properties directly on the command type
             .GetProperties()
             // Get non-abstract properties on interfaces (to support default interfaces members)
             .Union(type

CliFx/Utils/Polyfills.Collections.cs

@@ -1,26 +0,0 @@
-// ReSharper disable CheckNamespace
-
-#if NETSTANDARD2_0
-using System.Collections.Generic;
-
-internal static class CollectionPolyfills
-{
-    public static void Deconstruct<TKey, TValue>(this KeyValuePair<TKey, TValue> pair, out TKey key, out TValue value)
-    {
-        key = pair.Key;
-        value = pair.Value;
-    }
-
-    public static TValue GetValueOrDefault<TKey, TValue>(this IReadOnlyDictionary<TKey, TValue> dic, TKey key) =>
-        dic.TryGetValue(key!, out var result) ? result! : default!;
-}
-
-namespace System.Linq
-{
-    internal static class LinqPolyfills
-    {
-        public static HashSet<T> ToHashSet<T>(this IEnumerable<T> source, IEqualityComparer<T> comparer) =>
-            new(source, comparer);
-    }
-}
-#endif

CliFx/Utils/Polyfills.Streams.cs

@@ -1,11 +0,0 @@
-// ReSharper disable CheckNamespace
-
-#if NETSTANDARD2_0
-using System.IO;
-
-internal static class StreamPolyfills
-{
-    public static void Write(this Stream stream, byte[] buffer) =>
-        stream.Write(buffer, 0, buffer.Length);
-}
-#endif

CliFx/Utils/Polyfills.Strings.cs

@@ -1,12 +0,0 @@
-// ReSharper disable CheckNamespace
-
-#if NETSTANDARD2_0
-internal static class StringPolyfills
-{
-    public static bool StartsWith(this string str, char c) =>
-        str.Length > 0 && str[0] == c;
-
-    public static bool EndsWith(this string str, char c) =>
-        str.Length > 0 && str[str.Length - 1] == c;
-}
-#endif

CliFx/Utils/StackFrame.cs

@@ -52,33 +52,35 @@ internal partial class StackFrame
     private const string NotSpace = @"[^\x20\t]";
 
     // Taken from https://github.com/atifaziz/StackTraceParser
-    private static readonly Regex Pattern = new(@"
-            ^
-            " + Space + @"*
-            \w+ " + Space + @"+
-            (?<frame>
-                (?<type> " + NotSpace + @"+ ) \.
-                (?<method> " + NotSpace + @"+? ) " + Space + @"*
-                (?<params>  \( ( " + Space + @"* \)
-                               |                    (?<pt> .+?) " + Space + @"+ (?<pn> .+?)
-                                 (, " + Space + @"* (?<pt> .+?) " + Space + @"+ (?<pn> .+?) )* \) ) )
-                ( " + Space + @"+
-                    ( # Microsoft .NET stack traces
-                    \w+ " + Space + @"+
-                    (?<file> ( [a-z] \: # Windows rooted path starting with a drive letter
-                             | / )      # *nix rooted path starting with a forward-slash
-                             .+? )
-                    \: \w+ " + Space + @"+
-                    (?<line> [0-9]+ ) \p{P}?
-                    | # Mono stack traces
-                    \[0x[0-9a-f]+\] " + Space + @"+ \w+ " + Space + @"+
-                    <(?<file> [^>]+ )>
-                    :(?<line> [0-9]+ )
-                    )
-                )?
-            )
-            \s*
-            $",
+    private static readonly Regex Pattern = new(
+        $$"""
+        ^
+        {{Space}}*
+        \w+ {{Space}}+
+        (?<frame>
+            (?<type> {{NotSpace}}+ ) \.
+            (?<method> {{NotSpace}}+? ) {{Space}}*
+            (?<params>  \( ( {{Space}}* \)
+                           |                    (?<pt> .+?) {{Space}}+ (?<pn> .+?)
+                             (, {{Space}}* (?<pt> .+?) {{Space}}+ (?<pn> .+?) )* \) ) )
+            ( {{Space}}+
+                ( # Microsoft .NET stack traces
+                \w+ {{Space}}+
+                (?<file> ( [a-z] \: # Windows rooted path starting with a drive letter
+                         | / )      # Unix rooted path starting with a forward-slash
+                         .+? )
+                \: \w+ {{Space}}+
+                (?<line> [0-9]+ ) \p{P}?
+                | # Mono stack traces
+                \[0x[0-9a-f]+\] {{Space}}+ \w+ {{Space}}+
+                <(?<file> [^>]+ )>
+                :(?<line> [0-9]+ )
+                )
+            )?
+        )
+        \s*
+        $
+        """,
         RegexOptions.IgnoreCase |
         RegexOptions.Multiline |
         RegexOptions.ExplicitCapture |
@@ -89,7 +91,7 @@ internal partial class StackFrame
 
     public static IEnumerable<StackFrame> ParseMany(string stackTrace)
     {
-        var matches = Pattern.Matches(stackTrace).Cast<Match>().ToArray();
+        var matches = Pattern.Matches(stackTrace).ToArray();
 
         if (matches.Length <= 0 || matches.Any(m => !m.Success))
         {

Directory.Build.props

@@ -1,7 +1,7 @@
 <Project>
 
   <PropertyGroup>
-    <Version>2.3.1</Version>
+    <Version>2.3.3</Version>
     <Company>Tyrrrz</Company>
     <Copyright>Copyright (C) Oleksii Holub</Copyright>
     <LangVersion>latest</LangVersion>

License.txt

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019-2022 Oleksii Holub
+Copyright (c) 2019-2023 Oleksii Holub
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Readme.md

@@ -1,7 +1,7 @@
 # CliFx
 
-[![Made in Ukraine](https://img.shields.io/badge/made_in-ukraine-ffd700.svg?labelColor=0057b7)](https://vshymanskyy.github.io/StandWithUkraine)
-[![Build](https://img.shields.io/github/workflow/status/Tyrrrz/CliFx/CI/master)](https://github.com/Tyrrrz/CliFx/actions)
+[![Made in Ukraine](https://img.shields.io/badge/made_in-ukraine-ffd700.svg?labelColor=0057b7)](https://tyrrrz.me/ukraine)
+[![Build](https://img.shields.io/github/actions/workflow/status/Tyrrrz/CliFx/main.yml?branch=master)](https://github.com/Tyrrrz/CliFx/actions)
 [![Coverage](https://img.shields.io/codecov/c/github/Tyrrrz/CliFx/master)](https://codecov.io/gh/Tyrrrz/CliFx)
 [![Version](https://img.shields.io/nuget/v/CliFx.svg)](https://nuget.org/packages/CliFx)
 [![Downloads](https://img.shields.io/nuget/dt/CliFx.svg)](https://nuget.org/packages/CliFx)
@@ -11,7 +11,7 @@
 
 > 🟡 **Project status**: maintenance mode<sup>[[?]](https://github.com/Tyrrrz/.github/blob/master/docs/project-status.md)</sup>
 
-**CliFx** is a simple to use, yet powerful framework for building command line applications.
+**CliFx** is a simple to use, yet powerful framework for building command-line applications.
 Its primary goal is to completely take over the user input layer, allowing you to forget about infrastructural concerns and instead focus on writing your application.
 
 ## Terms of use<sup>[[?]](https://github.com/Tyrrrz/.github/blob/master/docs/why-so-political.md)</sup>
@@ -23,7 +23,7 @@ By using this project or its source code, for any purpose and in any shape or fo
 - You **support Ukraine's territorial integrity, including its claims over temporarily occupied territories of Crimea and Donbas**
 - You **reject false narratives perpetuated by Russian state propaganda**
 
-To learn more about the war and how you can help, [click here](https://tyrrrz.me). Glory to Ukraine! 🇺🇦
+To learn more about the war and how you can help, [click here](https://tyrrrz.me/ukraine). Glory to Ukraine! 🇺🇦
 
 ## Install
 
@@ -49,12 +49,14 @@ To learn more about the war and how you can help, [click here](https://tyrrrz.me
 
 ## Usage
 
-### Application and commands
+### Quick overview
 
-To turn your program into a command line interface, modify your `Main` method so that it delegates execution to `CliApplication`.
-You can use `CliApplicationBuilder` to fluently create and configure an instance of `CliApplication`:
+To turn your program into a command-line interface, modify the `Main()` method so that it delegates the execution to an instance of `CliApplication`.
+You can use `CliApplicationBuilder` to simplify the process of creating and configuring an application:
 
 ```csharp
+using CliFx;
+
 public static class Program
 {
     public static async Task<int> Main() =>
@@ -70,76 +72,19 @@ public static class Program
 > Exit code is used to communicate execution result to the parent process, so it's important that your program propagates it.
 
 > **Note**:
-> When calling `CliApplication.RunAsync()`, **CliFx** resolves command line arguments and environment variables from `Environment.GetCommandLineArgs()` and `Environment.GetEnvironmentVariables()` respectively.
-> You can also provide them explicitly if you choose.
+> When calling `CliApplication.RunAsync()`, **CliFx** resolves command-line arguments and environment variables from `Environment.GetCommandLineArgs()` and `Environment.GetEnvironmentVariables()` respectively.
+> You can also provide them manually using one of the alternative overloads.
 
-The code above uses `AddCommandsFromThisAssembly()` to detect command types defined within the current assembly.
-Commands are entry points, through which the user can interact with your application.
+The code above uses `AddCommandsFromThisAssembly()` to detect command types defined within the current project and register them on the application.
+Commands are independent entry points, through which the user can interact with your program.
 
-To define a command, create a new class by implementing the `ICommand` interface and annotate it with the `[Command]` attribute:
+To define a command, create a class that implements the `ICommand` interface and annotate it with the `[Command]` attribute:
 
 ```csharp
-[Command]
-public class HelloWorldCommand : ICommand
-{
-    public ValueTask ExecuteAsync(IConsole console)
-    {
-        console.Output.WriteLine("Hello world!");
+using CliFx;
+using CliFx.Attributes;
 
-        // Return default task if the command is not asynchronous
-        return default;
-    }
-}
-```
-
-In order to implement `ICommand`, the class needs to define an `ExecuteAsync(...)` method.
-This is the method that gets called by the framework when the user decides to execute this command.
-
-As the only parameter, this method takes an instance of `IConsole`, which is an abstraction around the system console.
-Use this abstraction in place of `System.Console` whenever you need to write output, read input, or otherwise interact with the console.
-
-With the basic setup above, the user can now run the application and get a greeting in return:
-
-```powershell
-> dotnet myapp.dll
-
-Hello world!
-```
-
-Out of the box, the application also comes with built-in `--help` and `--version` options.
-They can be used to show help text or application version respectively:
-
-```powershell
-> dotnet myapp.dll --help
-
-MyApp v1.0
-
-USAGE
-  dotnet myapp.dll [options]
-
-OPTIONS
-  -h|--help         Shows help text.
-  --version         Shows version information.
-```
-
-```powershell
-> dotnet myapp.dll --version
-
-v1.0
-```
-
-### Parameters and options
-
-Commands can be configured to take input from command line arguments.
-To do that, you need to add properties to the command class and bind them using special attributes.
-
-In **CliFx**, there are two types of argument bindings: **parameters** and **options**.
-Parameters are bound from arguments based on the order they appear in, while options are bound by their name.
-
-As an example, here's a command that calculates logarithm of a value — it uses a parameter binding to specify the input value and an option binding for the logarithm base:
-
-```csharp
-[Command]
+[Command(Description = "Calculates the logarithm of a value.")]
 public class LogCommand : ICommand
 {
     // Order: 0
@@ -156,50 +101,61 @@ public class LogCommand : ICommand
         var result = Math.Log(Value, Base);
         console.Output.WriteLine(result);
 
+        // If the execution is not meant to be asynchronous,
+        // return an empty task at the end of the method.
         return default;
     }
 }
 ```
 
-> **Note**:
-> **CliFx** has built-in analyzers that detect common errors in command definitions.
-> Your code will not compile if the command contains duplicate options, overlapping parameters, or otherwise invalid configuration.
+In order to implement `ICommand`, the class needs to define an `ExecuteAsync(...)` method.
+This is the method that gets called by the framework when the user decides to execute the command.
 
-In order to execute this command, at a minimum, the user needs to provide the input value:
+As the only parameter, this method takes an instance of `IConsole`, which is an abstraction around the system console.
+Use this abstraction in place of `System.Console` whenever you need to write output, read input, or otherwise interact with the console.
 
-```powershell
-> dotnet myapp.dll 10000
+In most cases, you will also want to define input bindings, which are properties annotated by the `[CommandParameter]` and `[CommandOption]` attributes.
+These bindings provide a way to map command-line arguments into structured data that can be used by the command.
+
+The command in the above example serves as a simple logarithm calculator and defines two inputs: a positional parameter for the input value and a named option for the logarithm base.
+In order to execute this command, at minimum, the user needs to provide the input value:
+
+```sh
+$ dotnet myapp.dll 10000
 
 4
 ```
 
-They can also pass the `base` option to override the default logarithm base of 10:
+They can also pass the `-b|--base` option to override the default logarithm base of `10`:
 
-```powershell
-> dotnet myapp.dll 729 -b 3
+```sh
+$ dotnet myapp.dll 729 -b 3
 
 6
 ```
 
-In case the user forgets to specify the `value` parameter, the application will exit with an error:
+In case the user forgets to specify the required `value` parameter, the application will instead exit with an error:
 
-```powershell
-> dotnet myapp.dll -b 10
+```sh
+$ dotnet myapp.dll -b 10
 
 Missing required parameter(s):
 <value>
 ```
 
-Available parameters and options are also listed in the command's help text, which can be accessed by passing the `--help` option:
+Out of the box, **CliFx** also provides a built-in `--help` option, which generates a help screen that lists all parameters and options available for the command:
 
-```powershell
-> dotnet myapp.dll --help
+```sh
+$ dotnet myapp.dll --help
 
 MyApp v1.0
 
 USAGE
   dotnet myapp.dll <value> [options]
 
+DESCRIPTION
+  Calculates the logarithm of a value.  
+
 PARAMETERS
 * value             Value whose logarithm is to be found.
 
@@ -209,21 +165,9 @@ OPTIONS
   --version         Shows version information.
 ```
 
-Overall, parameters and options are both used to consume input from the command line, but they differ in a few important ways:
-
-|                    | Parameter                                                                      | Option                                                                                               |
-| ------------------ | ------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------- |
-| **Identification** | Positional (by relative order).                                                | Nominal (by name or short name).                                                                     |
-| **Requiredness**   | Required by default. Only the last parameter can be configured to be optional. | Optional by default. Any option can be configured to be required without limitations.                |
-| **Arity**          | Only the last parameter can be bound to a non-scalar property (i.e. an array). | Any option can be bound to a non-scalar property without limitations.                                |
-| **Fallback**       | —                                                                              | Can be configured to use an environment variable as fallback if the value isn't explicitly provided. |
-
-As a general guideline, use parameters for required inputs that the command can't function without.
-Use options for all other non-required inputs, or when specifying the name explicitly makes the usage clearer.
-
 ### Argument syntax
 
-This library employs the POSIX argument syntax, which is used in most modern command line tools.
+This library employs a variation of the POSIX argument syntax, which is used in most modern command-line tools.
 Here are some examples of how it works:
 
 - `myapp --foo bar` sets option `"foo"` to value `"bar"`
@@ -243,12 +187,69 @@ The parser's context-free nature has several implications on how it consumes arg
 For example, `myapp -i file1.txt file2.txt` will always be parsed as an option with multiple values, regardless of the arity of the underlying property it's bound to.
 Similarly, unseparated arguments in the form of `myapp -ofile` will be treated as five distinct options `'o'`, `'f'`, `'i'`, `'l'`, `'e'`, instead of `'o'` being set to value `"file"`.
 
-These rules also make the order of arguments important — command line string is expected to follow this pattern:
+These rules also make the order of arguments important — command-line string is expected to follow this pattern:
 
-```powershell
-> myapp [...directives] [command] [...parameters] [...options]
+```sh
+$ myapp [...directives] [command] [...parameters] [...options]
 ```
 
+### Parameters and options
+
+**CliFx** supports two types of argument bindings: **parameters** and **options**.
+Parameters are bound from arguments based on the order they appear in, while options are bound by their name.
+
+Besides that, they also differ in the following ways:
+
+- Parameters are required by default, while options are not.
+
+  - You can make an option required by setting `IsRequired = true` on the corresponding attribute or by adding the `required` keyword to the property declaration (introduced in C# 11):
+
+      ```csharp
+      // Any option can be required or optional without restrictions
+      [CommandOption("foo")]
+      public required string RequiredOption { get; init; }
+      ```
+
+  - To make a parameter optional, you can set `IsRequired = false`, but only the last parameter (by order) can be configured in such way:
+
+    ```csharp
+    // Only the last parameter can be optional
+    [CommandParameter(0, IsRequired = false)]
+    public string? OptionalParameter { get; init; }
+    ```
+
+- Parameters are primarily used for scalar (non-enumerable) properties, while options can be used for both scalar and non-scalar properties.
+
+  - You can bind an option to a property of a non-scalar type, such as `IReadOnlyList<T>`:
+
+    ```csharp
+    // Any option can be non-scalar
+    [CommandOption("foo")]
+    public required IReadOnlyList<string> NonScalarOption { get; init; }
+    ```
+
+  - You can bind a parameter to a non-scalar property, but only if it's the last parameter in the command:
+  
+    ```csharp
+    // Only the last parameter can be non-scalar
+    [CommandParameter(0)]
+    public required IReadOnlyList<string> NonScalarParameter { get; init; }
+    ```
+
+- Options can rely on an environment variable for fallback, while parameters cannot:
+
+  ```csharp
+  // If the value is not provided directly, it will be read
+  // from the environment variable instead.
+  // This works for both scalar and non-scalar properties.
+  [CommandOption("foo", EnvironmentVariable = "ENV_FOO")]
+  public required string OptionWithFallback { get; init; }
+  ```
+
+> **Note**:
+> **CliFx** has a set of built-in analyzers that detect common errors in command definitions.
+> Your code will not compile if a command contains duplicate options, overlapping parameters, or otherwise invalid configuration.
+
 ### Value conversion
 
 Parameters and options can be bound to properties with the following underlying types:
@@ -278,7 +279,7 @@ public class FileSizeCalculatorCommand : ICommand
     // FileInfo is string-initializable and IReadOnlyList<T> can be assigned from an array,
     // so the value of this property can be mapped from a sequence of arguments.
     [CommandParameter(0)]
-    public IReadOnlyList<FileInfo> Files { get; init; }
+    public required IReadOnlyList<FileInfo> Files { get; init; }
 
     public ValueTask ExecuteAsync(IConsole console)
     {
@@ -291,34 +292,8 @@ public class FileSizeCalculatorCommand : ICommand
 }
 ```
 
-```powershell
-> dotnet myapp.dll file1.bin file2.exe
-
-Total file size: 186368 bytes
-```
-
-Same command, but using an option for the list of files instead:
-
-```csharp
-[Command]
-public class FileSizeCalculatorCommand : ICommand
-{
-    [CommandOption("files")]
-    public IReadOnlyList<FileInfo> Files { get; init; }
-
-    public ValueTask ExecuteAsync(IConsole console)
-    {
-        var totalSize = Files.Sum(f => f.Length);
-
-        console.Output.WriteLine($"Total file size: {totalSize} bytes");
-
-        return default;
-    }
-}
-```
-
-```powershell
-> dotnet myapp.dll --files file1.bin file2.exe
+```sh
+$ dotnet myapp.dll file1.bin file2.exe
 
 Total file size: 186368 bytes
 ```
@@ -349,13 +324,13 @@ public class SurfaceCalculatorCommand : ICommand
 {
     // Custom converter is used to map raw argument values
     [CommandParameter(0, Converter = typeof(VectorConverter))]
-    public Vector2 PointA { get; init; }
+    public required Vector2 PointA { get; init; }
 
     [CommandParameter(1, Converter = typeof(VectorConverter))]
-    public Vector2 PointB { get; init; }
+    public required Vector2 PointB { get; init; }
 
     [CommandParameter(2, Converter = typeof(VectorConverter))]
-    public Vector2 PointC { get; init; }
+    public required Vector2 PointC { get; init; }
 
     public ValueTask ExecuteAsync(IConsole console)
     {
@@ -373,41 +348,15 @@ public class SurfaceCalculatorCommand : ICommand
 }
 ```
 
-### Environment variables
+```sh
+$ dotnet myapp.dll 0x0 0x10 10x0
 
-An option can be configured to use a specific environment variable as fallback.
-If the user does not provide value for such option through command line arguments, the current value of the environment variable will be used instead.
-
-```csharp
-[Command]
-public class AuthCommand : ICommand
-{
-    [CommandOption("token", EnvironmentVariable = "AUTH_TOKEN")]
-    public required string AuthToken { get; init; }
-
-    public ValueTask ExecuteAsync(IConsole console)
-    {
-        console.Output.WriteLine(AuthToken);
-
-        return default;
-    }
-}
+Triangle surface area: 50
 ```
 
-```powershell
-> $env:AUTH_TOKEN="test"
-
-> dotnet myapp.dll
-
-test
-```
-
-Environment variables can be configured for options of non-scalar types (arrays, lists, etc.) as well.
-In such case, the values of the environment variable will be split by `Path.PathSeparator` (`;` on Windows, `:` on Unix systems).
-
 ### Multiple commands
 
-In order to facilitate a variety of different workflows, command line applications may provide the user with more than just a single command.
+In order to facilitate a variety of different workflows, command-line applications may provide the user with more than just a single command.
 Complex applications may also nest commands underneath each other, employing a multi-level hierarchical structure.
 
 With **CliFx**, this is achieved by simply giving each command a unique name through the `[Command]` attribute.
@@ -448,8 +397,8 @@ For example, running `dotnet myapp.dll cmd1 arg1 -p 42` will execute `FirstComma
 
 Requesting help will show direct subcommands of the current command:
 
-```powershell
-> dotnet myapp.dll --help
+```sh
+$ dotnet myapp.dll --help
 
 MyApp v1.0
 
@@ -470,8 +419,8 @@ You can run `dotnet myapp.dll [command] --help` to show help on a specific comma
 
 The user can also refine their help request by querying it on a specific command:
 
-```powershell
-> dotnet myapp.dll cmd1 --help
+```sh
+$ dotnet myapp.dll cmd1 --help
 
 USAGE
   dotnet myapp.dll cmd1 [options]
@@ -521,13 +470,12 @@ public class DivideCommand : ICommand
 }
 ```
 
-```powershell
-> dotnet myapp.dll --dividend 10 --divisor 0
+```sh
+$ dotnet myapp.dll --dividend 10 --divisor 0
 
 Division by zero is not supported.
 
-
-> $LastExitCode
+$ echo $?
 
 133
 ```
@@ -541,7 +489,7 @@ Division by zero is not supported.
 Console applications support the concept of interrupt signals, which can be issued by the user to abort the currently ongoing operation.
 If your command performs critical work, you can intercept these signals to handle cancellation requests in a graceful way.
 
-To make a command cancellation-aware, call `console.RegisterCancellationHandler()` to register the signal handler and obtain the corresponding `CancellationToken`.
+In order to make the command cancellation-aware, call `console.RegisterCancellationHandler()` to register the signal handler and obtain the corresponding `CancellationToken`.
 Once this method is called, the program will no longer terminate on an interrupt signal but will instead trigger the token, so it's important to be able to process it correctly.
 
 ```csharp
@@ -694,19 +642,19 @@ To do that, you need to pass the corresponding directive before any other argume
 In order to run the application in debug mode, use the `[debug]` directive.
 This will cause the program to launch in a suspended state, waiting for debugger to be attached to the process:
 
-```powershell
-> dotnet myapp.dll [debug] cmd -o
+```sh
+$ dotnet myapp.dll [debug] cmd -o
 
 Attach debugger to PID 3148 to continue.
 ```
 
 To run the application in preview mode, use the `[preview]` directive.
-This will short-circuit the execution and instead print the consumed command line arguments as they were parsed, along with resolved environment variables:
+This will short-circuit the execution and instead print the consumed command-line arguments as they were parsed, along with resolved environment variables:
 
-```powershell
-> dotnet myapp.dll [preview] cmd arg1 arg2 -o foo --option bar1 bar2
+```sh
+$ dotnet myapp.dll [preview] cmd arg1 arg2 -o foo --option bar1 bar2
 
-Command line:
+Command-line:
   cmd <arg1> <arg2> [-o foo] [--option bar1 bar2]
 
 Environment:
@@ -726,5 +674,5 @@ var app = new CliApplicationBuilder()
 
 ## Etymology
 
-**CliFx** is made out of "Cli" for "Command Line Interface" and "Fx" for "Framework".
+**CliFx** is made out of "Cli" for "Command-line Interface" and "Fx" for "Framework".
 It's pronounced as "cliff ex".