Sourced from Ookii.CommandLine's releases.

Ookii.CommandLine 5.0

What's new

Ookii.CommandLine 5.0 provides improved default behavior for enumeration conversion, improvements to argument validators, the ability to group arguments into categories in the usage help, and some improved and simplified APIs.

For full details, please see the change log, and documentation for this release.

Release contents

• The Ookii.CommandLine class library in versions for .Net Standard 2.0, .Net Standard 2.1, and .Net 8.0.
• Several sample applications.

This release is also available on NuGet.

Ookii.CommandLine 5.0 (preview)

What's new

Ookii.CommandLine 5.0 provides improved default behavior for enumeration conversion, improvements to argument validators, the ability to group arguments into categories in the usage help, and some improved and simplified APIs.

For full details, please see the change log, and documentation for this release.

Release contents

• The Ookii.CommandLine class library in versions for .Net Standard 2.0, .Net Standard 2.1, and .Net 8.0.
• Several sample applications.

This release is also available on NuGet.

Sourced from Ookii.CommandLine's changelog.

What’s new in Ookii.CommandLine

Ookii.CommandLine 5.0 (2025-02-22)

IMPORTANT: Version 5.0 contains breaking changes. If you are upgrading from an earlier version, please check the migration guide.

• Command line parsing improvements:
  • Arguments using an enumeration type now only accept named values by default, and comma-separated values are only accepted if the enumeration has the [FlagsAttribute][]. These default can be changed using the [ValidateEnumValueAttribute][] attribute.
  • Argument validators can now define separate methods to validate the value before string conversion, after conversion, and after all arguments have been parsed. This allows a single validator to perform validation at each stage.
  • You can use the helper type [NonSwitchBoolean][] to create an argument that takes a boolean value, but is not a switch argument.
  • When an automatic prefix alias is used that is ambiguous between multiple arguments or commands, a message is shown that lists the arguments it could match.
  • An error message is now shown when the user provides an unknown command name, along with the usage help.
• Usage help improvements:
  • You can now group arguments into categories in the usage help.
  • You can hide argument and command aliases from the usage help with the [AliasAttribute.IsHidden][] and [ShortAliasAttribute.IsHidden][] properties.
  • You can now apply the [ValueDescriptionAttribute][] to a type, as well as to an individual argument. This allows you to set a default description for a custom type you use for argument parsing.
  • Custom value descriptions can opt-in to having name transformation applied to the custom description, using the [ValueDescriptionAttribute.ApplyTransform][] property.
  • When an argument cancels parsing (e.g. using [CommandLineArgumentAttribute.CancelParsing][], or with the return value of a method argument), it must now ask for usage help to be shown using [CancelMode.AbortWithHelp][] instead of using the [HelpRequested][] property.
• Improved and simplified some APIs:
  • Custom argument converters now only have to implement a single method that takes a [ReadOnlyMemory<char>][], instead of separate string and [ReadOnlySpan<char>][] overloads.
  • The [CommandAttribute][] is no longer inherited by derived classes. Inheriting it didn't really make sense unless no command name was set.
  • Simplify the API for using a [CancellationToken][] with [IAsyncCommand][].
  • Some other small API cleanup.
  • See the migration guide for details on all API changes.
• The .Net 8 SDK is now required for using source generation. As before, you can still target older .Net runtimes, as long as you build using .Net 8 or a newer SDK.
• Various bug fixes and minor improvements.
• The .Net 6 and .Net 7 assemblies have been removed, which may lead to some loss of features for those .Net versions. See the migration guide for more details.
• The code snippets Visual Studio extension has been removed from the download. The existing snippets still work, but they will no longer be updated in the future.

... (truncated)

• 724ca9b Merge pull request #46 from SvenGroot/v5.0-dev
• 0206ffd Remove preview tags.
• fb9dad1 Merge pull request #45 from SvenGroot/dependabot/nuget/src/main/nuget-depende...
• 985293d Bump the nuget-dependencies group in /src with 2 updates
• de23d68 Merge pull request #44 from SvenGroot/dependabot/nuget/src/main/nuget-depende...
• a0deeaf Bump the nuget-dependencies group in /src with 2 updates
• 1ebf776 Update change log.
• c41540d Update comment referring to package versions.
• 09d438b Merge remote-tracking branch 'origin/main' into v5.0-dev
• 44e1d8c Revert CA packages to work with .Net 8.0,
• Additional commits viewable in compare view

You can trigger Dependabot actions by commenting on this PR:

• @dependabot rebase will rebase this PR
• @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
• @dependabot merge will merge this PR after your CI passes on it
• @dependabot squash and merge will squash and merge this PR after your CI passes on it
• @dependabot cancel merge will cancel a previously requested merge and block automerging
• @dependabot reopen will reopen this PR if it is closed
• @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
• @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
• @dependabot ignore <dependency name> major version will close this group update PR and stop Dependabot creating any more for the specific dependency's major version (unless you unignore this specific dependency's major version or upgrade to it yourself)
• @dependabot ignore <dependency name> minor version will close this group update PR and stop Dependabot creating any more for the specific dependency's minor version (unless you unignore this specific dependency's minor version or upgrade to it yourself)
• @dependabot ignore <dependency name> will close this group update PR and stop Dependabot creating any more for the specific dependency (unless you unignore this specific dependency or upgrade to it yourself)
• @dependabot unignore <dependency name> will remove all of the ignore conditions of the specified dependency
• @dependabot unignore <dependency name> <ignore condition> will remove the ignore condition of the specified dependency and ignore conditions