System.CommandLine v2.0.0-beta4.22272.1

For details on the Beta 4 release, please see #1750.

What's Changed

• Added ZSH Completion Shim Script by @JohnnyWombwell in #1643
• [main] Update dependencies from dotnet/arcade by @dotnet-maestro in #1651
• fix #1647 by @jonsequitur in #1649
• add support ... or, uh, remove non-support ... for OnlyTake(0) by @jonsequitur in #1658
• [main] Update dependencies from dotnet/arcade by @dotnet-maestro in #1660
• Perf improvements part 6: startup time by @adamsitnik in #1654
• Add string converters for uint/sbyte/byte by @SamZhangQingChuan in #1661
• update Ubuntu image to 20.04 by @jonsequitur in #1657
• [main] Update dependencies from dotnet/arcade by @dotnet-maestro in #1666
• [main] Update dependencies from dotnet/arcade by @dotnet-maestro in #1674
• Ubuntu dependencies for NativeAOT compiler by @jonsequitur in #1676
• Add NativeAOT test by @adamsitnik in #1656
• [main] Update dependencies from dotnet/arcade by @dotnet-maestro in #1682
• Fix #1638 by @jonsequitur in #1677
• Fix #1663 by @jonsequitur in #1671
• Fix #1209 by @eisbaer66 in #1706
• Apply comments from #7859 by @tdykstra in #1701
• Present error instead of throwing exception for empty argument to FileSystemInfo type by @therealchjones in #1704
• Fix #1665 by @jonsequitur in #1714
• fix #1711 by @jonsequitur in #1716
• Add TimeSpan string converter by @GabeDeBacker in #1718
• SetHandler improvements by @jonsequitur in #1729
• Add support for IPAddress and IPEndpoint arguments by @RobThree in #1735
• Add support for DateOnly and TimeOnly on .Net 6 (#1732). by @RobThree in #1734
• bump version to beta4 by @jonsequitur in #1741

New Contributors

• @JohnnyWombwell made their first contribution in #1643
• @SamZhangQingChuan made their first contribution in #1661
• @eisbaer66 made their first contribution in #1706
• @tdykstra made their first contribution in #1701
• @therealchjones made their first contribution in #1704
• @GabeDeBacker made their first contribution in #1718
• @RobThree made their first contribution in #1735

Full Changelog: v2.0.0-beta3.22114.1...2.0.0-beta4.22272.1

System.CommandLine v2.0.0-beta3.22114.1

For details on the Beta 3 release, please see #1613.

System.CommandLine v2.0.0-beta2.21617.1

For details on the Beta 2 release, please see #1537.

System.CommandLine v2.0.0-beta1.21216.1

What's new

It's been a while since our last beta release because as we approach the 2.0 milestone, we're making more breaking changes, and we're trying to group them into fewer releases in order to minimize churn.

System.CommandLine

• Added an Argument.LegalFileNamesOnly extension method to improve file validations. (Thanks, @AronParker !)

• Made significant improvements to HelpBuilder to enable more fine-grained customization of help output. (Thanks, @Keboo!)

• Added an optional description parameter to an Argument<T> constructor to match Option<T>. (Thanks, @database64128!)

• CommandHandler.Create can now specify abstract methods, which can vary by the derived class at invocation time. (Thanks, @ycrumeyrolle!)

• Improved support for POSIX bundled arguments when no delimiter is used. (Thanks, @sfoslund)

• Ahora se puede localizar la ayuda (pero todavia se necesita marcar -h para pedirla 🤔). (Thanks, @Keboo!)

• Added XML documentation for a number of types. (Thanks, @pieter-venter!)

• Added a ParseResult parameter to Symbol.GetSuggestions and to the signature for SuggestDelegate. The GetSuggestions change is not a source-breaking change because we've also added an extension method supporting the older signature. (Thanks, @thoemmi!)

• Fixed a bug where trailing spaces would break response file parsing. (Thanks, @hackf5!)

• Introduced IIdentifierSymbol, which Option and Command implement, but Argument does not.

• Enabled customization of exit codes on error by passing an exitErrorCode argument to various CommandLineBuilder methods: UseExceptionHandler, UseParseDirective, UseParseErrorReporting, and UseVersionOption. (Thanks, @Keboo!)

• Custom argument parsers using ParseArgument<T> can now partially consume tokens using ArgumentResult.OnlyTake(int), allowing other symbols to consume the remaining tokens.

• CommandHandler.Create now provides overloads for up to 16 parameters. We used to go to 11, but it wasn't enough.

• The debug directive now requires opt-in from the user, in order to prevent it from being used maliciously to block a process. (Thanks, @Keboo!)

• Numerous performance improvements, benefitting speed and memory footprint. (Thanks, @paulomorgado!) Here's a sample:

  BenchmarkDotNet=v0.12.1, OS=Windows 10.0.19042
  Intel Core i7-6700 CPU 3.40GHz (Skylake), 1 CPU, 8 logical and 4 physical cores
  .NET Core SDK=5.0.300-preview.21180.15
  [Host]    : .NET Core 5.0.5 (CoreCLR 5.0.521.16609, CoreFX 5.0.521.16609), X64 RyuJIT
  MediumRun : .NET Core 5.0.5 (CoreCLR 5.0.521.16609, CoreFX 5.0.521.16609), X64 RyuJIT
  
  Job=MediumRun  Force=True  IterationCount=15  
  LaunchCount=2  RunStrategy=ColdStart  WarmupCount=10  
  

  Method	NuGetReferences	Mean	Error	StdDev	Median	Ratio	RatioSD	Gen 0	Gen 1	Gen 2	Allocated
  SimpleParseAndInvoke	System.CommandLine 2.0.0-beta1.20371.2	21.89 ms	59.16 ms	88.54 ms	1.0039 ms	1.00	0.00	-	-	-	52.84 KB
  SimpleParseAndInvoke	System.CommandLine 2.0.0-beta1.21214.1	17.16 ms	49.76 ms	74.48 ms	0.7997 ms	0.83	0.18	-	-	-	45.48 KB

• Various bug fixes.

System.CommandLine.Hosting

• Added IHostBuilder.GetInvocationContext extension methods for accessing InvocationContext in order to do invocation-specific dependency injection and more. (Thanks, @fredrikhr!)

Breaking changes

• Option.Argument has been removed from the public API. Option/Option<T> constructors have been adjusted so that functionality for option arguments (such as setting default values and custom argument parsers) is available via Option and Option<T>.

• Model binding no longer passes null for unspecified argument and option values of IEnumerable or string types. Instead, it passes an empty array or list of the appropriate type, or string.Empty, respectively.

• SuggestDelegate now takes a ParseResult parameter in addition to the existing string textToMatch parameter.

• InvocationContext.ResultCode has been renamed to InvocationContext.ExitCode.

• The following string-based lookup APIs have been removed because they can be ambiguous when more than one symbol matches:

  • ParseResult[string]
  • CommandResult.OptionResult(string)
  • CommandResult[string]

• System.CommandLine.Invocation.Process has been removed from the public API.

System.CommandLine v2.0.0-beta1.20371.2

What's new

• Moved the documentation from the wiki into the repository so people can make pull requests.

System.CommandLine

• Added support for setting environment variables using the [env:name=value] directive. (#965) Thanks, @fredrikhr!

• Made constructors more consistent between Argument<T> and Option<T> to allow specifying getDefaultValue and description.

• Added ParseResult.ValueForArgument<T>(Argument<T>) and ParseResult.ValueForOption<T>(Option<T>) to combine lookup and conversion into a single method supporting type inference. (#949)

• Added default values to help output. (#898) Thanks, @NikiforovAll!

• Help now wraps lines for long option names (#947) Thanks, @apogeeoak!

• Added SymbolResult.FindResultFor to provide a cleaner way to find the result for a particular Command, Option, or Argument. This is similar to ParseResult.FindResultFor but it can be used within a custom parse delegate (ParseArgument<T>) so that you don't have to traverse the result tree.

• Improved suggestion APIs to allow replacing the default suggestions, using Argument.Suggestions.Clear(). (#955) Thanks, @jmarolf!

• Added Option.AddSuggestions and Argument.AddSuggestions methods with overloads to provide a static list of suggestions or a delegate for more dynamic suggestions.

• Suggestions are now sorted so that the matches closest to what was typed are shown first. (#891) Thanks, @kimsey0!

• Performance improvements in tokenizer and symbol result lookups.

System.CommandLine.Rendering

• Made AnsiControlCode IFormattable (#966). Thanks, @eerhardt!

Breaking changes

• Renamed Option.Required to Option.IsRequired.

• Renamed the delegate type Suggest to SuggestDelegate.

• Symbol.Aliases and Symbol.RawAliases are now of type IReadOnlyCollection<string> rather than IReadOnlyList<string>.

System.CommandLine v2.0.0-beta1.20214.1

Update dependencies from https://github.com/dotnet/arcade build 20200…

System.CommandLine v2.0.0-beta1.20213.1

fix nullability