71 Commits
2.2.3 ... 2.3.2

Author SHA1 Message Date
Tyrrrz
eff84fd7ae Update version 2023-04-06 12:40:49 +03:00
Tyrrrz
f66fa97b87 Add Microsoft.CodeAnalysis.Analyzers to the analyzer project 2023-04-06 12:40:44 +03:00
Tyrrrz
9f309b5d4a Update NuGet packages 2023-04-06 12:30:15 +03:00
Tyrrrz
456099591a Sort commands also in the "subcommands" section 2023-04-06 12:27:11 +03:00
Tyrrrz
bf7f607f9b Clean up 2023-04-06 12:26:49 +03:00
Tyrrrz
a4041ab019 Update NuGet packages 2023-04-05 13:06:48 +03:00
Tyrrrz
a0fde872ec Replace polyfills with PolyShim 2023-04-04 13:48:14 +03:00
Dominique Louis
f0c040c7b9 Sort commands by name in help text (#134) 2023-04-01 03:04:56 +03:00
Tyrrrz
a09818d452 Rework the readme 2023-03-02 11:42:03 +02:00
Tyrrrz
1c331df4b1 Update NuGet packages 2023-03-01 11:10:44 +02:00
Tyrrrz
dc20fe9730 Use STJ in the demo instead of Newtonsoft.Json 2023-02-20 03:40:51 +02:00
Tyrrrz
31ae0271b9 Cleanup 2023-02-11 21:42:33 +02:00
Tyrrrz
6ed6d2ced9 Make changelog headings more consistent 2023-02-05 10:02:14 +02:00
Oleksii Holub
01a4846159 Hyphenate "command-line" 2023-02-01 12:32:21 +02:00
Tyrrrz
02dc7de127 Update readme 2023-01-10 22:42:24 +02:00
Oleksii Holub
a1ff1a1539 Update readme 2022-12-24 01:06:00 +02:00
Tyrrrz
a02951f755 Refactor tests 2022-12-16 20:49:11 +02:00
Tyrrrz
7cb25254e8 Fix CI banner in the readme 2022-12-16 20:39:21 +02:00
Tyrrrz
3d9ad16117 More simplification 2022-12-13 03:24:23 +02:00
Tyrrrz
d0ad3bc45d Deal with environment variable casing in a more versatile way 2022-12-13 03:18:28 +02:00
Oleksii Holub
6541ce568d Update readme 2022-12-11 03:39:37 +02:00
Oleksii Holub
32d3b66185 Use PolySharp 2022-12-11 01:26:40 +02:00
Oleksii Holub
48f157a51e Update version 2022-12-08 21:57:42 +02:00
Oleksii Holub
b1995fa4f7 Update NuGet packages 2022-12-08 21:54:27 +02:00
Oleksii Holub
74bc973f77 Fix typo 2022-12-08 21:53:09 +02:00
Oleksii Holub
3420c3d039 Make test naming more consistent 2022-12-08 21:51:31 +02:00
Oleksii Holub
b10577fec5 Add integration with the new required keyword
Closes #132
2022-12-08 21:46:14 +02:00
Oleksii Holub
af96d0d31d Remove unused usings 2022-12-08 03:45:09 +02:00
Oleksii Holub
bd29ad31cc More raw string literals 2022-12-08 03:33:10 +02:00
Oleksii Holub
15150cb3ed Add required modifiers 2022-12-08 03:08:58 +02:00
Oleksii Holub
aac9c968eb Use raw string literals 2022-12-08 03:06:31 +02:00
Tyrrrz
85a9f157ad Update NuGet packages 2022-12-08 01:48:11 +02:00
Tyrrrz
d24a79361d Use net6.0 2022-12-08 01:47:30 +02:00
Oleksii Holub
5785720f31 Update readme 2022-11-30 14:23:22 +02:00
Oleksii Holub
3f6f0b9f1b Typo in readme: 'runtime' -> 'run-time' 2022-11-21 01:12:24 +02:00
Tyrrrz
128bb5be8b Clean up project items and update NuGet packages 2022-11-02 23:10:18 +02:00
Tyrrrz
36b3814f4e Cleanup 2022-10-12 22:53:18 +03:00
Tyrrrz
c4a975d5f1 Update NuGet Packages 2022-10-12 22:50:31 +03:00
Oleksii Holub
79d86d39c1 Move into maintenance mode 2022-08-26 18:00:10 +03:00
Oleksii Holub
c476700168 Update readme 2022-07-15 03:14:41 -07:00
Oleksii Holub
5e97ebe7f0 Update version 2022-07-12 13:31:07 +03:00
Oleksii Holub
64cbdaaeab Add console dimension properties to IConsole
Closes #90
2022-06-28 15:38:10 +03:00
Oleksii Holub
ae1f03914c Update version 2022-06-14 22:34:55 +03:00
Oleksii Holub
ff25dccf8a Add overload of UseTypeActivator(...) that accepts an instance of IServiceProvider 2022-06-07 20:08:34 +03:00
Oleksii Holub
6e0d881682 Use new alerts in readme 2022-05-31 12:41:32 +03:00
Oleksii Holub
89fd42888a Update readme 2022-05-31 12:25:18 +03:00
Oleksii Holub
eeac82a6e7 Update nuget packages 2022-05-29 22:33:54 +03:00
Oleksii Holub
c641c6fbe2 Improve grammar in error messages 2022-05-26 22:21:31 +03:00
Oleksii Holub
5ec732fe9a Update version 2022-05-09 23:27:55 +03:00
Oleksii Holub
6d87411dbf Update NuGet packages 2022-05-09 23:27:33 +03:00
Oleksii Holub
ed3054c855 More consistent code style 2022-04-25 19:07:18 +03:00
Oleksii Holub
5d00de4dfe Update CliWrap 2022-04-25 19:05:23 +03:00
Oleksii Holub
016ec8b186 Make default executable name resolution smarter 2022-04-24 23:45:10 +03:00
Oleksii Holub
9141092919 Merge branch 'master' of github.com:Tyrrrz/CliFx 2022-04-24 22:59:49 +03:00
Oleksii Holub
1fe97b0140 Typo in docs 2022-04-24 22:59:38 +03:00
Oleksii Holub
6ad5989c25 Update readme 2022-04-24 19:54:37 +00:00
Oleksii Holub
7e1db916fc Update readme 2022-04-23 21:26:54 +00:00
Oleksii Holub
1c69d5c80d Update readme 2022-04-23 23:44:22 +03:00
Oleksii Holub
ab87225f1f Cleanup 2022-04-22 22:33:55 +03:00
Oleksii Holub
6d33c5cdad Update version 2022-04-22 19:15:44 +03:00
Oleksii Holub
e4c899c6c2 Reduce version of Microsoft.CodeAnalysis.CSharp further 2022-04-22 18:55:47 +03:00
Oleksii Holub
35b3ad0d63 Don't use Fody but also don't bundle Microsoft.CodeAnalysis.CSharp 2022-04-22 18:45:46 +03:00
Oleksii Holub
4e70557b47 Reorganize assets 2022-04-22 17:16:51 +03:00
Oleksii Holub
0a8d58255a Update NuGet.config 2022-04-22 16:58:21 +03:00
Oleksii Holub
d3fbc9c643 Merge analyzer project dependencies using Fody.Costura
Closes #127
2022-04-22 16:41:24 +03:00
Oleksii Holub
1cbf8776be Don't produce color codes in tests 2022-04-21 22:57:14 +03:00
Oleksii Holub
16e33f7b8f Update workflow 2022-04-21 22:51:11 +03:00
Oleksii Holub
5c848056c5 Add more contextual information to diagnostics 2022-04-20 20:27:53 +03:00
Oleksii Holub
864efd3179 Fix converter analyzer false positive when handling non-scalars or nullable types 2022-04-20 20:09:14 +03:00
Oleksii Holub
7f206a0c77 Update test logger 2022-04-19 01:31:40 +00:00
Oleksii Holub
22c15f8ec6 Update test logger 2022-04-18 19:53:52 +00:00
118 changed files with 3820 additions and 2932 deletions

View File

Before

Width:  |  Height:  |  Size: 14 KiB

After

Width:  |  Height:  |  Size: 14 KiB

View File

@@ -1,5 +1,8 @@
blank_issues_enabled: false blank_issues_enabled: false
contact_links: contact_links:
- name: ⚠ Feature request
url: https://github.com/Tyrrrz/.github/blob/master/docs/project-status.md
about: Sorry, but this project is in maintenance mode and no longer accepts new feature requests.
- name: 💬 Discord server - name: 💬 Discord server
url: https://discord.gg/2SUWKFnHSm url: https://discord.gg/2SUWKFnHSm
about: Chat with the project community. about: Chat with the project community.

View File

@@ -1,22 +0,0 @@
name: ✨ Feature request
description: Request a new feature.
labels: [enhancement]
body:
- type: markdown
attributes:
value: |
🧐 **Guidelines:**
- Search through [existing issues](https://github.com/Tyrrrz/CliFx/issues?q=is%3Aissue) first to ensure that this feature has not been requested before.
- Write a descriptive title for your issue. Avoid generic or vague titles such as "Some suggestions" or "Ideas for improvement".
- Keep your issue focused on one single problem. If you have multiple feature requests, please create separate issues for each of them.
- Provide as much context as possible in the details section. Include screenshots, screen recordings, links, references, or anything else you may consider relevant.
- If you want to ask a question instead of requesting a feature, please use [discussions](https://github.com/Tyrrrz/CliFx/discussions/new) instead.
- type: textarea
attributes:
label: Details
description: Clear and thorough explanation of the feature you have in mind.
validations:
required: true

View File

@@ -4,7 +4,9 @@ on: [push, pull_request]
jobs: jobs:
main: main:
uses: Tyrrrz/.github/.github/workflows/NuGet.yml@master uses: Tyrrrz/.github/.github/workflows/nuget.yml@master
with:
dotnet-version: 7.0.x
secrets: secrets:
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }} CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
NUGET_TOKEN: ${{ secrets.NUGET_TOKEN }} NUGET_TOKEN: ${{ secrets.NUGET_TOKEN }}

View File

@@ -1,4 +1,34 @@
### v2.2.3 (17-Apr-2022) # Changelog
## 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)
- 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)
- 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)
- 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)
- 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)
- 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). - 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. - Added `FakeConsole.EnqueueKey(...)` to facilitate the testing of `IConsole.ReadKey()`. You can use this method to simulate key presses in your application.
@@ -6,57 +36,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. - 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. - 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 `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. - 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)) - 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)) - 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)) - 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.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)) - 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)) - 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. - 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. - Fixed an issue where calling `IConsole.Output.Encoding.EncodingName` and some other members threw an exception.
- Added readme file to the package. - 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 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 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 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. - 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)) - 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 an issue where having a transitive reference to CliFx sometimes resulted in `SystemConsoleShouldBeAvoidedAnalyzer` throwing `NullReferenceException` during build.
- Fixed some documentation typos and inconsistencies. - 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 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. - 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. > Note: this major release includes many breaking changes.
> Please refer to the readme to find updated instructions and usage examples. > Please refer to the readme to find updated instructions and usage examples.
@@ -76,7 +106,7 @@
- Assigned separate colors to parameters and options to make them visually stand out - Assigned separate colors to parameters and options to make them visually stand out
- Usage section no longer lists usage formats of all descendant commands - 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 - 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 `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. - 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. - 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.
@@ -90,34 +120,34 @@
- `ITypeActivator`/`DefaultTypeActivator`/`DelegateTypeActivator` moved from `CliFx` to `CliFx.Infrastructure` - `ITypeActivator`/`DefaultTypeActivator`/`DelegateTypeActivator` moved from `CliFx` to `CliFx.Infrastructure`
- `BindingValidator`/`BindingConverter` moved from `CliFx` to `CliFx.Extensibility` - `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 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. - 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`. - 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 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)) - 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)) - 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 `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`. - 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 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)) - 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)) - 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)) - 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. - 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)) - 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))
@@ -125,7 +155,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. - 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. - 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 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)) - 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))
@@ -136,7 +166,7 @@
- Improved exception messages. - 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)) - 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 `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. - 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.

View File

@@ -1,7 +1,7 @@
<Project Sdk="Microsoft.NET.Sdk"> <Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup> <PropertyGroup>
<TargetFramework>net6.0</TargetFramework> <TargetFramework>net7.0</TargetFramework>
</PropertyGroup> </PropertyGroup>
<ItemGroup> <ItemGroup>
@@ -9,14 +9,14 @@
</ItemGroup> </ItemGroup>
<ItemGroup> <ItemGroup>
<PackageReference Include="Basic.Reference.Assemblies" Version="1.2.4" /> <PackageReference Include="Basic.Reference.Assemblies.Net70" Version="1.4.1" />
<PackageReference Include="GitHubActionsTestLogger" Version="1.3.0" PrivateAssets="all" /> <PackageReference Include="GitHubActionsTestLogger" Version="2.0.1" PrivateAssets="all" />
<PackageReference Include="FluentAssertions" Version="6.5.1" /> <PackageReference Include="FluentAssertions" Version="6.10.0" />
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.1.0" /> <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.5.0" />
<PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.1.0" /> <PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.5.0" />
<PackageReference Include="xunit" Version="2.4.1" /> <PackageReference Include="xunit" Version="2.4.2" />
<PackageReference Include="xunit.runner.visualstudio" Version="2.4.3" PrivateAssets="all" /> <PackageReference Include="xunit.runner.visualstudio" Version="2.4.5" PrivateAssets="all" />
<PackageReference Include="coverlet.collector" Version="3.1.2" PrivateAssets="all" /> <PackageReference Include="coverlet.collector" Version="3.2.0" PrivateAssets="all" />
</ItemGroup> </ItemGroup>
<ItemGroup> <ItemGroup>

View File

@@ -13,11 +13,13 @@ public class CommandMustBeAnnotatedAnalyzerSpecs
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
public class MyCommand : ICommand """
{ public class MyCommand : ICommand
public ValueTask ExecuteAsync(IConsole console) => default; {
}"; public ValueTask ExecuteAsync(IConsole console) => default;
}
""";
// Act & assert // Act & assert
Analyzer.Should().ProduceDiagnostics(code); Analyzer.Should().ProduceDiagnostics(code);
@@ -28,12 +30,14 @@ public class MyCommand : ICommand
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public abstract class MyCommand : ICommand [Command]
{ public abstract class MyCommand : ICommand
public ValueTask ExecuteAsync(IConsole console) => default; {
}"; public ValueTask ExecuteAsync(IConsole console) => default;
}
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -44,11 +48,13 @@ public abstract class MyCommand : ICommand
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
public abstract class MyCommand : ICommand """
{ public abstract class MyCommand : ICommand
public ValueTask ExecuteAsync(IConsole console) => default; {
}"; public ValueTask ExecuteAsync(IConsole console) => default;
}
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -59,11 +65,13 @@ public abstract class MyCommand : ICommand
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
public class Foo """
{ public class Foo
public int Bar { get; set; } = 5; {
}"; public int Bar { get; set; } = 5;
}
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);

View File

@@ -13,12 +13,14 @@ public class CommandMustImplementInterfaceAnalyzerSpecs
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand [Command]
{ public class MyCommand
public ValueTask ExecuteAsync(IConsole console) => default; {
}"; public ValueTask ExecuteAsync(IConsole console) => default;
}
""";
// Act & assert // Act & assert
Analyzer.Should().ProduceDiagnostics(code); Analyzer.Should().ProduceDiagnostics(code);
@@ -29,12 +31,14 @@ public class MyCommand
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
public ValueTask ExecuteAsync(IConsole console) => default; {
}"; public ValueTask ExecuteAsync(IConsole console) => default;
}
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -45,11 +49,13 @@ public class MyCommand : ICommand
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
public class Foo """
{ public class Foo
public int Bar { get; set; } = 5; {
}"; public int Bar { get; set; } = 5;
}
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);

View File

@@ -13,12 +13,14 @@ public class OptionMustBeInsideCommandAnalyzerSpecs
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
public class MyClass """
{ public class MyClass
[CommandOption(""foo"")] {
public string Foo { get; set; } [CommandOption("foo")]
}"; public string Foo { get; set; }
}
""";
// Act & assert // Act & assert
Analyzer.Should().ProduceDiagnostics(code); Analyzer.Should().ProduceDiagnostics(code);
@@ -29,15 +31,17 @@ public class MyClass
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
[CommandOption(""foo"")] {
public string Foo { get; set; } [CommandOption("foo")]
public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -48,12 +52,14 @@ public class MyCommand : ICommand
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
public abstract class MyCommand """
{ public abstract class MyCommand
[CommandOption(""foo"")] {
public string Foo { get; set; } [CommandOption("foo")]
}"; public string Foo { get; set; }
}
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -64,14 +70,16 @@ public abstract class MyCommand
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
public string Foo { get; set; } {
public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);

View File

@@ -0,0 +1,114 @@
using CliFx.Analyzers.Tests.Utils;
using Microsoft.CodeAnalysis.Diagnostics;
using Xunit;
namespace CliFx.Analyzers.Tests;
public class OptionMustBeRequiredIfPropertyRequiredAnalyzerSpecs
{
private static DiagnosticAnalyzer Analyzer { get; } = new OptionMustBeRequiredIfPropertyRequiredAnalyzer();
[Fact]
public void Analyzer_reports_an_error_if_a_non_required_option_is_bound_to_a_required_property()
{
// Arrange
// language=cs
const string code =
"""
[Command]
public class MyCommand : ICommand
{
[CommandOption('f', IsRequired = false)]
public required string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default;
}
""";
// Act & assert
Analyzer.Should().ProduceDiagnostics(code);
}
[Fact]
public void Analyzer_does_not_report_an_error_if_a_required_option_is_bound_to_a_required_property()
{
// Arrange
// language=cs
const string code =
"""
[Command]
public class MyCommand : ICommand
{
[CommandOption('f', IsRequired = true)]
public required string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default;
}
""";
// Act & assert
Analyzer.Should().NotProduceDiagnostics(code);
}
[Fact]
public void Analyzer_does_not_report_an_error_if_a_non_required_option_is_bound_to_a_non_required_property()
{
// Arrange
// language=cs
const string code =
"""
[Command]
public class MyCommand : ICommand
{
[CommandOption('f', IsRequired = false)]
public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default;
}
""";
// Act & assert
Analyzer.Should().NotProduceDiagnostics(code);
}
[Fact]
public void Analyzer_does_not_report_an_error_if_a_required_option_is_bound_to_a_non_required_property()
{
// Arrange
// language=cs
const string code =
"""
[Command]
public class MyCommand : ICommand
{
[CommandOption('f', IsRequired = true)]
public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default;
}
""";
// Act & assert
Analyzer.Should().NotProduceDiagnostics(code);
}
[Fact]
public void Analyzer_does_not_report_an_error_on_a_property_that_is_not_an_option()
{
// Arrange
// language=cs
const string code =
"""
[Command]
public class MyCommand : ICommand
{
public required string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default;
}
""";
// Act & assert
Analyzer.Should().NotProduceDiagnostics(code);
}
}

View File

@@ -13,15 +13,17 @@ public class OptionMustHaveNameOrShortNameAnalyzerSpecs
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
[CommandOption(null)] {
public string Foo { get; set; } [CommandOption(null)]
public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().ProduceDiagnostics(code); Analyzer.Should().ProduceDiagnostics(code);
@@ -32,15 +34,17 @@ public class MyCommand : ICommand
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
[CommandOption(""foo"")] {
public string Foo { get; set; } [CommandOption("foo")]
public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -51,15 +55,17 @@ public class MyCommand : ICommand
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
[CommandOption('f')] {
public string Foo { get; set; } [CommandOption('f')]
public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -70,14 +76,16 @@ public class MyCommand : ICommand
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
public string Foo { get; set; } {
public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);

View File

@@ -13,18 +13,20 @@ public class OptionMustHaveUniqueNameAnalyzerSpecs
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
[CommandOption(""foo"")] {
public string Foo { get; set; } [CommandOption("foo")]
public string Foo { get; set; }
[CommandOption(""foo"")] [CommandOption("foo")]
public string Bar { get; set; } public string Bar { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().ProduceDiagnostics(code); Analyzer.Should().ProduceDiagnostics(code);
@@ -35,18 +37,20 @@ public class MyCommand : ICommand
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
[CommandOption(""foo"")] {
public string Foo { get; set; } [CommandOption("foo")]
public string Foo { get; set; }
[CommandOption(""bar"")] [CommandOption("bar")]
public string Bar { get; set; } public string Bar { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -57,15 +61,17 @@ public class MyCommand : ICommand
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
[CommandOption('f')] {
public string Foo { get; set; } [CommandOption('f')]
public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -76,14 +82,16 @@ public class MyCommand : ICommand
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
public string Foo { get; set; } {
public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);

View File

@@ -13,18 +13,20 @@ public class OptionMustHaveUniqueShortNameAnalyzerSpecs
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
[CommandOption('f')] {
public string Foo { get; set; } [CommandOption('f')]
public string Foo { get; set; }
[CommandOption('f')] [CommandOption('f')]
public string Bar { get; set; } public string Bar { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().ProduceDiagnostics(code); Analyzer.Should().ProduceDiagnostics(code);
@@ -35,18 +37,20 @@ public class MyCommand : ICommand
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
[CommandOption('f')] {
public string Foo { get; set; } [CommandOption('f')]
public string Foo { get; set; }
[CommandOption('b')] [CommandOption('b')]
public string Bar { get; set; } public string Bar { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -57,18 +61,20 @@ public class MyCommand : ICommand
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
[CommandOption('f')] {
public string Foo { get; set; } [CommandOption('f')]
public string Foo { get; set; }
[CommandOption('F')] [CommandOption('F')]
public string Bar { get; set; } public string Bar { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -79,15 +85,17 @@ public class MyCommand : ICommand
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
[CommandOption(""foo"")] {
public string Foo { get; set; } [CommandOption("foo")]
public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -98,14 +106,16 @@ public class MyCommand : ICommand
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
public string Foo { get; set; } {
public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);

View File

@@ -9,72 +9,130 @@ public class OptionMustHaveValidConverterAnalyzerSpecs
private static DiagnosticAnalyzer Analyzer { get; } = new OptionMustHaveValidConverterAnalyzer(); private static DiagnosticAnalyzer Analyzer { get; } = new OptionMustHaveValidConverterAnalyzer();
[Fact] [Fact]
public void Analyzer_reports_an_error_if_the_specified_option_converter_does_not_derive_from_BindingConverter() public void Analyzer_reports_an_error_if_an_option_has_a_converter_that_does_not_derive_from_BindingConverter()
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
public class MyConverter """
{ public class MyConverter
public string Convert(string rawValue) => rawValue; {
} public string Convert(string rawValue) => rawValue;
}
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
[CommandOption(""foo"", Converter = typeof(MyConverter))] [CommandOption("foo", Converter = typeof(MyConverter))]
public string Foo { get; set; } public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().ProduceDiagnostics(code); Analyzer.Should().ProduceDiagnostics(code);
} }
[Fact] [Fact]
public void Analyzer_reports_an_error_if_the_specified_option_converter_does_not_derive_from_a_compatible_BindingConverter() public void Analyzer_reports_an_error_if_an_option_has_a_converter_that_does_not_derive_from_a_compatible_BindingConverter()
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
public class MyConverter : BindingConverter<int> """
{ public class MyConverter : BindingConverter<int>
public override int Convert(string rawValue) => 42; {
} public override int Convert(string rawValue) => 42;
}
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
[CommandOption(""foo"", Converter = typeof(MyConverter))] [CommandOption("foo", Converter = typeof(MyConverter))]
public string Foo { get; set; } public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().ProduceDiagnostics(code); Analyzer.Should().ProduceDiagnostics(code);
} }
[Fact] [Fact]
public void Analyzer_does_not_report_an_error_if_the_specified_option_converter_derives_from_a_compatible_BindingConverter() public void Analyzer_does_not_report_an_error_if_an_option_has_a_converter_that_derives_from_a_compatible_BindingConverter()
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
public class MyConverter : BindingConverter<string> """
{ public class MyConverter : BindingConverter<string>
public override string Convert(string rawValue) => rawValue; {
} public override string Convert(string rawValue) => rawValue;
}
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
[CommandOption(""foo"", Converter = typeof(MyConverter))] [CommandOption("foo", Converter = typeof(MyConverter))]
public string Foo { get; set; } public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert
Analyzer.Should().NotProduceDiagnostics(code);
}
[Fact]
public void Analyzer_does_not_report_an_error_if_a_nullable_option_has_a_converter_that_derives_from_a_compatible_BindingConverter()
{
// Arrange
// language=cs
const string code =
"""
public class MyConverter : BindingConverter<int>
{
public override int Convert(string rawValue) => 42;
}
[Command]
public class MyCommand : ICommand
{
[CommandOption("foo", Converter = typeof(MyConverter))]
public int? Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default;
}
""";
// Act & assert
Analyzer.Should().NotProduceDiagnostics(code);
}
[Fact]
public void Analyzer_does_not_report_an_error_if_a_non_scalar_option_has_a_converter_that_derives_from_a_compatible_BindingConverter()
{
// Arrange
// language=cs
const string code =
"""
public class MyConverter : BindingConverter<string>
{
public override string Convert(string rawValue) => rawValue;
}
[Command]
public class MyCommand : ICommand
{
[CommandOption("foo", Converter = typeof(MyConverter))]
public IReadOnlyList<string> Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default;
}
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -85,15 +143,17 @@ public class MyCommand : ICommand
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
[CommandOption(""foo"")] {
public string Foo { get; set; } [CommandOption("foo")]
public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -104,14 +164,16 @@ public class MyCommand : ICommand
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
public string Foo { get; set; } {
public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);

View File

@@ -13,15 +13,17 @@ public class OptionMustHaveValidNameAnalyzerSpecs
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
[CommandOption(""f"")] {
public string Foo { get; set; } [CommandOption("f")]
public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().ProduceDiagnostics(code); Analyzer.Should().ProduceDiagnostics(code);
@@ -32,15 +34,17 @@ public class MyCommand : ICommand
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
[CommandOption(""1foo"")] {
public string Foo { get; set; } [CommandOption("1foo")]
public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().ProduceDiagnostics(code); Analyzer.Should().ProduceDiagnostics(code);
@@ -51,15 +55,17 @@ public class MyCommand : ICommand
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
[CommandOption(""foo"")] {
public string Foo { get; set; } [CommandOption("foo")]
public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -70,15 +76,17 @@ public class MyCommand : ICommand
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
[CommandOption('f')] {
public string Foo { get; set; } [CommandOption('f')]
public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -89,14 +97,16 @@ public class MyCommand : ICommand
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
public string Foo { get; set; } {
public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);

View File

@@ -13,15 +13,17 @@ public class OptionMustHaveValidShortNameAnalyzerSpecs
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
[CommandOption('1')] {
public string Foo { get; set; } [CommandOption('1')]
public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().ProduceDiagnostics(code); Analyzer.Should().ProduceDiagnostics(code);
@@ -32,15 +34,17 @@ public class MyCommand : ICommand
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
[CommandOption('f')] {
public string Foo { get; set; } [CommandOption('f')]
public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -51,15 +55,17 @@ public class MyCommand : ICommand
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
[CommandOption(""foo"")] {
public string Foo { get; set; } [CommandOption("foo")]
public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -70,14 +76,16 @@ public class MyCommand : ICommand
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
public string Foo { get; set; } {
public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);

View File

@@ -9,72 +9,78 @@ public class OptionMustHaveValidValidatorsAnalyzerSpecs
private static DiagnosticAnalyzer Analyzer { get; } = new OptionMustHaveValidValidatorsAnalyzer(); private static DiagnosticAnalyzer Analyzer { get; } = new OptionMustHaveValidValidatorsAnalyzer();
[Fact] [Fact]
public void Analyzer_reports_an_error_if_one_of_the_specified_option_validators_does_not_derive_from_BindingValidator() public void Analyzer_reports_an_error_if_an_option_has_a_validator_that_does_not_derive_from_BindingValidator()
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
public class MyValidator """
{ public class MyValidator
public void Validate(string value) {} {
} public void Validate(string value) {}
}
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
[CommandOption(""foo"", Validators = new[] {typeof(MyValidator)})] [CommandOption("foo", Validators = new[] {typeof(MyValidator)})]
public string Foo { get; set; } public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().ProduceDiagnostics(code); Analyzer.Should().ProduceDiagnostics(code);
} }
[Fact] [Fact]
public void Analyzer_reports_an_error_if_one_of_the_specified_option_validators_does_not_derive_from_a_compatible_BindingValidator() public void Analyzer_reports_an_error_if_an_option_has_a_validator_that_does_not_derive_from_a_compatible_BindingValidator()
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
public class MyValidator : BindingValidator<int> """
{ public class MyValidator : BindingValidator<int>
public override BindingValidationError Validate(int value) => Ok(); {
} public override BindingValidationError Validate(int value) => Ok();
}
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
[CommandOption(""foo"", Validators = new[] {typeof(MyValidator)})] [CommandOption("foo", Validators = new[] {typeof(MyValidator)})]
public string Foo { get; set; } public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().ProduceDiagnostics(code); Analyzer.Should().ProduceDiagnostics(code);
} }
[Fact] [Fact]
public void Analyzer_does_not_report_an_error_if_each_specified_option_validator_derives_from_a_compatible_BindingValidator() public void Analyzer_does_not_report_an_error_if_an_option_has_validators_that_all_derive_from_compatible_BindingValidators()
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
public class MyValidator : BindingValidator<string> """
{ public class MyValidator : BindingValidator<string>
public override BindingValidationError Validate(string value) => Ok(); {
} public override BindingValidationError Validate(string value) => Ok();
}
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
[CommandOption(""foo"", Validators = new[] {typeof(MyValidator)})] [CommandOption("foo", Validators = new[] {typeof(MyValidator)})]
public string Foo { get; set; } public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -85,15 +91,17 @@ public class MyCommand : ICommand
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
[CommandOption(""foo"")] {
public string Foo { get; set; } [CommandOption("foo")]
public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -104,14 +112,16 @@ public class MyCommand : ICommand
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
public string Foo { get; set; } {
public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);

View File

@@ -13,12 +13,14 @@ public class ParameterMustBeInsideCommandAnalyzerSpecs
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
public class MyClass """
{ public class MyClass
[CommandParameter(0)] {
public string Foo { get; set; } [CommandParameter(0)]
}"; public string Foo { get; set; }
}
""";
// Act & assert // Act & assert
Analyzer.Should().ProduceDiagnostics(code); Analyzer.Should().ProduceDiagnostics(code);
@@ -29,15 +31,17 @@ public class MyClass
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
[CommandParameter(0)] {
public string Foo { get; set; } [CommandParameter(0)]
public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -48,12 +52,14 @@ public class MyCommand : ICommand
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
public abstract class MyCommand """
{ public abstract class MyCommand
[CommandParameter(0)] {
public string Foo { get; set; } [CommandParameter(0)]
}"; public string Foo { get; set; }
}
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -64,14 +70,16 @@ public abstract class MyCommand
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
public string Foo { get; set; } {
public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);

View File

@@ -13,18 +13,20 @@ public class ParameterMustBeLastIfNonRequiredAnalyzerSpecs
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
[CommandParameter(0, Name = ""foo"", IsRequired = false)] {
public string Foo { get; set; } [CommandParameter(0, IsRequired = false)]
public string Foo { get; set; }
[CommandParameter(1, Name = ""bar"")] [CommandParameter(1)]
public string Bar { get; set; } public string Bar { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().ProduceDiagnostics(code); Analyzer.Should().ProduceDiagnostics(code);
@@ -35,18 +37,20 @@ public class MyCommand : ICommand
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
[CommandParameter(0, Name = ""foo"")] {
public string Foo { get; set; } [CommandParameter(0)]
public string Foo { get; set; }
[CommandParameter(1, Name = ""bar"", IsRequired = false)] [CommandParameter(1, IsRequired = false)]
public string Bar { get; set; } public string Bar { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -57,18 +61,20 @@ public class MyCommand : ICommand
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
[CommandParameter(0, Name = ""foo"")] {
public string Foo { get; set; } [CommandParameter(0)]
public string Foo { get; set; }
[CommandParameter(1, Name = ""bar"", IsRequired = true)] [CommandParameter(1, IsRequired = true)]
public string Bar { get; set; } public string Bar { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -79,14 +85,16 @@ public class MyCommand : ICommand
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
public string Foo { get; set; } {
public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);

View File

@@ -13,18 +13,20 @@ public class ParameterMustBeLastIfNonScalarAnalyzerSpecs
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
[CommandParameter(0)] {
public string[] Foo { get; set; } [CommandParameter(0)]
public string[] Foo { get; set; }
[CommandParameter(1)] [CommandParameter(1)]
public string Bar { get; set; } public string Bar { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().ProduceDiagnostics(code); Analyzer.Should().ProduceDiagnostics(code);
@@ -35,18 +37,20 @@ public class MyCommand : ICommand
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
[CommandParameter(0)] {
public string Foo { get; set; } [CommandParameter(0)]
public string Foo { get; set; }
[CommandParameter(1)] [CommandParameter(1)]
public string[] Bar { get; set; } public string[] Bar { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -57,18 +61,20 @@ public class MyCommand : ICommand
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
[CommandParameter(0)] {
public string Foo { get; set; } [CommandParameter(0)]
public string Foo { get; set; }
[CommandParameter(1)] [CommandParameter(1)]
public string Bar { get; set; } public string Bar { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -79,14 +85,16 @@ public class MyCommand : ICommand
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
public string Foo { get; set; } {
public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);

View File

@@ -0,0 +1,114 @@
using CliFx.Analyzers.Tests.Utils;
using Microsoft.CodeAnalysis.Diagnostics;
using Xunit;
namespace CliFx.Analyzers.Tests;
public class ParameterMustBeRequiredIfPropertyRequiredAnalyzerSpecs
{
private static DiagnosticAnalyzer Analyzer { get; } = new ParameterMustBeRequiredIfPropertyRequiredAnalyzer();
[Fact]
public void Analyzer_reports_an_error_if_a_non_required_parameter_is_bound_to_a_required_property()
{
// Arrange
// language=cs
const string code =
"""
[Command]
public class MyCommand : ICommand
{
[CommandParameter(0, IsRequired = false)]
public required string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default;
}
""";
// Act & assert
Analyzer.Should().ProduceDiagnostics(code);
}
[Fact]
public void Analyzer_does_not_report_an_error_if_a_required_parameter_is_bound_to_a_required_property()
{
// Arrange
// language=cs
const string code =
"""
[Command]
public class MyCommand : ICommand
{
[CommandParameter(0, IsRequired = true)]
public required string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default;
}
""";
// Act & assert
Analyzer.Should().NotProduceDiagnostics(code);
}
[Fact]
public void Analyzer_does_not_report_an_error_if_a_non_required_parameter_is_bound_to_a_non_required_property()
{
// Arrange
// language=cs
const string code =
"""
[Command]
public class MyCommand : ICommand
{
[CommandParameter(0, IsRequired = false)]
public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default;
}
""";
// Act & assert
Analyzer.Should().NotProduceDiagnostics(code);
}
[Fact]
public void Analyzer_does_not_report_an_error_if_a_required_parameter_is_bound_to_a_non_required_property()
{
// Arrange
// language=cs
const string code =
"""
[Command]
public class MyCommand : ICommand
{
[CommandParameter(0, IsRequired = true)]
public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default;
}
""";
// Act & assert
Analyzer.Should().NotProduceDiagnostics(code);
}
[Fact]
public void Analyzer_does_not_report_an_error_on_a_property_that_is_not_a_parameter()
{
// Arrange
// language=cs
const string code =
"""
[Command]
public class MyCommand : ICommand
{
public required string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default;
}
""";
// Act & assert
Analyzer.Should().NotProduceDiagnostics(code);
}
}

View File

@@ -13,18 +13,20 @@ public class ParameterMustBeSingleIfNonRequiredAnalyzerSpecs
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
[CommandParameter(0, IsRequired = false)] {
public string Foo { get; set; } [CommandParameter(0, IsRequired = false)]
public string Foo { get; set; }
[CommandParameter(1, IsRequired = false)] [CommandParameter(1, IsRequired = false)]
public string Bar { get; set; } public string Bar { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().ProduceDiagnostics(code); Analyzer.Should().ProduceDiagnostics(code);
@@ -35,18 +37,20 @@ public class MyCommand : ICommand
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
[CommandParameter(0)] {
public string Foo { get; set; } [CommandParameter(0)]
public string Foo { get; set; }
[CommandParameter(1, IsRequired = false)] [CommandParameter(1, IsRequired = false)]
public string Bar { get; set; } public string Bar { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -57,18 +61,20 @@ public class MyCommand : ICommand
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
[CommandParameter(0)] {
public string Foo { get; set; } [CommandParameter(0)]
public string Foo { get; set; }
[CommandParameter(1, IsRequired = true)] [CommandParameter(1, IsRequired = true)]
public string Bar { get; set; } public string Bar { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -79,14 +85,16 @@ public class MyCommand : ICommand
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
public string Foo { get; set; } {
public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);

View File

@@ -13,18 +13,20 @@ public class ParameterMustBeSingleIfNonScalarAnalyzerSpecs
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
[CommandParameter(0)] {
public string[] Foo { get; set; } [CommandParameter(0)]
public string[] Foo { get; set; }
[CommandParameter(1)] [CommandParameter(1)]
public string[] Bar { get; set; } public string[] Bar { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().ProduceDiagnostics(code); Analyzer.Should().ProduceDiagnostics(code);
@@ -35,18 +37,20 @@ public class MyCommand : ICommand
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
[CommandParameter(0)] {
public string Foo { get; set; } [CommandParameter(0)]
public string Foo { get; set; }
[CommandParameter(1)] [CommandParameter(1)]
public string[] Bar { get; set; } public string[] Bar { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -57,18 +61,20 @@ public class MyCommand : ICommand
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
[CommandParameter(0)] {
public string Foo { get; set; } [CommandParameter(0)]
public string Foo { get; set; }
[CommandParameter(1)] [CommandParameter(1)]
public string Bar { get; set; } public string Bar { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -79,14 +85,16 @@ public class MyCommand : ICommand
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
public string Foo { get; set; } {
public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);

View File

@@ -13,18 +13,20 @@ public class ParameterMustHaveUniqueNameAnalyzerSpecs
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
[CommandParameter(0, Name = ""foo"")] {
public string Foo { get; set; } [CommandParameter(0, Name = "foo")]
public string Foo { get; set; }
[CommandParameter(1, Name = ""foo"")] [CommandParameter(1, Name = "foo")]
public string Bar { get; set; } public string Bar { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().ProduceDiagnostics(code); Analyzer.Should().ProduceDiagnostics(code);
@@ -35,18 +37,20 @@ public class MyCommand : ICommand
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
[CommandParameter(0, Name = ""foo"")] {
public string Foo { get; set; } [CommandParameter(0, Name = "foo")]
public string Foo { get; set; }
[CommandParameter(1, Name = ""bar"")] [CommandParameter(1, Name = "bar")]
public string Bar { get; set; } public string Bar { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -57,14 +61,16 @@ public class MyCommand : ICommand
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
public string Foo { get; set; } {
public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);

View File

@@ -13,18 +13,20 @@ public class ParameterMustHaveUniqueOrderAnalyzerSpecs
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
[CommandParameter(0)] {
public string Foo { get; set; } [CommandParameter(0)]
public string Foo { get; set; }
[CommandParameter(0)] [CommandParameter(0)]
public string Bar { get; set; } public string Bar { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().ProduceDiagnostics(code); Analyzer.Should().ProduceDiagnostics(code);
@@ -35,18 +37,20 @@ public class MyCommand : ICommand
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
[CommandParameter(0)] {
public string Foo { get; set; } [CommandParameter(0)]
public string Foo { get; set; }
[CommandParameter(1)] [CommandParameter(1)]
public string Bar { get; set; } public string Bar { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -57,14 +61,16 @@ public class MyCommand : ICommand
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
public string Foo { get; set; } {
public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);

View File

@@ -9,48 +9,52 @@ public class ParameterMustHaveValidConverterAnalyzerSpecs
private static DiagnosticAnalyzer Analyzer { get; } = new ParameterMustHaveValidConverterAnalyzer(); private static DiagnosticAnalyzer Analyzer { get; } = new ParameterMustHaveValidConverterAnalyzer();
[Fact] [Fact]
public void Analyzer_reports_an_error_if_the_specified_parameter_converter_does_not_derive_from_BindingConverter() public void Analyzer_reports_an_error_if_a_parameter_has_a_converter_that_does_not_derive_from_BindingConverter()
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
public class MyConverter """
{ public class MyConverter
public string Convert(string rawValue) => rawValue; {
} public string Convert(string rawValue) => rawValue;
}
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
[CommandParameter(0, Converter = typeof(MyConverter))] [CommandParameter(0, Converter = typeof(MyConverter))]
public string Foo { get; set; } public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().ProduceDiagnostics(code); Analyzer.Should().ProduceDiagnostics(code);
} }
[Fact] [Fact]
public void Analyzer_reports_an_error_if_the_specified_parameter_converter_does_not_derive_from_a_compatible_BindingConverter() public void Analyzer_reports_an_error_if_a_parameter_has_a_converter_that_does_not_derive_from_a_compatible_BindingConverter()
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
public class MyConverter : BindingConverter<int> """
{ public class MyConverter : BindingConverter<int>
public override int Convert(string rawValue) => 42; {
} public override int Convert(string rawValue) => 42;
}
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
[CommandParameter(0, Converter = typeof(MyConverter))] [CommandParameter(0, Converter = typeof(MyConverter))]
public string Foo { get; set; } public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
@@ -58,24 +62,78 @@ public class MyCommand : ICommand
} }
[Fact] [Fact]
public void Analyzer_does_not_report_an_error_if_the_specified_parameter_converter_derives_from_a_compatible_BindingConverter() public void Analyzer_does_not_report_an_error_if_a_parameter_has_a_converter_that_derives_from_a_compatible_BindingConverter()
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
public class MyConverter : BindingConverter<string> """
{ public class MyConverter : BindingConverter<string>
public override string Convert(string rawValue) => rawValue; {
} public override string Convert(string rawValue) => rawValue;
}
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
[CommandParameter(0, Converter = typeof(MyConverter))] [CommandParameter(0, Converter = typeof(MyConverter))]
public string Foo { get; set; } public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert
Analyzer.Should().NotProduceDiagnostics(code);
}
[Fact]
public void Analyzer_does_not_report_an_error_if_a_nullable_parameter_has_a_converter_that_derives_from_a_compatible_BindingConverter()
{
// Arrange
// language=cs
const string code =
"""
public class MyConverter : BindingConverter<int>
{
public override int Convert(string rawValue) => 42;
}
[Command]
public class MyCommand : ICommand
{
[CommandOption("foo", Converter = typeof(MyConverter))]
public int? Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default;
}
""";
// Act & assert
Analyzer.Should().NotProduceDiagnostics(code);
}
[Fact]
public void Analyzer_does_not_report_an_error_if_a_non_scalar_parameter_has_a_converter_that_derives_from_a_compatible_BindingConverter()
{
// Arrange
// language=cs
const string code =
"""
public class MyConverter : BindingConverter<string>
{
public override string Convert(string rawValue) => rawValue;
}
[Command]
public class MyCommand : ICommand
{
[CommandParameter(0, Converter = typeof(MyConverter))]
public IReadOnlyList<string> Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default;
}
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -86,15 +144,17 @@ public class MyCommand : ICommand
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
[CommandParameter(0)] {
public string Foo { get; set; } [CommandParameter(0)]
public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -105,14 +165,16 @@ public class MyCommand : ICommand
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
public string Foo { get; set; } {
public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);

View File

@@ -9,72 +9,78 @@ public class ParameterMustHaveValidValidatorsAnalyzerSpecs
private static DiagnosticAnalyzer Analyzer { get; } = new ParameterMustHaveValidValidatorsAnalyzer(); private static DiagnosticAnalyzer Analyzer { get; } = new ParameterMustHaveValidValidatorsAnalyzer();
[Fact] [Fact]
public void Analyzer_reports_an_error_if_one_of_the_specified_parameter_validators_does_not_derive_from_BindingValidator() public void Analyzer_reports_an_error_a_parameter_has_a_validator_that_does_not_derive_from_BindingValidator()
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
public class MyValidator """
{ public class MyValidator
public void Validate(string value) {} {
} public void Validate(string value) {}
}
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
[CommandParameter(0, Validators = new[] {typeof(MyValidator)})] [CommandParameter(0, Validators = new[] {typeof(MyValidator)})]
public string Foo { get; set; } public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().ProduceDiagnostics(code); Analyzer.Should().ProduceDiagnostics(code);
} }
[Fact] [Fact]
public void Analyzer_reports_an_error_if_one_of_the_specified_parameter_validators_does_not_derive_from_a_compatible_BindingValidator() public void Analyzer_reports_an_error_if_a_parameter_has_a_validator_that_does_not_derive_from_a_compatible_BindingValidator()
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
public class MyValidator : BindingValidator<int> """
{ public class MyValidator : BindingValidator<int>
public override BindingValidationError Validate(int value) => Ok(); {
} public override BindingValidationError Validate(int value) => Ok();
}
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
[CommandParameter(0, Validators = new[] {typeof(MyValidator)})] [CommandParameter(0, Validators = new[] {typeof(MyValidator)})]
public string Foo { get; set; } public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().ProduceDiagnostics(code); Analyzer.Should().ProduceDiagnostics(code);
} }
[Fact] [Fact]
public void Analyzer_does_not_report_an_error_if_each_specified_parameter_validator_derives_from_a_compatible_BindingValidator() public void Analyzer_does_not_report_an_error_if_a_parameter_has_validators_that_all_derive_from_compatible_BindingValidators()
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
public class MyValidator : BindingValidator<string> """
{ public class MyValidator : BindingValidator<string>
public override BindingValidationError Validate(string value) => Ok(); {
} public override BindingValidationError Validate(string value) => Ok();
}
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
[CommandParameter(0, Validators = new[] {typeof(MyValidator)})] [CommandParameter(0, Validators = new[] {typeof(MyValidator)})]
public string Foo { get; set; } public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -85,15 +91,17 @@ public class MyCommand : ICommand
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
[CommandParameter(0)] {
public string Foo { get; set; } [CommandParameter(0)]
public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -104,14 +112,16 @@ public class MyCommand : ICommand
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
public string Foo { get; set; } {
public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);

View File

@@ -13,16 +13,18 @@ public class SystemConsoleShouldBeAvoidedAnalyzerSpecs
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
public ValueTask ExecuteAsync(IConsole console) {
{ public ValueTask ExecuteAsync(IConsole console)
Console.WriteLine(""Hello world""); {
return default; Console.WriteLine("Hello world");
} return default;
}"; }
}
""";
// Act & assert // Act & assert
Analyzer.Should().ProduceDiagnostics(code); Analyzer.Should().ProduceDiagnostics(code);
@@ -33,16 +35,19 @@ public class MyCommand : ICommand
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
public ValueTask ExecuteAsync(IConsole console) {
{ public ValueTask ExecuteAsync(IConsole console)
Console.ForegroundColor = ConsoleColor.Black; {
return default; Console.ForegroundColor = ConsoleColor.Black;
} return default;
}"; }
}
""";
// Act & assert // Act & assert
Analyzer.Should().ProduceDiagnostics(code); Analyzer.Should().ProduceDiagnostics(code);
} }
@@ -52,16 +57,18 @@ public class MyCommand : ICommand
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
public ValueTask ExecuteAsync(IConsole console) {
{ public ValueTask ExecuteAsync(IConsole console)
Console.Error.WriteLine(""Hello world""); {
return default; Console.Error.WriteLine("Hello world");
} return default;
}"; }
}
""";
// Act & assert // Act & assert
Analyzer.Should().ProduceDiagnostics(code); Analyzer.Should().ProduceDiagnostics(code);
@@ -72,16 +79,18 @@ public class MyCommand : ICommand
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
public ValueTask ExecuteAsync(IConsole console) {
{ public ValueTask ExecuteAsync(IConsole console)
console.Output.WriteLine(""Hello world""); {
return default; console.Output.WriteLine("Hello world");
} return default;
}"; }
}
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -92,14 +101,16 @@ public class MyCommand : ICommand
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
public void SomeOtherMethod() => Console.WriteLine(""Test""); {
public void SomeOtherMethod() => Console.WriteLine("Test");
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -110,15 +121,17 @@ public class MyCommand : ICommand
{ {
// Arrange // Arrange
// language=cs // language=cs
const string code = @" const string code =
[Command] """
public class MyCommand : ICommand [Command]
{ public class MyCommand : ICommand
public ValueTask ExecuteAsync(IConsole console) {
{ public ValueTask ExecuteAsync(IConsole console)
return default; {
} return default;
}"; }
}
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);

View File

@@ -58,7 +58,7 @@ internal class AnalyzerAssertions : ReferenceTypeAssertions<DiagnosticAnalyzer,
var compilation = CSharpCompilation.Create( var compilation = CSharpCompilation.Create(
"CliFxTests_DynamicAssembly_" + Guid.NewGuid(), "CliFxTests_DynamicAssembly_" + Guid.NewGuid(),
new[] { ast }, new[] { ast },
ReferenceAssemblies.Net50 Net70.References.All
.Append(MetadataReference.CreateFromFile(typeof(ICommand).Assembly.Location)), .Append(MetadataReference.CreateFromFile(typeof(ICommand).Assembly.Location)),
// DLL to avoid having to define the Main() method // DLL to avoid having to define the Main() method
new CSharpCompilationOptions(OutputKind.DynamicallyLinkedLibrary) new CSharpCompilationOptions(OutputKind.DynamicallyLinkedLibrary)
@@ -72,9 +72,10 @@ internal class AnalyzerAssertions : ReferenceTypeAssertions<DiagnosticAnalyzer,
if (compilationErrors.Any()) if (compilationErrors.Any())
{ {
throw new InvalidOperationException( throw new InvalidOperationException(
"Failed to compile code." + $"""
Environment.NewLine + Failed to compile code.
string.Join(Environment.NewLine, compilationErrors.Select(e => e.ToString())) {string.Join(Environment.NewLine, compilationErrors.Select(e => e.ToString()))}
"""
); );
} }

View File

@@ -3,12 +3,23 @@
<PropertyGroup> <PropertyGroup>
<TargetFramework>netstandard2.0</TargetFramework> <TargetFramework>netstandard2.0</TargetFramework>
<CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies> <CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies>
<Nullable>annotations</Nullable> <GenerateDependencyFile>true</GenerateDependencyFile>
<EnforceExtendedAnalyzerRules>true</EnforceExtendedAnalyzerRules>
<NoWarn>$(NoWarn);RS1025;RS1026</NoWarn> <NoWarn>$(NoWarn);RS1025;RS1026</NoWarn>
</PropertyGroup> </PropertyGroup>
<PropertyGroup>
<!--
Because this project only has a single target framework, the condition in
Directory.Build.props does not appear to work. This is a workaround for that.
-->
<Nullable>annotations</Nullable>
</PropertyGroup>
<ItemGroup> <ItemGroup>
<PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.1.0" PrivateAssets="all" /> <PackageReference Include="Microsoft.CodeAnalysis.Analyzers" Version="3.3.4" PrivateAssets="all" />
<PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.5.0" PrivateAssets="all" />
<PackageReference Include="PolyShim" Version="1.1.0" PrivateAssets="all" />
</ItemGroup> </ItemGroup>
</Project> </Project>

View File

@@ -5,24 +5,32 @@ using Microsoft.CodeAnalysis;
namespace CliFx.Analyzers.ObjectModel; namespace CliFx.Analyzers.ObjectModel;
internal partial class CommandOptionSymbol internal partial class CommandOptionSymbol : ICommandMemberSymbol
{ {
public IPropertySymbol Property { get; }
public string? Name { get; } public string? Name { get; }
public char? ShortName { get; } public char? ShortName { get; }
public bool? IsRequired { get; }
public ITypeSymbol? ConverterType { get; } public ITypeSymbol? ConverterType { get; }
public IReadOnlyList<ITypeSymbol> ValidatorTypes { get; } public IReadOnlyList<ITypeSymbol> ValidatorTypes { get; }
public CommandOptionSymbol( public CommandOptionSymbol(
IPropertySymbol property,
string? name, string? name,
char? shortName, char? shortName,
bool? isRequired,
ITypeSymbol? converterType, ITypeSymbol? converterType,
IReadOnlyList<ITypeSymbol> validatorTypes) IReadOnlyList<ITypeSymbol> validatorTypes)
{ {
Property = property;
Name = name; Name = name;
ShortName = shortName; ShortName = shortName;
IsRequired = isRequired;
ConverterType = converterType; ConverterType = converterType;
ValidatorTypes = validatorTypes; ValidatorTypes = validatorTypes;
} }
@@ -30,25 +38,34 @@ internal partial class CommandOptionSymbol
internal partial class CommandOptionSymbol internal partial class CommandOptionSymbol
{ {
private static AttributeData? TryGetOptionAttribute(IPropertySymbol property) => private static AttributeData? TryGetOptionAttribute(IPropertySymbol property) => property
property .GetAttributes()
.GetAttributes() .FirstOrDefault(a => a.AttributeClass?.DisplayNameMatches(SymbolNames.CliFxCommandOptionAttribute) == true);
.FirstOrDefault(a => a.AttributeClass.DisplayNameMatches(SymbolNames.CliFxCommandOptionAttribute));
private static CommandOptionSymbol FromAttribute(AttributeData attribute) public static CommandOptionSymbol? TryResolve(IPropertySymbol property)
{ {
var attribute = TryGetOptionAttribute(property);
if (attribute is null)
return null;
var name = attribute var name = attribute
.ConstructorArguments .ConstructorArguments
.Where(a => a.Type.DisplayNameMatches("string") || a.Type.DisplayNameMatches("System.String")) .Where(a => a.Type?.SpecialType == SpecialType.System_String)
.Select(a => a.Value) .Select(a => a.Value)
.FirstOrDefault() as string; .FirstOrDefault() as string;
var shortName = attribute var shortName = attribute
.ConstructorArguments .ConstructorArguments
.Where(a => a.Type.DisplayNameMatches("char") || a.Type.DisplayNameMatches("System.Char")) .Where(a => a.Type?.SpecialType == SpecialType.System_Char)
.Select(a => a.Value) .Select(a => a.Value)
.FirstOrDefault() as char?; .FirstOrDefault() as char?;
var isRequired = attribute
.NamedArguments
.Where(a => a.Key == "IsRequired")
.Select(a => a.Value.Value)
.FirstOrDefault() as bool?;
var converter = attribute var converter = attribute
.NamedArguments .NamedArguments
.Where(a => a.Key == "Converter") .Where(a => a.Key == "Converter")
@@ -64,16 +81,7 @@ internal partial class CommandOptionSymbol
.Cast<ITypeSymbol>() .Cast<ITypeSymbol>()
.ToArray(); .ToArray();
return new CommandOptionSymbol(name, shortName, converter, validators); return new CommandOptionSymbol(property, name, shortName, isRequired, converter, validators);
}
public static CommandOptionSymbol? TryResolve(IPropertySymbol property)
{
var attribute = TryGetOptionAttribute(property);
return attribute is not null
? FromAttribute(attribute)
: null;
} }
public static bool IsOptionProperty(IPropertySymbol property) => public static bool IsOptionProperty(IPropertySymbol property) =>

View File

@@ -5,8 +5,10 @@ using Microsoft.CodeAnalysis;
namespace CliFx.Analyzers.ObjectModel; namespace CliFx.Analyzers.ObjectModel;
internal partial class CommandParameterSymbol internal partial class CommandParameterSymbol : ICommandMemberSymbol
{ {
public IPropertySymbol Property { get; }
public int Order { get; } public int Order { get; }
public string? Name { get; } public string? Name { get; }
@@ -18,12 +20,14 @@ internal partial class CommandParameterSymbol
public IReadOnlyList<ITypeSymbol> ValidatorTypes { get; } public IReadOnlyList<ITypeSymbol> ValidatorTypes { get; }
public CommandParameterSymbol( public CommandParameterSymbol(
IPropertySymbol property,
int order, int order,
string? name, string? name,
bool? isRequired, bool? isRequired,
ITypeSymbol? converterType, ITypeSymbol? converterType,
IReadOnlyList<ITypeSymbol> validatorTypes) IReadOnlyList<ITypeSymbol> validatorTypes)
{ {
Property = property;
Order = order; Order = order;
Name = name; Name = name;
IsRequired = isRequired; IsRequired = isRequired;
@@ -34,13 +38,16 @@ internal partial class CommandParameterSymbol
internal partial class CommandParameterSymbol internal partial class CommandParameterSymbol
{ {
private static AttributeData? TryGetParameterAttribute(IPropertySymbol property) => private static AttributeData? TryGetParameterAttribute(IPropertySymbol property) => property
property .GetAttributes()
.GetAttributes() .FirstOrDefault(a => a.AttributeClass?.DisplayNameMatches(SymbolNames.CliFxCommandParameterAttribute) == true);
.FirstOrDefault(a => a.AttributeClass.DisplayNameMatches(SymbolNames.CliFxCommandParameterAttribute));
private static CommandParameterSymbol FromAttribute(AttributeData attribute) public static CommandParameterSymbol? TryResolve(IPropertySymbol property)
{ {
var attribute = TryGetParameterAttribute(property);
if (attribute is null)
return null;
var order = (int)attribute var order = (int)attribute
.ConstructorArguments .ConstructorArguments
.Select(a => a.Value) .Select(a => a.Value)
@@ -73,16 +80,7 @@ internal partial class CommandParameterSymbol
.Cast<ITypeSymbol>() .Cast<ITypeSymbol>()
.ToArray(); .ToArray();
return new CommandParameterSymbol(order, name, isRequired, converter, validators); return new CommandParameterSymbol(property, order, name, isRequired, converter, validators);
}
public static CommandParameterSymbol? TryResolve(IPropertySymbol property)
{
var attribute = TryGetParameterAttribute(property);
return attribute is not null
? FromAttribute(attribute)
: null;
} }
public static bool IsParameterProperty(IPropertySymbol property) => public static bool IsParameterProperty(IPropertySymbol property) =>

View File

@@ -0,0 +1,21 @@
using System.Collections.Generic;
using CliFx.Analyzers.Utils.Extensions;
using Microsoft.CodeAnalysis;
namespace CliFx.Analyzers.ObjectModel;
internal interface ICommandMemberSymbol
{
IPropertySymbol Property { get; }
ITypeSymbol? ConverterType { get; }
IReadOnlyList<ITypeSymbol> ValidatorTypes { get; }
}
internal static class CommandMemberSymbolExtensions
{
public static bool IsScalar(this ICommandMemberSymbol member) =>
member.Property.Type.SpecialType == SpecialType.System_String ||
member.Property.Type.TryGetEnumerableUnderlyingType() is null;
}

View File

@@ -0,0 +1,49 @@
using CliFx.Analyzers.ObjectModel;
using CliFx.Analyzers.Utils.Extensions;
using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.CSharp.Syntax;
using Microsoft.CodeAnalysis.Diagnostics;
namespace CliFx.Analyzers;
[DiagnosticAnalyzer(LanguageNames.CSharp)]
public class OptionMustBeRequiredIfPropertyRequiredAnalyzer : AnalyzerBase
{
public OptionMustBeRequiredIfPropertyRequiredAnalyzer()
: base(
"Options bound to required properties cannot be marked as non-required",
"This option cannot be marked as non-required because it's bound to a required property.")
{
}
private void Analyze(
SyntaxNodeAnalysisContext context,
PropertyDeclarationSyntax propertyDeclaration,
IPropertySymbol property)
{
if (property.ContainingType is null)
return;
if (!property.IsRequired)
return;
var option = CommandOptionSymbol.TryResolve(property);
if (option is null)
return;
if (option.IsRequired != false)
return;
context.ReportDiagnostic(
CreateDiagnostic(
propertyDeclaration.Identifier.GetLocation()
)
);
}
public override void Initialize(AnalysisContext context)
{
base.Initialize(context);
context.HandlePropertyDeclaration(Analyze);
}
}

View File

@@ -15,7 +15,8 @@ public class OptionMustHaveUniqueNameAnalyzer : AnalyzerBase
: base( : base(
"Options must have unique names", "Options must have unique names",
"This option's name must be unique within the command (comparison IS NOT case sensitive). " + "This option's name must be unique within the command (comparison IS NOT case sensitive). " +
"Specified name: '{0}'.") "Specified name: `{0}`. " +
"Property bound to another option with the same name: `{1}`.")
{ {
} }
@@ -55,7 +56,8 @@ public class OptionMustHaveUniqueNameAnalyzer : AnalyzerBase
context.ReportDiagnostic( context.ReportDiagnostic(
CreateDiagnostic( CreateDiagnostic(
propertyDeclaration.Identifier.GetLocation(), propertyDeclaration.Identifier.GetLocation(),
option.Name option.Name,
otherProperty.Name
) )
); );
} }

View File

@@ -14,7 +14,8 @@ public class OptionMustHaveUniqueShortNameAnalyzer : AnalyzerBase
: base( : base(
"Options must have unique short names", "Options must have unique short names",
"This option's short name must be unique within the command (comparison IS case sensitive). " + "This option's short name must be unique within the command (comparison IS case sensitive). " +
"Specified short name: '{0}'.") "Specified short name: `{0}` " +
"Property bound to another option with the same short name: `{1}`.")
{ {
} }
@@ -54,7 +55,8 @@ public class OptionMustHaveUniqueShortNameAnalyzer : AnalyzerBase
context.ReportDiagnostic( context.ReportDiagnostic(
CreateDiagnostic( CreateDiagnostic(
propertyDeclaration.Identifier.GetLocation(), propertyDeclaration.Identifier.GetLocation(),
option.ShortName option.ShortName,
otherProperty.Name
) )
); );
} }

View File

@@ -37,7 +37,16 @@ public class OptionMustHaveValidConverterAnalyzer : AnalyzerBase
.FirstOrDefault(); .FirstOrDefault();
// Value returned by the converter must be assignable to the property type // Value returned by the converter must be assignable to the property type
if (converterValueType is null || !property.Type.IsAssignableFrom(converterValueType)) var isCompatible =
converterValueType is not null && (option.IsScalar()
// Scalar
? context.Compilation.IsAssignable(converterValueType, property.Type)
// Non-scalar (assume we can handle all IEnumerable types for simplicity)
: property.Type.TryGetEnumerableUnderlyingType() is { } enumerableUnderlyingType &&
context.Compilation.IsAssignable(converterValueType, enumerableUnderlyingType)
);
if (!isCompatible)
{ {
context.ReportDiagnostic( context.ReportDiagnostic(
CreateDiagnostic(propertyDeclaration.Identifier.GetLocation()) CreateDiagnostic(propertyDeclaration.Identifier.GetLocation())

View File

@@ -13,7 +13,7 @@ public class OptionMustHaveValidNameAnalyzer : AnalyzerBase
: base( : base(
"Options must have valid names", "Options must have valid names",
"This option's name must be at least 2 characters long and must start with a letter. " + "This option's name must be at least 2 characters long and must start with a letter. " +
"Specified name: '{0}'.") "Specified name: `{0}`.")
{ {
} }

View File

@@ -13,7 +13,7 @@ public class OptionMustHaveValidShortNameAnalyzer : AnalyzerBase
: base( : base(
"Option short names must be letter characters", "Option short names must be letter characters",
"This option's short name must be a single letter character. " + "This option's short name must be a single letter character. " +
"Specified short name: '{0}'.") "Specified short name: `{0}`.")
{ {
} }

View File

@@ -35,7 +35,11 @@ public class OptionMustHaveValidValidatorsAnalyzer : AnalyzerBase
.FirstOrDefault(); .FirstOrDefault();
// Value passed to the validator must be assignable from the property type // Value passed to the validator must be assignable from the property type
if (validatorValueType is null || !validatorValueType.IsAssignableFrom(property.Type)) var isCompatible =
validatorValueType is not null &&
context.Compilation.IsAssignable(property.Type, validatorValueType);
if (!isCompatible)
{ {
context.ReportDiagnostic( context.ReportDiagnostic(
CreateDiagnostic(propertyDeclaration.Identifier.GetLocation()) CreateDiagnostic(propertyDeclaration.Identifier.GetLocation())

View File

@@ -13,7 +13,8 @@ public class ParameterMustBeLastIfNonRequiredAnalyzer : AnalyzerBase
public ParameterMustBeLastIfNonRequiredAnalyzer() public ParameterMustBeLastIfNonRequiredAnalyzer()
: base( : base(
"Parameters marked as non-required must be the last in order", "Parameters marked as non-required must be the last in order",
"This parameter is non-required so it must be the last in order (its order must be highest within the command).") "This parameter is non-required so it must be the last in order (its order must be highest within the command). " +
"Property bound to another non-required parameter: `{0}`.")
{ {
} }
@@ -48,7 +49,10 @@ public class ParameterMustBeLastIfNonRequiredAnalyzer : AnalyzerBase
if (otherParameter.Order > parameter.Order) if (otherParameter.Order > parameter.Order)
{ {
context.ReportDiagnostic( context.ReportDiagnostic(
CreateDiagnostic(propertyDeclaration.Identifier.GetLocation()) CreateDiagnostic(
propertyDeclaration.Identifier.GetLocation(),
otherProperty.Name
)
); );
} }
} }

View File

@@ -13,17 +13,11 @@ public class ParameterMustBeLastIfNonScalarAnalyzer : AnalyzerBase
public ParameterMustBeLastIfNonScalarAnalyzer() public ParameterMustBeLastIfNonScalarAnalyzer()
: base( : base(
"Parameters of non-scalar types must be the last in order", "Parameters of non-scalar types must be the last in order",
"This parameter has a non-scalar type so it must be the last in order (its order must be highest within the command).") "This parameter has a non-scalar type so it must be the last in order (its order must be highest within the command). " +
"Property bound to another non-scalar parameter: `{0}`.")
{ {
} }
private static bool IsScalar(ITypeSymbol type) =>
type.DisplayNameMatches("string") ||
type.DisplayNameMatches("System.String") ||
!type.AllInterfaces
.Select(i => i.ConstructedFrom)
.Any(t => t.DisplayNameMatches("System.Collections.Generic.IEnumerable<T>"));
private void Analyze( private void Analyze(
SyntaxNodeAnalysisContext context, SyntaxNodeAnalysisContext context,
PropertyDeclarationSyntax propertyDeclaration, PropertyDeclarationSyntax propertyDeclaration,
@@ -32,13 +26,13 @@ public class ParameterMustBeLastIfNonScalarAnalyzer : AnalyzerBase
if (property.ContainingType is null) if (property.ContainingType is null)
return; return;
if (IsScalar(property.Type))
return;
var parameter = CommandParameterSymbol.TryResolve(property); var parameter = CommandParameterSymbol.TryResolve(property);
if (parameter is null) if (parameter is null)
return; return;
if (parameter.IsScalar())
return;
var otherProperties = property var otherProperties = property
.ContainingType .ContainingType
.GetMembers() .GetMembers()
@@ -55,7 +49,10 @@ public class ParameterMustBeLastIfNonScalarAnalyzer : AnalyzerBase
if (otherParameter.Order > parameter.Order) if (otherParameter.Order > parameter.Order)
{ {
context.ReportDiagnostic( context.ReportDiagnostic(
CreateDiagnostic(propertyDeclaration.Identifier.GetLocation()) CreateDiagnostic(
propertyDeclaration.Identifier.GetLocation(),
otherProperty.Name
)
); );
} }
} }

View File

@@ -0,0 +1,49 @@
using CliFx.Analyzers.ObjectModel;
using CliFx.Analyzers.Utils.Extensions;
using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.CSharp.Syntax;
using Microsoft.CodeAnalysis.Diagnostics;
namespace CliFx.Analyzers;
[DiagnosticAnalyzer(LanguageNames.CSharp)]
public class ParameterMustBeRequiredIfPropertyRequiredAnalyzer : AnalyzerBase
{
public ParameterMustBeRequiredIfPropertyRequiredAnalyzer()
: base(
"Parameters bound to required properties cannot be marked as non-required",
"This parameter cannot be marked as non-required because it's bound to a required property.")
{
}
private void Analyze(
SyntaxNodeAnalysisContext context,
PropertyDeclarationSyntax propertyDeclaration,
IPropertySymbol property)
{
if (property.ContainingType is null)
return;
if (!property.IsRequired)
return;
var parameter = CommandParameterSymbol.TryResolve(property);
if (parameter is null)
return;
if (parameter.IsRequired != false)
return;
context.ReportDiagnostic(
CreateDiagnostic(
propertyDeclaration.Identifier.GetLocation()
)
);
}
public override void Initialize(AnalysisContext context)
{
base.Initialize(context);
context.HandlePropertyDeclaration(Analyze);
}
}

View File

@@ -13,7 +13,8 @@ public class ParameterMustBeSingleIfNonRequiredAnalyzer : AnalyzerBase
public ParameterMustBeSingleIfNonRequiredAnalyzer() public ParameterMustBeSingleIfNonRequiredAnalyzer()
: base( : base(
"Parameters marked as non-required are limited to one per command", "Parameters marked as non-required are limited to one per command",
"This parameter is non-required so it must be the only such parameter in the command.") "This parameter is non-required so it must be the only such parameter in the command. " +
"Property bound to another non-required parameter: `{0}`.")
{ {
} }
@@ -48,7 +49,10 @@ public class ParameterMustBeSingleIfNonRequiredAnalyzer : AnalyzerBase
if (otherParameter.IsRequired == false) if (otherParameter.IsRequired == false)
{ {
context.ReportDiagnostic( context.ReportDiagnostic(
CreateDiagnostic(propertyDeclaration.Identifier.GetLocation()) CreateDiagnostic(
propertyDeclaration.Identifier.GetLocation(),
otherProperty.Name
)
); );
} }
} }

View File

@@ -13,17 +13,11 @@ public class ParameterMustBeSingleIfNonScalarAnalyzer : AnalyzerBase
public ParameterMustBeSingleIfNonScalarAnalyzer() public ParameterMustBeSingleIfNonScalarAnalyzer()
: base( : base(
"Parameters of non-scalar types are limited to one per command", "Parameters of non-scalar types are limited to one per command",
"This parameter has a non-scalar type so it must be the only such parameter in the command.") "This parameter has a non-scalar type so it must be the only such parameter in the command. " +
"Property bound to another non-scalar parameter: `{0}`.")
{ {
} }
private static bool IsScalar(ITypeSymbol type) =>
type.DisplayNameMatches("string") ||
type.DisplayNameMatches("System.String") ||
!type.AllInterfaces
.Select(i => i.ConstructedFrom)
.Any(t => t.DisplayNameMatches("System.Collections.Generic.IEnumerable<T>"));
private void Analyze( private void Analyze(
SyntaxNodeAnalysisContext context, SyntaxNodeAnalysisContext context,
PropertyDeclarationSyntax propertyDeclaration, PropertyDeclarationSyntax propertyDeclaration,
@@ -32,10 +26,11 @@ public class ParameterMustBeSingleIfNonScalarAnalyzer : AnalyzerBase
if (property.ContainingType is null) if (property.ContainingType is null)
return; return;
if (!CommandParameterSymbol.IsParameterProperty(property)) var parameter = CommandParameterSymbol.TryResolve(property);
if (parameter is null)
return; return;
if (IsScalar(property.Type)) if (parameter.IsScalar())
return; return;
var otherProperties = property var otherProperties = property
@@ -47,13 +42,17 @@ public class ParameterMustBeSingleIfNonScalarAnalyzer : AnalyzerBase
foreach (var otherProperty in otherProperties) foreach (var otherProperty in otherProperties)
{ {
if (!CommandParameterSymbol.IsParameterProperty(otherProperty)) var otherParameter = CommandParameterSymbol.TryResolve(otherProperty);
if (otherParameter is null)
continue; continue;
if (!IsScalar(otherProperty.Type)) if (!otherParameter.IsScalar())
{ {
context.ReportDiagnostic( context.ReportDiagnostic(
CreateDiagnostic(propertyDeclaration.Identifier.GetLocation()) CreateDiagnostic(
propertyDeclaration.Identifier.GetLocation(),
otherProperty.Name
)
); );
} }
} }

View File

@@ -15,7 +15,8 @@ public class ParameterMustHaveUniqueNameAnalyzer : AnalyzerBase
: base( : base(
"Parameters must have unique names", "Parameters must have unique names",
"This parameter's name must be unique within the command (comparison IS NOT case sensitive). " + "This parameter's name must be unique within the command (comparison IS NOT case sensitive). " +
"Specified name: '{0}'.") "Specified name: `{0}`. " +
"Property bound to another parameter with the same name: `{1}`.")
{ {
} }
@@ -55,7 +56,8 @@ public class ParameterMustHaveUniqueNameAnalyzer : AnalyzerBase
context.ReportDiagnostic( context.ReportDiagnostic(
CreateDiagnostic( CreateDiagnostic(
propertyDeclaration.Identifier.GetLocation(), propertyDeclaration.Identifier.GetLocation(),
parameter.Name parameter.Name,
otherProperty.Name
) )
); );
} }

View File

@@ -14,7 +14,8 @@ public class ParameterMustHaveUniqueOrderAnalyzer : AnalyzerBase
: base( : base(
"Parameters must have unique order", "Parameters must have unique order",
"This parameter's order must be unique within the command. " + "This parameter's order must be unique within the command. " +
"Specified order: {0}.") "Specified order: {0}. " +
"Property bound to another parameter with the same order: `{1}`.")
{ {
} }
@@ -48,7 +49,8 @@ public class ParameterMustHaveUniqueOrderAnalyzer : AnalyzerBase
context.ReportDiagnostic( context.ReportDiagnostic(
CreateDiagnostic( CreateDiagnostic(
propertyDeclaration.Identifier.GetLocation(), propertyDeclaration.Identifier.GetLocation(),
parameter.Order parameter.Order,
otherProperty.Name
) )
); );
} }

View File

@@ -37,7 +37,16 @@ public class ParameterMustHaveValidConverterAnalyzer : AnalyzerBase
.FirstOrDefault(); .FirstOrDefault();
// Value returned by the converter must be assignable to the property type // Value returned by the converter must be assignable to the property type
if (converterValueType is null || !property.Type.IsAssignableFrom(converterValueType)) var isCompatible =
converterValueType is not null && (parameter.IsScalar()
// Scalar
? context.Compilation.IsAssignable(converterValueType, property.Type)
// Non-scalar (assume we can handle all IEnumerable types for simplicity)
: property.Type.TryGetEnumerableUnderlyingType() is { } enumerableUnderlyingType &&
context.Compilation.IsAssignable(converterValueType, enumerableUnderlyingType)
);
if (!isCompatible)
{ {
context.ReportDiagnostic( context.ReportDiagnostic(
CreateDiagnostic(propertyDeclaration.Identifier.GetLocation()) CreateDiagnostic(propertyDeclaration.Identifier.GetLocation())

View File

@@ -35,7 +35,11 @@ public class ParameterMustHaveValidValidatorsAnalyzer : AnalyzerBase
.FirstOrDefault(); .FirstOrDefault();
// Value passed to the validator must be assignable from the property type // Value passed to the validator must be assignable from the property type
if (validatorValueType is null || !validatorValueType.IsAssignableFrom(property.Type)) var isCompatible =
validatorValueType is not null &&
context.Compilation.IsAssignable(property.Type, validatorValueType);
if (!isCompatible)
{ {
context.ReportDiagnostic( context.ReportDiagnostic(
CreateDiagnostic(propertyDeclaration.Identifier.GetLocation()) CreateDiagnostic(propertyDeclaration.Identifier.GetLocation())

View File

@@ -29,10 +29,13 @@ internal static class RoslynExtensions
} }
} }
public static bool IsAssignableFrom(this ITypeSymbol target, ITypeSymbol source) => public static ITypeSymbol? TryGetEnumerableUnderlyingType(this ITypeSymbol type) => type
SymbolEqualityComparer.Default.Equals(target, source) || .AllInterfaces
source.GetBaseTypes().Contains(target, SymbolEqualityComparer.Default) || .FirstOrDefault(i => i.ConstructedFrom.SpecialType == SpecialType.System_Collections_Generic_IEnumerable_T)?
source.AllInterfaces.Contains(target, SymbolEqualityComparer.Default); .TypeArguments[0];
public static bool IsAssignable(this Compilation compilation, ITypeSymbol source, ITypeSymbol destination) =>
compilation.ClassifyConversion(source, destination).Exists;
public static void HandleClassDeclaration( public static void HandleClassDeclaration(
this AnalysisContext analysisContext, this AnalysisContext analysisContext,

View File

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

View File

@@ -2,16 +2,16 @@
<PropertyGroup> <PropertyGroup>
<OutputType>Exe</OutputType> <OutputType>Exe</OutputType>
<TargetFramework>net6.0</TargetFramework> <TargetFramework>net7.0</TargetFramework>
</PropertyGroup> </PropertyGroup>
<ItemGroup> <ItemGroup>
<PackageReference Include="BenchmarkDotNet" Version="0.13.1" /> <PackageReference Include="BenchmarkDotNet" Version="0.13.5" />
<PackageReference Include="clipr" Version="1.6.1" /> <PackageReference Include="clipr" Version="1.6.1" />
<PackageReference Include="Cocona" Version="2.0.3" /> <PackageReference Include="Cocona" Version="2.2.0" />
<PackageReference Include="CommandLineParser" Version="2.8.0" /> <PackageReference Include="CommandLineParser" Version="2.9.1" />
<PackageReference Include="McMaster.Extensions.CommandLineUtils" Version="4.0.1" /> <PackageReference Include="McMaster.Extensions.CommandLineUtils" Version="4.0.2" />
<PackageReference Include="PowerArgs" Version="3.6.0" /> <PackageReference Include="PowerArgs" Version="4.0.2" />
<PackageReference Include="System.CommandLine" Version="2.0.0-beta1.20574.7" /> <PackageReference Include="System.CommandLine" Version="2.0.0-beta1.20574.7" />
</ItemGroup> </ItemGroup>

View File

@@ -2,17 +2,16 @@
<PropertyGroup> <PropertyGroup>
<OutputType>Exe</OutputType> <OutputType>Exe</OutputType>
<TargetFramework>net6.0</TargetFramework> <TargetFramework>net7.0</TargetFramework>
</PropertyGroup> </PropertyGroup>
<ItemGroup> <ItemGroup>
<PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="6.0.0" /> <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="7.0.0" />
<PackageReference Include="Newtonsoft.Json" Version="13.0.1" />
</ItemGroup> </ItemGroup>
<ItemGroup> <ItemGroup>
<ProjectReference Include="..\CliFx\CliFx.csproj" /> <ProjectReference Include="..\CliFx\CliFx.csproj" />
<ProjectReference Include="..\CliFx.Analyzers\CliFx.Analyzers.csproj" ReferenceOutputAssembly="false" OutputItemType="Analyzer" /> <ProjectReference Include="..\CliFx.Analyzers\CliFx.Analyzers.csproj" ReferenceOutputAssembly="false" OutputItemType="analyzer" />
</ItemGroup> </ItemGroup>
</Project> </Project>

View File

@@ -14,10 +14,10 @@ public partial class BookAddCommand : ICommand
private readonly LibraryProvider _libraryProvider; private readonly LibraryProvider _libraryProvider;
[CommandParameter(0, Name = "title", Description = "Book title.")] [CommandParameter(0, Name = "title", Description = "Book title.")]
public string Title { get; init; } = ""; public required string Title { get; init; }
[CommandOption("author", 'a', IsRequired = true, Description = "Book author.")] [CommandOption("author", 'a', IsRequired = true, Description = "Book author.")]
public string Author { get; init; } = ""; public required string Author { get; init; }
[CommandOption("published", 'p', Description = "Book publish date.")] [CommandOption("published", 'p', Description = "Book publish date.")]
public DateTimeOffset Published { get; init; } = CreateRandomDate(); public DateTimeOffset Published { get; init; } = CreateRandomDate();

View File

@@ -13,7 +13,7 @@ public class BookCommand : ICommand
private readonly LibraryProvider _libraryProvider; private readonly LibraryProvider _libraryProvider;
[CommandParameter(0, Name = "title", Description = "Title of the book to retrieve.")] [CommandParameter(0, Name = "title", Description = "Title of the book to retrieve.")]
public string Title { get; init; } = ""; public required string Title { get; init; }
public BookCommand(LibraryProvider libraryProvider) public BookCommand(LibraryProvider libraryProvider)
{ {

View File

@@ -12,7 +12,7 @@ public class BookRemoveCommand : ICommand
private readonly LibraryProvider _libraryProvider; private readonly LibraryProvider _libraryProvider;
[CommandParameter(0, Name = "title", Description = "Title of the book to remove.")] [CommandParameter(0, Name = "title", Description = "Title of the book to remove.")]
public string Title { get; init; } = ""; public required string Title { get; init; }
public BookRemoveCommand(LibraryProvider libraryProvider) public BookRemoveCommand(LibraryProvider libraryProvider)
{ {

View File

@@ -2,21 +2,4 @@
namespace CliFx.Demo.Domain; namespace CliFx.Demo.Domain;
public class Book public record Book(string Title, string Author, DateTimeOffset Published, Isbn Isbn);
{
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;
}
}

View File

@@ -2,32 +2,13 @@
namespace CliFx.Demo.Domain; 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() => public override string ToString() =>
$"{EanPrefix:000}-{RegistrationGroup:00}-{Registrant:00000}-{Publication:00}-{CheckDigit:0}"; $"{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) public static Isbn Parse(string value, IFormatProvider formatProvider)
{ {

View File

@@ -4,15 +4,8 @@ using System.Linq;
namespace CliFx.Demo.Domain; 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) public Library WithBook(Book book)
{ {
var books = Books.ToList(); 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>()); public static Library Empty { get; } = new(Array.Empty<Book>());
} }

View File

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

View File

@@ -1,5 +1,5 @@
# CliFx Demo Project # 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, autogenerated help text. This demo project showcases basic CliFx functionality such as command routing, argument parsing, and autogenerated help text.

View File

@@ -2,12 +2,12 @@
<PropertyGroup> <PropertyGroup>
<OutputType>Exe</OutputType> <OutputType>Exe</OutputType>
<TargetFramework>net6.0</TargetFramework> <TargetFramework>net7.0</TargetFramework>
</PropertyGroup> </PropertyGroup>
<ItemGroup> <ItemGroup>
<ProjectReference Include="..\CliFx\CliFx.csproj" /> <ProjectReference Include="..\CliFx\CliFx.csproj" />
<ProjectReference Include="..\CliFx.Analyzers\CliFx.Analyzers.csproj" ReferenceOutputAssembly="false" OutputItemType="Analyzer" /> <ProjectReference Include="..\CliFx.Analyzers\CliFx.Analyzers.csproj" ReferenceOutputAssembly="false" OutputItemType="analyzer" />
</ItemGroup> </ItemGroup>
</Project> </Project>

View File

@@ -1,22 +1,32 @@
using System.Reflection; using System;
using System.Reflection;
using System.Threading.Tasks; using System.Threading.Tasks;
namespace CliFx.Tests.Dummy; namespace CliFx.Tests.Dummy;
// This dummy application is used in tests for scenarios // This dummy application is used in tests for scenarios
// that require an external process to properly verify. // that require an external process to properly verify.
public static partial class Program 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; public static string Location { get; } = Assembly.Location;
} }
public static partial class Program public static partial class Program
{ {
public static async Task Main() => public static async Task Main()
{
// Make sure color codes are not produced because we rely on the output in tests
Environment.SetEnvironmentVariable(
"DOTNET_SYSTEM_CONSOLE_ALLOW_ANSI_COLOR_REDIRECTION",
"false"
);
await new CliApplicationBuilder() await new CliApplicationBuilder()
.AddCommandsFromThisAssembly() .AddCommandsFromThisAssembly()
.Build() .Build()
.RunAsync(); .RunAsync();
}
} }

View File

@@ -16,33 +16,35 @@ public class CancellationSpecs : SpecsBase
} }
[Fact] [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 // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
public async ValueTask ExecuteAsync(IConsole console) public async ValueTask ExecuteAsync(IConsole console)
{ {
try try
{ {
await Task.Delay( await Task.Delay(
TimeSpan.FromSeconds(3), TimeSpan.FromSeconds(3),
console.RegisterCancellationHandler() console.RegisterCancellationHandler()
); );
console.Output.WriteLine(""Completed successfully""); console.Output.WriteLine("Completed successfully");
} }
catch (OperationCanceledException) catch (OperationCanceledException)
{ {
console.Output.WriteLine(""Cancelled""); console.Output.WriteLine("Cancelled");
throw; throw;
} }
} }
}"); }
"""
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)

View File

@@ -1,7 +1,7 @@
<Project Sdk="Microsoft.NET.Sdk"> <Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup> <PropertyGroup>
<TargetFramework>net6.0</TargetFramework> <TargetFramework>net7.0</TargetFramework>
</PropertyGroup> </PropertyGroup>
<ItemGroup> <ItemGroup>
@@ -9,15 +9,16 @@
</ItemGroup> </ItemGroup>
<ItemGroup> <ItemGroup>
<PackageReference Include="Basic.Reference.Assemblies" Version="1.2.4" /> <PackageReference Include="Basic.Reference.Assemblies.Net70" Version="1.4.1" />
<PackageReference Include="CliWrap" Version="3.4.1" /> <PackageReference Include="CliWrap" Version="3.6.0" />
<PackageReference Include="FluentAssertions" Version="6.5.1" /> <PackageReference Include="FluentAssertions" Version="6.10.0" />
<PackageReference Include="GitHubActionsTestLogger" Version="1.3.0" PrivateAssets="all" /> <PackageReference Include="GitHubActionsTestLogger" Version="2.0.1" PrivateAssets="all" />
<PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.1.0" /> <PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.5.0" />
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.1.0" /> <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="7.0.0" />
<PackageReference Include="xunit" Version="2.4.1" /> <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.5.0" />
<PackageReference Include="xunit.runner.visualstudio" Version="2.4.3" PrivateAssets="all" /> <PackageReference Include="xunit" Version="2.4.2" />
<PackageReference Include="coverlet.collector" Version="3.1.2" PrivateAssets="all" /> <PackageReference Include="xunit.runner.visualstudio" Version="2.4.5" PrivateAssets="all" />
<PackageReference Include="coverlet.collector" Version="3.2.0" PrivateAssets="all" />
</ItemGroup> </ItemGroup>
<ItemGroup> <ItemGroup>
@@ -25,12 +26,4 @@
<ProjectReference Include="..\CliFx\CliFx.csproj" /> <ProjectReference Include="..\CliFx\CliFx.csproj" />
</ItemGroup> </ItemGroup>
<ItemGroup>
<None Include="../CliFx.Tests.Dummy/bin/$(Configuration)/$(TargetFramework)/CliFx.Tests.Dummy.runtimeconfig.json">
<Link>CliFx.Tests.Dummy.runtimeconfig.json</Link>
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
<Visible>false</Visible>
</None>
</ItemGroup>
</Project> </Project>

View File

@@ -21,7 +21,7 @@ public class ConsoleSpecs : SpecsBase
{ {
} }
[Fact] [Fact(Timeout = 15000)]
public async Task Real_console_maps_directly_to_system_console() public async Task Real_console_maps_directly_to_system_console()
{ {
// Can't verify our own console output, so using an // Can't verify our own console output, so using an
@@ -31,7 +31,8 @@ public class ConsoleSpecs : SpecsBase
var command = "Hello world" | Cli.Wrap("dotnet") var command = "Hello world" | Cli.Wrap("dotnet")
.WithArguments(a => a .WithArguments(a => a
.Add(Dummy.Program.Location) .Add(Dummy.Program.Location)
.Add("console-test")); .Add("console-test")
);
// Act // Act
var result = await command.ExecuteBufferedAsync(); var result = await command.ExecuteBufferedAsync();
@@ -47,25 +48,28 @@ public class ConsoleSpecs : SpecsBase
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
public ValueTask ExecuteAsync(IConsole console) public ValueTask ExecuteAsync(IConsole console)
{ {
console.ResetColor(); console.ResetColor();
console.ForegroundColor = ConsoleColor.DarkMagenta; console.ForegroundColor = ConsoleColor.DarkMagenta;
console.BackgroundColor = ConsoleColor.DarkMagenta; console.BackgroundColor = ConsoleColor.DarkMagenta;
console.CursorLeft = 42; console.WindowWidth = 100;
console.CursorTop = 24; console.WindowHeight = 25;
console.CursorLeft = 42;
console.CursorTop = 24;
console.Output.WriteLine(""Hello ""); console.Output.WriteLine("Hello ");
console.Error.WriteLine(""world!""); console.Error.WriteLine("world!");
return default; return default;
} }
} }
"); """
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -89,6 +93,8 @@ public class Command : ICommand
Console.BackgroundColor.Should().NotBe(ConsoleColor.DarkMagenta); Console.BackgroundColor.Should().NotBe(ConsoleColor.DarkMagenta);
// This fails because tests don't spawn a console window // This fails because tests don't spawn a console window
//Console.WindowWidth.Should().Be(100);
//Console.WindowHeight.Should().Be(25);
//Console.CursorLeft.Should().NotBe(42); //Console.CursorLeft.Should().NotBe(42);
//Console.CursorTop.Should().NotBe(24); //Console.CursorTop.Should().NotBe(24);
@@ -103,20 +109,21 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
public ValueTask ExecuteAsync(IConsole console) public ValueTask ExecuteAsync(IConsole console)
{ {
var input = console.Input.ReadToEnd(); var input = console.Input.ReadToEnd();
console.Output.WriteLine(input); console.Output.WriteLine(input);
console.Error.WriteLine(input); console.Error.WriteLine(input);
return default; return default;
} }
} }
"); """
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -146,20 +153,21 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
public ValueTask ExecuteAsync(IConsole console) public ValueTask ExecuteAsync(IConsole console)
{ {
console.Output.WriteLine(console.ReadKey().Key); console.Output.WriteLine(console.ReadKey().Key);
console.Output.WriteLine(console.ReadKey().Key); console.Output.WriteLine(console.ReadKey().Key);
console.Output.WriteLine(console.ReadKey().Key); console.Output.WriteLine(console.ReadKey().Key);
return default; return default;
} }
} }
"); """
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)

View File

@@ -21,20 +21,22 @@ public class ConversionSpecs : SpecsBase
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandOption('f')] [CommandOption('f')]
public string Foo { get; set; } public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console)
{
console.Output.WriteLine(Foo);
return default;
}
}
"""
);
public ValueTask ExecuteAsync(IConsole console)
{
console.Output.WriteLine(Foo);
return default;
}
}
");
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
.UseConsole(FakeConsole) .UseConsole(FakeConsole)
@@ -59,20 +61,22 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandOption('f')] [CommandOption('f')]
public object Foo { get; set; } public object Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console)
{
console.Output.WriteLine(Foo);
return default;
}
}
"""
);
public ValueTask ExecuteAsync(IConsole console)
{
console.Output.WriteLine(Foo);
return default;
}
}
");
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
.UseConsole(FakeConsole) .UseConsole(FakeConsole)
@@ -97,25 +101,27 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandOption('f')] [CommandOption('f')]
public bool Foo { get; set; } public bool Foo { get; set; }
[CommandOption('b')] [CommandOption('b')]
public bool Bar { get; set; } public bool Bar { get; set; }
public ValueTask ExecuteAsync(IConsole console) public ValueTask ExecuteAsync(IConsole console)
{ {
console.Output.WriteLine(""Foo = "" + Foo); console.Output.WriteLine("Foo = " + Foo);
console.Output.WriteLine(""Bar = "" + Bar); console.Output.WriteLine("Bar = " + Bar);
return default;
}
}
"""
);
return default;
}
}
");
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
.UseConsole(FakeConsole) .UseConsole(FakeConsole)
@@ -143,20 +149,22 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandOption('f')] [CommandOption('f')]
public bool Foo { get; set; } public bool Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console)
{
console.Output.WriteLine(Foo);
return default;
}
}
"""
);
public ValueTask ExecuteAsync(IConsole console)
{
console.Output.WriteLine(Foo);
return default;
}
}
");
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
.UseConsole(FakeConsole) .UseConsole(FakeConsole)
@@ -181,20 +189,22 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandOption('f')] [CommandOption('f')]
public int Foo { get; set; } public int Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console)
{
console.Output.WriteLine(Foo);
return default;
}
}
"""
);
public ValueTask ExecuteAsync(IConsole console)
{
console.Output.WriteLine(Foo);
return default;
}
}
");
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
.UseConsole(FakeConsole) .UseConsole(FakeConsole)
@@ -219,20 +229,22 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandOption('f')] [CommandOption('f')]
public double Foo { get; set; } public double Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console)
{
console.Output.WriteLine(Foo.ToString(CultureInfo.InvariantCulture));
return default;
}
}
"""
);
public ValueTask ExecuteAsync(IConsole console)
{
console.Output.WriteLine(Foo.ToString(CultureInfo.InvariantCulture));
return default;
}
}
");
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
.UseConsole(FakeConsole) .UseConsole(FakeConsole)
@@ -257,20 +269,22 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandOption('f')] [CommandOption('f')]
public DateTimeOffset Foo { get; set; } public DateTimeOffset Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console)
{
console.Output.WriteLine(Foo.ToString("u", CultureInfo.InvariantCulture));
return default;
}
}
"""
);
public ValueTask ExecuteAsync(IConsole console)
{
console.Output.WriteLine(Foo.ToString(""u"", CultureInfo.InvariantCulture));
return default;
}
}
");
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
.UseConsole(FakeConsole) .UseConsole(FakeConsole)
@@ -295,20 +309,22 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandOption('f')] [CommandOption('f')]
public TimeSpan Foo { get; set; } public TimeSpan Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console)
{
console.Output.WriteLine(Foo.ToString(null, CultureInfo.InvariantCulture));
return default;
}
}
"""
);
public ValueTask ExecuteAsync(IConsole console)
{
console.Output.WriteLine(Foo.ToString(null, CultureInfo.InvariantCulture));
return default;
}
}
");
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
.UseConsole(FakeConsole) .UseConsole(FakeConsole)
@@ -333,22 +349,24 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
public enum CustomEnum { One = 1, Two = 2, Three = 3 } public enum CustomEnum { One = 1, Two = 2, Three = 3 }
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandOption('f')] [CommandOption('f')]
public CustomEnum Foo { get; set; } public CustomEnum Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console)
{
console.Output.WriteLine((int) Foo);
return default;
}
}
"""
);
public ValueTask ExecuteAsync(IConsole console)
{
console.Output.WriteLine((int) Foo);
return default;
}
}
");
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
.UseConsole(FakeConsole) .UseConsole(FakeConsole)
@@ -373,25 +391,27 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandOption('f')] [CommandOption('f')]
public int? Foo { get; set; } public int? Foo { get; set; }
[CommandOption('b')] [CommandOption('b')]
public int? Bar { get; set; } public int? Bar { get; set; }
public ValueTask ExecuteAsync(IConsole console) public ValueTask ExecuteAsync(IConsole console)
{ {
console.Output.WriteLine(""Foo = "" + Foo); console.Output.WriteLine("Foo = " + Foo);
console.Output.WriteLine(""Bar = "" + Bar); console.Output.WriteLine("Bar = " + Bar);
return default;
}
}
"""
);
return default;
}
}
");
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
.UseConsole(FakeConsole) .UseConsole(FakeConsole)
@@ -419,27 +439,29 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
public enum CustomEnum { One = 1, Two = 2, Three = 3 } public enum CustomEnum { One = 1, Two = 2, Three = 3 }
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandOption('f')] [CommandOption('f')]
public CustomEnum? Foo { get; set; } public CustomEnum? Foo { get; set; }
[CommandOption('b')] [CommandOption('b')]
public CustomEnum? Bar { get; set; } public CustomEnum? Bar { get; set; }
public ValueTask ExecuteAsync(IConsole console) public ValueTask ExecuteAsync(IConsole console)
{ {
console.Output.WriteLine(""Foo = "" + (int?) Foo); console.Output.WriteLine("Foo = " + (int?) Foo);
console.Output.WriteLine(""Bar = "" + (int?) Bar); console.Output.WriteLine("Bar = " + (int?) Bar);
return default;
}
}
"""
);
return default;
}
}
");
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
.UseConsole(FakeConsole) .UseConsole(FakeConsole)
@@ -467,27 +489,29 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
public class CustomType public class CustomType
{ {
public string Value { get; } public string Value { get; }
public CustomType(string value) => Value = value; public CustomType(string value) => Value = value;
} }
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandOption('f')] [CommandOption('f')]
public CustomType Foo { get; set; } public CustomType Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console)
{
console.Output.WriteLine(Foo.Value);
return default;
}
}
"""
);
public ValueTask ExecuteAsync(IConsole console)
{
console.Output.WriteLine(Foo.Value);
return default;
}
}
");
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
.UseConsole(FakeConsole) .UseConsole(FakeConsole)
@@ -512,45 +536,47 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
public class CustomTypeA public class CustomTypeA
{ {
public string Value { get; } public string Value { get; }
private CustomTypeA(string value) => Value = value; private CustomTypeA(string value) => Value = value;
public static CustomTypeA Parse(string value) => public static CustomTypeA Parse(string value) =>
new CustomTypeA(value); new CustomTypeA(value);
} }
public class CustomTypeB public class CustomTypeB
{ {
public string Value { get; } public string Value { get; }
private CustomTypeB(string value) => Value = value; private CustomTypeB(string value) => Value = value;
public static CustomTypeB Parse(string value, IFormatProvider formatProvider) => public static CustomTypeB Parse(string value, IFormatProvider formatProvider) =>
new CustomTypeB(value); new CustomTypeB(value);
} }
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandOption('f')] [CommandOption('f')]
public CustomTypeA Foo { get; set; } public CustomTypeA Foo { get; set; }
[CommandOption('b')] [CommandOption('b')]
public CustomTypeB Bar { get; set; } public CustomTypeB Bar { get; set; }
public ValueTask ExecuteAsync(IConsole console) public ValueTask ExecuteAsync(IConsole console)
{ {
console.Output.WriteLine(""Foo = "" + Foo.Value); console.Output.WriteLine("Foo = " + Foo.Value);
console.Output.WriteLine(""Bar = "" + Bar.Value); console.Output.WriteLine("Bar = " + Bar.Value);
return default;
}
}
"""
);
return default;
}
}
");
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
.UseConsole(FakeConsole) .UseConsole(FakeConsole)
@@ -578,26 +604,28 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
public class CustomConverter : BindingConverter<int> public class CustomConverter : BindingConverter<int>
{ {
public override int Convert(string rawValue) => public override int Convert(string rawValue) =>
rawValue.Length; rawValue.Length;
} }
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandOption('f', Converter = typeof(CustomConverter))] [CommandOption('f', Converter = typeof(CustomConverter))]
public int Foo { get; set; } public int Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console)
{
console.Output.WriteLine(Foo);
return default;
}
}
"""
);
public ValueTask ExecuteAsync(IConsole console)
{
console.Output.WriteLine(Foo);
return default;
}
}
");
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
.UseConsole(FakeConsole) .UseConsole(FakeConsole)
@@ -622,22 +650,24 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandOption('f')] [CommandOption('f')]
public string[] Foo { get; set; } public string[] Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) public ValueTask ExecuteAsync(IConsole console)
{ {
foreach (var i in Foo) foreach (var i in Foo)
console.Output.WriteLine(i); console.Output.WriteLine(i);
return default;
}
}
"""
);
return default;
}
}
");
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
.UseConsole(FakeConsole) .UseConsole(FakeConsole)
@@ -666,22 +696,24 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandOption('f')] [CommandOption('f')]
public IReadOnlyList<string> Foo { get; set; } public IReadOnlyList<string> Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) public ValueTask ExecuteAsync(IConsole console)
{ {
foreach (var i in Foo) foreach (var i in Foo)
console.Output.WriteLine(i); console.Output.WriteLine(i);
return default;
}
}
"""
);
return default;
}
}
");
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
.UseConsole(FakeConsole) .UseConsole(FakeConsole)
@@ -710,22 +742,24 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandOption('f')] [CommandOption('f')]
public List<string> Foo { get; set; } public List<string> Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) public ValueTask ExecuteAsync(IConsole console)
{ {
foreach (var i in Foo) foreach (var i in Foo)
console.Output.WriteLine(i); console.Output.WriteLine(i);
return default;
}
}
"""
);
return default;
}
}
");
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
.UseConsole(FakeConsole) .UseConsole(FakeConsole)
@@ -754,22 +788,24 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandOption('f')] [CommandOption('f')]
public int[] Foo { get; set; } public int[] Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) public ValueTask ExecuteAsync(IConsole console)
{ {
foreach (var i in Foo) foreach (var i in Foo)
console.Output.WriteLine(i); console.Output.WriteLine(i);
return default;
}
}
"""
);
return default;
}
}
");
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
.UseConsole(FakeConsole) .UseConsole(FakeConsole)
@@ -798,16 +834,18 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandOption('f')] [CommandOption('f')]
public int Foo { get; set; } public int Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default;
}
"""
);
public ValueTask ExecuteAsync(IConsole console) => default;
}
");
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
.UseConsole(FakeConsole) .UseConsole(FakeConsole)
@@ -832,18 +870,20 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
public class CustomType {} public class CustomType {}
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandOption('f')] [CommandOption('f')]
public CustomType Foo { get; set; } public CustomType Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default;
}
"""
);
public ValueTask ExecuteAsync(IConsole console) => default;
}
");
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
.UseConsole(FakeConsole) .UseConsole(FakeConsole)
@@ -868,23 +908,25 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
public class CustomType : IEnumerable<object> public class CustomType : IEnumerable<object>
{ {
public IEnumerator<object> GetEnumerator() => Enumerable.Empty<object>().GetEnumerator(); public IEnumerator<object> GetEnumerator() => Enumerable.Empty<object>().GetEnumerator();
IEnumerator IEnumerable.GetEnumerator() => GetEnumerator(); IEnumerator IEnumerable.GetEnumerator() => GetEnumerator();
} }
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandOption('f')] [CommandOption('f')]
public CustomType Foo { get; set; } public CustomType Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default;
}
"""
);
public ValueTask ExecuteAsync(IConsole console) => default;
}
");
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
.UseConsole(FakeConsole) .UseConsole(FakeConsole)
@@ -909,26 +951,28 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
public class ValidatorA : BindingValidator<int> public class ValidatorA : BindingValidator<int>
{ {
public override BindingValidationError Validate(int value) => Ok(); public override BindingValidationError Validate(int value) => Ok();
} }
public class ValidatorB : BindingValidator<int> public class ValidatorB : BindingValidator<int>
{ {
public override BindingValidationError Validate(int value) => Error(""Hello world""); public override BindingValidationError Validate(int value) => Error("Hello world");
} }
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandOption('f', Validators = new[] {typeof(ValidatorA), typeof(ValidatorB)})] [CommandOption('f', Validators = new[] {typeof(ValidatorA), typeof(ValidatorB)})]
public int Foo { get; set; } public int Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default;
}
"""
);
public ValueTask ExecuteAsync(IConsole console) => default;
}
");
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
.UseConsole(FakeConsole) .UseConsole(FakeConsole)
@@ -953,25 +997,27 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
public class CustomType public class CustomType
{ {
public string Value { get; } public string Value { get; }
private CustomType(string value) => Value = value; private CustomType(string value) => Value = value;
public static CustomType Parse(string value) => throw new Exception(""Hello world""); public static CustomType Parse(string value) => throw new Exception("Hello world");
} }
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandOption('f')] [CommandOption('f')]
public CustomType Foo { get; set; } public CustomType Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default;
}
"""
);
public ValueTask ExecuteAsync(IConsole console) => default;
}
");
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
.UseConsole(FakeConsole) .UseConsole(FakeConsole)

View File

@@ -19,53 +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() public async Task Debug_directive_can_be_specified_to_interrupt_execution_until_a_debugger_is_attached()
{ {
// Arrange // 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") var command = Cli.Wrap("dotnet")
.WithArguments(a => a .WithArguments(a => a
.Add(Dummy.Program.Location) .Add(Dummy.Program.Location)
.Add("[debug]")) | stdOutBuffer; .Add("[debug]")
) | HandleStdOut;
// Act // Act & assert
try try
{ {
// This has a timeout just in case the execution hangs forever await command.ExecuteAsync(cts.Token);
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;
} }
catch (OperationCanceledException) catch (OperationCanceledException ex) when (ex.CancellationToken == cts.Token)
{ {
// It's expected to fail // 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] [Fact]
@@ -74,13 +56,14 @@ public class DirectivesSpecs : SpecsBase
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command(""cmd"")] [Command("cmd")]
public class Command : ICommand public class Command : ICommand
{ {
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
} }
"); """
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)

View File

@@ -25,20 +25,21 @@ public class EnvironmentSpecs : SpecsBase
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandOption(""foo"", IsRequired = true, EnvironmentVariable = ""ENV_FOO"")] [CommandOption("foo", IsRequired = true, EnvironmentVariable = "ENV_FOO")]
public string Foo { get; set; } public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) public ValueTask ExecuteAsync(IConsole console)
{ {
console.Output.WriteLine(Foo); console.Output.WriteLine(Foo);
return default; return default;
} }
} }
"); """
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -67,20 +68,21 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandOption(""foo"", EnvironmentVariable = ""ENV_FOO"")] [CommandOption("foo", EnvironmentVariable = "ENV_FOO")]
public string Foo { get; set; } public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) public ValueTask ExecuteAsync(IConsole console)
{ {
console.Output.WriteLine(Foo); console.Output.WriteLine(Foo);
return default; return default;
} }
} }
"); """
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -109,22 +111,23 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandOption(""foo"", EnvironmentVariable = ""ENV_FOO"")] [CommandOption("foo", EnvironmentVariable = "ENV_FOO")]
public IReadOnlyList<string> Foo { get; set; } public IReadOnlyList<string> Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) public ValueTask ExecuteAsync(IConsole console)
{ {
foreach (var i in Foo) foreach (var i in Foo)
console.Output.WriteLine(i); console.Output.WriteLine(i);
return default; return default;
} }
} }
"); """
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -156,20 +159,21 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandOption(""foo"", EnvironmentVariable = ""ENV_FOO"")] [CommandOption("foo", EnvironmentVariable = "ENV_FOO")]
public string Foo { get; set; } public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) public ValueTask ExecuteAsync(IConsole console)
{ {
console.Output.WriteLine(Foo); console.Output.WriteLine(Foo);
return default; return default;
} }
} }
"); """
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -198,20 +202,21 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandOption(""foo"", EnvironmentVariable = ""ENV_FOO"")] [CommandOption("foo", EnvironmentVariable = "ENV_FOO")]
public string Foo { get; set; } public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) public ValueTask ExecuteAsync(IConsole console)
{ {
console.Output.WriteLine(Foo); console.Output.WriteLine(Foo);
return default; return default;
} }
} }
"); """
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -236,7 +241,7 @@ public class Command : ICommand
stdOut.Trim().Should().Be("bar"); stdOut.Trim().Should().Be("bar");
} }
[Fact] [Fact(Timeout = 15000)]
public async Task Environment_variables_are_extracted_automatically() public async Task Environment_variables_are_extracted_automatically()
{ {
// Ensures that the environment variables are properly obtained from // Ensures that the environment variables are properly obtained from
@@ -246,9 +251,11 @@ public class Command : ICommand
var command = Cli.Wrap("dotnet") var command = Cli.Wrap("dotnet")
.WithArguments(a => a .WithArguments(a => a
.Add(Dummy.Program.Location) .Add(Dummy.Program.Location)
.Add("env-test")) .Add("env-test")
)
.WithEnvironmentVariables(e => e .WithEnvironmentVariables(e => e
.Set("ENV_TARGET", "Mars")); .Set("ENV_TARGET", "Mars")
);
// Act // Act
var result = await command.ExecuteBufferedAsync(); var result = await command.ExecuteBufferedAsync();

View File

@@ -22,14 +22,15 @@ public class ErrorReportingSpecs : SpecsBase
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
public ValueTask ExecuteAsync(IConsole console) => public ValueTask ExecuteAsync(IConsole console) =>
throw new Exception(""Something went wrong""); throw new Exception("Something went wrong");
} }
"); """
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -60,14 +61,15 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
public ValueTask ExecuteAsync(IConsole console) => public ValueTask ExecuteAsync(IConsole console) =>
throw new Exception(""Something went wrong"", new Exception(""Another exception"")); throw new Exception("Something went wrong", new Exception("Another exception"));
} }
"); """
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -99,14 +101,15 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
public ValueTask ExecuteAsync(IConsole console) => public ValueTask ExecuteAsync(IConsole console) =>
throw new CommandException(""Something went wrong"", 69); throw new CommandException("Something went wrong", 69);
} }
"); """
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -134,14 +137,15 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
public ValueTask ExecuteAsync(IConsole console) => public ValueTask ExecuteAsync(IConsole console) =>
throw new CommandException("""", 69); throw new CommandException("", 69);
} }
"); """
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -172,14 +176,15 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
public ValueTask ExecuteAsync(IConsole console) => public ValueTask ExecuteAsync(IConsole console) =>
throw new CommandException(""Something went wrong"", 69, true); throw new CommandException("Something went wrong", 69, true);
} }
"); """
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)

View File

@@ -44,13 +44,14 @@ public class HelpTextSpecs : SpecsBase
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class DefaultCommand : ICommand public class DefaultCommand : ICommand
{ {
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
} }
"); """
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -77,19 +78,20 @@ public class DefaultCommand : ICommand
// Arrange // Arrange
var commandTypes = DynamicCommandBuilder.CompileMany( var commandTypes = DynamicCommandBuilder.CompileMany(
// language=cs // language=cs
@" """
[Command(""cmd"")] [Command("cmd")]
public class NamedCommand : ICommand public class NamedCommand : ICommand
{ {
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
} }
[Command(""cmd child"")] [Command("cmd child")]
public class NamedChildCommand : ICommand public class NamedChildCommand : ICommand
{ {
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
} }
"); """
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommands(commandTypes) .AddCommands(commandTypes)
@@ -116,25 +118,26 @@ public class NamedChildCommand : ICommand
// Arrange // Arrange
var commandTypes = DynamicCommandBuilder.CompileMany( var commandTypes = DynamicCommandBuilder.CompileMany(
// language=cs // language=cs
@" """
[Command] [Command]
public class DefaultCommand : ICommand public class DefaultCommand : ICommand
{ {
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
} }
[Command(""cmd"", Description = ""Description of a named command."")] [Command("cmd", Description = "Description of a named command.")]
public class NamedCommand : ICommand public class NamedCommand : ICommand
{ {
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
} }
[Command(""cmd child"")] [Command("cmd child")]
public class NamedChildCommand : ICommand public class NamedChildCommand : ICommand
{ {
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
} }
"); """
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommands(commandTypes) .AddCommands(commandTypes)
@@ -160,25 +163,26 @@ public class NamedChildCommand : ICommand
// Arrange // Arrange
var commandTypes = DynamicCommandBuilder.CompileMany( var commandTypes = DynamicCommandBuilder.CompileMany(
// language=cs // language=cs
@" """
[Command] [Command]
public class DefaultCommand : ICommand public class DefaultCommand : ICommand
{ {
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
} }
[Command(""cmd"")] [Command("cmd")]
public class NamedCommand : ICommand public class NamedCommand : ICommand
{ {
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
} }
[Command(""cmd child"", Description = ""Description of a named child command."")] [Command("cmd child", Description = "Description of a named child command.")]
public class NamedChildCommand : ICommand public class NamedChildCommand : ICommand
{ {
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
} }
"); """
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommands(commandTypes) .AddCommands(commandTypes)
@@ -257,13 +261,15 @@ public class NamedChildCommand : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command(Description = ""Description of the default command."")]
public class DefaultCommand : ICommand [Command(Description = "Description of the default command.")]
{ public class DefaultCommand : ICommand
public ValueTask ExecuteAsync(IConsole console) => default; {
} public ValueTask ExecuteAsync(IConsole console) => default;
"); }
""");
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -292,19 +298,21 @@ public class DefaultCommand : ICommand
// Arrange // Arrange
var commandTypes = DynamicCommandBuilder.CompileMany( var commandTypes = DynamicCommandBuilder.CompileMany(
// language=cs // language=cs
@" """
[Command]
public class DefaultCommand : ICommand
{
public ValueTask ExecuteAsync(IConsole console) => default;
}
[Command(""cmd"")] [Command]
public class NamedCommand : ICommand public class DefaultCommand : ICommand
{ {
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
} }
");
[Command("cmd")]
public class NamedCommand : ICommand
{
public ValueTask ExecuteAsync(IConsole console) => default;
}
""");
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommands(commandTypes) .AddCommands(commandTypes)
@@ -333,22 +341,24 @@ public class NamedCommand : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command]
public class Command : ICommand
{
[CommandParameter(0)]
public string Foo { get; set; }
[CommandParameter(1)] [Command]
public string Bar { get; set; } public class Command : ICommand
{
[CommandParameter(0)]
public string Foo { get; set; }
[CommandParameter(2)] [CommandParameter(1)]
public IReadOnlyList<string> Baz { get; set; } public string Bar { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; [CommandParameter(2)]
} public IReadOnlyList<string> Baz { get; set; }
");
public ValueTask ExecuteAsync(IConsole console) => default;
}
""");
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -378,28 +388,30 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
// Base members appear last in reflection order
public abstract class CommandBase : ICommand
{
[CommandParameter(0)]
public string Foo { get; set; }
public abstract ValueTask ExecuteAsync(IConsole console); // Base members appear last in reflection order
} public abstract class CommandBase : ICommand
{
[CommandParameter(0)]
public string Foo { get; set; }
[Command] public abstract ValueTask ExecuteAsync(IConsole console);
public class Command : CommandBase }
{
[CommandParameter(2)]
public IReadOnlyList<string> Baz { get; set; }
[CommandParameter(1)] [Command]
public string Bar { get; set; } public class Command : CommandBase
{
[CommandParameter(2)]
public IReadOnlyList<string> Baz { get; set; }
public override ValueTask ExecuteAsync(IConsole console) => default; [CommandParameter(1)]
} public string Bar { get; set; }
");
public override ValueTask ExecuteAsync(IConsole console) => default;
}
""");
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -428,22 +440,24 @@ public class Command : CommandBase
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command]
public class Command : ICommand
{
[CommandOption(""foo"", IsRequired = true)]
public string Foo { get; set; }
[CommandOption(""bar"")] [Command]
public string Bar { get; set; } public class Command : ICommand
{
[CommandOption("foo", IsRequired = true)]
public string Foo { get; set; }
[CommandOption(""baz"", IsRequired = true)] [CommandOption("bar")]
public IReadOnlyList<string> Baz { get; set; } public string Bar { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; [CommandOption("baz", IsRequired = true)]
} public IReadOnlyList<string> Baz { get; set; }
");
public ValueTask ExecuteAsync(IConsole console) => default;
}
""");
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -472,19 +486,21 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command]
public class Command : ICommand
{
[CommandParameter(0, Name = ""foo"", Description = ""Description of foo."")]
public string Foo { get; set; }
[CommandOption(""bar"", Description = ""Description of bar."")] [Command]
public string Bar { get; set; } public class Command : ICommand
{
[CommandParameter(0, Name = "foo", Description = "Description of foo.")]
public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; [CommandOption("bar", Description = "Description of bar.")]
} public string Bar { get; set; }
");
public ValueTask ExecuteAsync(IConsole console) => default;
}
""");
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -515,13 +531,15 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command]
public class Command : ICommand [Command]
{ public class Command : ICommand
public ValueTask ExecuteAsync(IConsole console) => default; {
} public ValueTask ExecuteAsync(IConsole console) => default;
"); }
""");
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -551,13 +569,15 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command(""cmd"")]
public class Command : ICommand [Command("cmd")]
{ public class Command : ICommand
public ValueTask ExecuteAsync(IConsole console) => default; {
} public ValueTask ExecuteAsync(IConsole console) => default;
"); }
""");
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -589,21 +609,23 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
public enum CustomEnum { One, Two, Three }
[Command] public enum CustomEnum { One, Two, Three }
public class Command : ICommand
{
[CommandParameter(0)]
public CustomEnum Foo { get; set; }
[CommandOption(""bar"")] [Command]
public CustomEnum Bar { get; set; } public class Command : ICommand
{
[CommandParameter(0)]
public CustomEnum Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; [CommandOption("bar")]
} public CustomEnum Bar { get; set; }
");
public ValueTask ExecuteAsync(IConsole console) => default;
}
""");
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -634,21 +656,23 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
public enum CustomEnum { One, Two, Three }
[Command] public enum CustomEnum { One, Two, Three }
public class Command : ICommand
{
[CommandParameter(0)]
public IReadOnlyList<CustomEnum> Foo { get; set; }
[CommandOption(""bar"")] [Command]
public IReadOnlyList<CustomEnum> Bar { get; set; } public class Command : ICommand
{
[CommandParameter(0)]
public IReadOnlyList<CustomEnum> Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; [CommandOption("bar")]
} public IReadOnlyList<CustomEnum> Bar { get; set; }
");
public ValueTask ExecuteAsync(IConsole console) => default;
}
""");
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -679,21 +703,23 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
public enum CustomEnum { One, Two, Three }
[Command] public enum CustomEnum { One, Two, Three }
public class Command : ICommand
{
[CommandParameter(0)]
public CustomEnum? Foo { get; set; }
[CommandOption(""bar"")] [Command]
public IReadOnlyList<CustomEnum?> Bar { get; set; } public class Command : ICommand
{
[CommandParameter(0)]
public CustomEnum? Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; [CommandOption("bar")]
} public IReadOnlyList<CustomEnum?> Bar { get; set; }
");
public ValueTask ExecuteAsync(IConsole console) => default;
}
""");
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -724,21 +750,23 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
public enum CustomEnum { One, Two, Three }
[Command] public enum CustomEnum { One, Two, Three }
public class Command : ICommand
{
[CommandOption(""foo"", EnvironmentVariable = ""ENV_FOO"")]
public CustomEnum Foo { get; set; }
[CommandOption(""bar"", EnvironmentVariable = ""ENV_BAR"")] [Command]
public CustomEnum Bar { get; set; } public class Command : ICommand
{
[CommandOption("foo", EnvironmentVariable = "ENV_FOO")]
public CustomEnum Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; [CommandOption("bar", EnvironmentVariable = "ENV_BAR")]
} public CustomEnum Bar { get; set; }
");
public ValueTask ExecuteAsync(IConsole console) => default;
}
""");
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -768,39 +796,41 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
public enum CustomEnum { One, Two, Three }
[Command] public enum CustomEnum { One, Two, Three }
public class Command : ICommand
{
[CommandOption(""foo"")]
public object Foo { get; set; } = 42;
[CommandOption(""bar"")] [Command]
public string Bar { get; set; } = ""hello""; public class Command : ICommand
{
[CommandOption("foo")]
public object Foo { get; set; } = 42;
[CommandOption(""baz"")] [CommandOption("bar")]
public IReadOnlyList<string> Baz { get; set; } = new[] {""one"", ""two"", ""three""}; public string Bar { get; set; } = "hello";
[CommandOption(""qwe"")] [CommandOption("baz")]
public bool Qwe { get; set; } = true; public IReadOnlyList<string> Baz { get; set; } = new[] {"one", "two", "three"};
[CommandOption(""qop"")] [CommandOption("qwe")]
public int? Qop { get; set; } = 1337; public bool Qwe { get; set; } = true;
[CommandOption(""zor"")] [CommandOption("qop")]
public TimeSpan Zor { get; set; } = TimeSpan.FromMinutes(123); public int? Qop { get; set; } = 1337;
[CommandOption(""lol"")] [CommandOption("zor")]
public CustomEnum Lol { get; set; } = CustomEnum.Two; public TimeSpan Zor { get; set; } = TimeSpan.FromMinutes(123);
[CommandOption(""hmm"", IsRequired = true)] [CommandOption("lol")]
public string Hmm { get; set; } = ""not printed""; public CustomEnum Lol { get; set; } = CustomEnum.Two;
public ValueTask ExecuteAsync(IConsole console) => default; [CommandOption("hmm", IsRequired = true)]
} public string Hmm { get; set; } = "not printed";
");
public ValueTask ExecuteAsync(IConsole console) => default;
}
""");
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -836,25 +866,27 @@ public class Command : ICommand
// Arrange // Arrange
var commandTypes = DynamicCommandBuilder.CompileMany( var commandTypes = DynamicCommandBuilder.CompileMany(
// language=cs // language=cs
@" """
[Command(""cmd1"", Description = ""Description of one command."")]
public class FirstCommand : ICommand
{
public ValueTask ExecuteAsync(IConsole console) => default;
}
[Command(""cmd2"", Description = ""Description of another command."")] [Command("cmd1", Description = "Description of one command.")]
public class SecondCommand : ICommand public class FirstCommand : ICommand
{ {
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
} }
[Command(""cmd2 child"", Description = ""Description of another command's child command."")] [Command("cmd2", Description = "Description of another command.")]
public class SecondCommandChildCommand : ICommand public class SecondCommand : ICommand
{ {
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
} }
");
[Command("cmd2 child", Description = "Description of another command's child command.")]
public class SecondCommandChildCommand : ICommand
{
public ValueTask ExecuteAsync(IConsole console) => default;
}
""");
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommands(commandTypes) .AddCommands(commandTypes)
@@ -890,37 +922,39 @@ public class SecondCommandChildCommand : ICommand
// Arrange // Arrange
var commandTypes = DynamicCommandBuilder.CompileMany( var commandTypes = DynamicCommandBuilder.CompileMany(
// language=cs // language=cs
@" """
[Command(""cmd1"")]
public class FirstCommand : ICommand
{
public ValueTask ExecuteAsync(IConsole console) => default;
}
[Command(""cmd1 child1"")] [Command("cmd1")]
public class FirstCommandFirstChildCommand : ICommand public class FirstCommand : ICommand
{ {
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
} }
[Command(""cmd2"")] [Command("cmd1 child1")]
public class SecondCommand : ICommand public class FirstCommandFirstChildCommand : ICommand
{ {
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
} }
[Command(""cmd2 child11"")] [Command("cmd2")]
public class SecondCommandFirstChildCommand : ICommand public class SecondCommand : ICommand
{ {
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
} }
[Command(""cmd2 child2"")] [Command("cmd2 child11")]
public class SecondCommandSecondChildCommand : ICommand public class SecondCommandFirstChildCommand : ICommand
{ {
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
} }
");
[Command("cmd2 child2")]
public class SecondCommandSecondChildCommand : ICommand
{
public ValueTask ExecuteAsync(IConsole console) => default;
}
""");
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommands(commandTypes) .AddCommands(commandTypes)
@@ -950,25 +984,27 @@ public class SecondCommandSecondChildCommand : ICommand
// Arrange // Arrange
var commandTypes = DynamicCommandBuilder.CompileMany( var commandTypes = DynamicCommandBuilder.CompileMany(
// language=cs // language=cs
@" """
[Command(""cmd1"")]
public class FirstCommand : ICommand
{
public ValueTask ExecuteAsync(IConsole console) => default;
}
[Command(""cmd2 child1"")] [Command("cmd1")]
public class SecondCommandFirstChildCommand : ICommand public class FirstCommand : ICommand
{ {
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
} }
[Command(""cmd2 child2"")] [Command("cmd2 child1")]
public class SecondCommandSecondChildCommand : ICommand public class SecondCommandFirstChildCommand : ICommand
{ {
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
} }
");
[Command("cmd2 child2")]
public class SecondCommandSecondChildCommand : ICommand
{
public ValueTask ExecuteAsync(IConsole console) => default;
}
""");
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommands(commandTypes) .AddCommands(commandTypes)

View File

@@ -22,19 +22,21 @@ public class OptionBindingSpecs : SpecsBase
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandOption(""foo"")] [CommandOption("foo")]
public bool Foo { get; set; } public bool Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) public ValueTask ExecuteAsync(IConsole console)
{ {
console.Output.WriteLine(Foo); console.Output.WriteLine(Foo);
return default; return default;
} }
}"); }
"""
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -60,19 +62,21 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandOption('f')] [CommandOption('f')]
public bool Foo { get; set; } public bool Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) public ValueTask ExecuteAsync(IConsole console)
{ {
console.Output.WriteLine(Foo); console.Output.WriteLine(Foo);
return default; return default;
} }
}"); }
"""
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -98,24 +102,26 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandOption(""foo"")] [CommandOption("foo")]
public string Foo { get; set; } public string Foo { get; set; }
[CommandOption(""bar"")] [CommandOption("bar")]
public string Bar { get; set; } public string Bar { get; set; }
public ValueTask ExecuteAsync(IConsole console) public ValueTask ExecuteAsync(IConsole console)
{ {
console.Output.WriteLine(""Foo = "" + Foo); console.Output.WriteLine("Foo = " + Foo);
console.Output.WriteLine(""Bar = "" + Bar); console.Output.WriteLine("Bar = " + Bar);
return default; return default;
} }
}"); }
"""
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -144,24 +150,26 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandOption('f')] [CommandOption('f')]
public string Foo { get; set; } public string Foo { get; set; }
[CommandOption('b')] [CommandOption('b')]
public string Bar { get; set; } public string Bar { get; set; }
public ValueTask ExecuteAsync(IConsole console) public ValueTask ExecuteAsync(IConsole console)
{ {
console.Output.WriteLine(""Foo = "" + Foo); console.Output.WriteLine("Foo = " + Foo);
console.Output.WriteLine(""Bar = "" + Bar); console.Output.WriteLine("Bar = " + Bar);
return default; return default;
} }
}"); }
"""
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -190,24 +198,26 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandOption('f')] [CommandOption('f')]
public string Foo { get; set; } public string Foo { get; set; }
[CommandOption('b')] [CommandOption('b')]
public string Bar { get; set; } public string Bar { get; set; }
public ValueTask ExecuteAsync(IConsole console) public ValueTask ExecuteAsync(IConsole console)
{ {
console.Output.WriteLine(""Foo = "" + Foo); console.Output.WriteLine("Foo = " + Foo);
console.Output.WriteLine(""Bar = "" + Bar); console.Output.WriteLine("Bar = " + Bar);
return default; return default;
} }
}"); }
"""
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -236,21 +246,23 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandOption(""Foo"")] [CommandOption("Foo")]
public IReadOnlyList<string> Foo { get; set; } public IReadOnlyList<string> Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) public ValueTask ExecuteAsync(IConsole console)
{ {
foreach (var i in Foo) foreach (var i in Foo)
console.Output.WriteLine(i); console.Output.WriteLine(i);
return default; return default;
} }
}"); }
"""
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -280,21 +292,23 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandOption('f')] [CommandOption('f')]
public IReadOnlyList<string> Foo { get; set; } public IReadOnlyList<string> Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) public ValueTask ExecuteAsync(IConsole console)
{ {
foreach (var i in Foo) foreach (var i in Foo)
console.Output.WriteLine(i); console.Output.WriteLine(i);
return default; return default;
} }
}"); }
"""
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -324,21 +338,23 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandOption(""foo"")] [CommandOption("foo")]
public IReadOnlyList<string> Foo { get; set; } public IReadOnlyList<string> Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) public ValueTask ExecuteAsync(IConsole console)
{ {
foreach (var i in Foo) foreach (var i in Foo)
console.Output.WriteLine(i); console.Output.WriteLine(i);
return default; return default;
} }
}"); }
"""
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -368,21 +384,23 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandOption('f')] [CommandOption('f')]
public IReadOnlyList<string> Foo { get; set; } public IReadOnlyList<string> Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) public ValueTask ExecuteAsync(IConsole console)
{ {
foreach (var i in Foo) foreach (var i in Foo)
console.Output.WriteLine(i); console.Output.WriteLine(i);
return default; return default;
} }
}"); }
"""
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -412,21 +430,23 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandOption(""foo"", 'f')] [CommandOption("foo", 'f')]
public IReadOnlyList<string> Foo { get; set; } public IReadOnlyList<string> Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) public ValueTask ExecuteAsync(IConsole console)
{ {
foreach (var i in Foo) foreach (var i in Foo)
console.Output.WriteLine(i); console.Output.WriteLine(i);
return default; return default;
} }
}"); }
"""
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -456,24 +476,26 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandOption(""foo"")] [CommandOption("foo")]
public string Foo { get; set; } public string Foo { get; set; }
[CommandOption(""bar"")] [CommandOption("bar")]
public string Bar { get; set; } = ""hello""; public string Bar { get; set; } = "hello";
public ValueTask ExecuteAsync(IConsole console) public ValueTask ExecuteAsync(IConsole console)
{ {
console.Output.WriteLine(""Foo = "" + Foo); console.Output.WriteLine("Foo = " + Foo);
console.Output.WriteLine(""Bar = "" + Bar); console.Output.WriteLine("Bar = " + Bar);
return default; return default;
} }
}"); }
"""
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -502,55 +524,56 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
public static class SharedContext public static class SharedContext
{ {
public static int Foo { get; set; } public static int Foo { get; set; }
public static bool Bar { get; set; } public static bool Bar { get; set; }
} }
public interface IHasFoo : ICommand public interface IHasFoo : ICommand
{ {
[CommandOption(""foo"")] [CommandOption("foo")]
public int Foo public int Foo
{ {
get => SharedContext.Foo; get => SharedContext.Foo;
set => SharedContext.Foo = value; set => SharedContext.Foo = value;
} }
} }
public interface IHasBar : ICommand public interface IHasBar : ICommand
{ {
[CommandOption(""bar"")] [CommandOption("bar")]
public bool Bar public bool Bar
{ {
get => SharedContext.Bar; get => SharedContext.Bar;
set => SharedContext.Bar = value; set => SharedContext.Bar = value;
} }
} }
public interface IHasBaz : ICommand public interface IHasBaz : ICommand
{ {
public string Baz { get; set; } public string Baz { get; set; }
} }
[Command] [Command]
public class Command : IHasFoo, IHasBar, IHasBaz public class Command : IHasFoo, IHasBar, IHasBaz
{ {
[CommandOption(""baz"")] [CommandOption("baz")]
public string Baz { get; set; } public string Baz { get; set; }
public ValueTask ExecuteAsync(IConsole console) public ValueTask ExecuteAsync(IConsole console)
{ {
console.Output.WriteLine(""Foo = "" + SharedContext.Foo); console.Output.WriteLine("Foo = " + SharedContext.Foo);
console.Output.WriteLine(""Bar = "" + SharedContext.Bar); console.Output.WriteLine("Bar = " + SharedContext.Bar);
console.Output.WriteLine(""Baz = "" + Baz); console.Output.WriteLine("Baz = " + Baz);
return default; return default;
} }
} }
"); """
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -579,20 +602,22 @@ public class Command : IHasFoo, IHasBar, IHasBaz
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandOption(""foo"")] [CommandOption("foo")]
public string Foo { get; set; } public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) public ValueTask ExecuteAsync(IConsole console)
{ {
console.Output.WriteLine(Foo); console.Output.WriteLine(Foo);
return default; return default;
} }
}"); }
"""
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -618,15 +643,17 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandOption(""foo"", IsRequired = true)] [CommandOption("foo", IsRequired = true)]
public string Foo { get; set; } public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"); }
"""
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -652,15 +679,17 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandOption(""foo"", IsRequired = true)] [CommandOption("foo", IsRequired = true)]
public string Foo { get; set; } public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"); }
"""
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -686,15 +715,17 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandOption(""foo"", IsRequired = true)] [CommandOption("foo", IsRequired = true)]
public IReadOnlyList<string> Foo { get; set; } public IReadOnlyList<string> Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"); }
"""
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -720,15 +751,17 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandOption(""foo"")] [CommandOption("foo")]
public string Foo { get; set; } public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"); }
"""
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -754,15 +787,17 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandOption(""foo"")] [CommandOption("foo")]
public string Foo { get; set; } public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"); }
"""
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -781,4 +816,40 @@ public class Command : ICommand
exitCode.Should().NotBe(0); exitCode.Should().NotBe(0);
stdErr.Should().Contain("expects a single argument, but provided with multiple"); stdErr.Should().Contain("expects a single argument, but provided with multiple");
} }
[Fact]
public async Task Option_binding_fails_if_a_required_property_option_has_not_been_provided()
{
// Arrange
var commandType = DynamicCommandBuilder.Compile(
// language=cs
"""
[Command]
public class Command : ICommand
{
[CommandOption("foo")]
public required string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default;
}
"""
);
var application = new CliApplicationBuilder()
.AddCommand(commandType)
.UseConsole(FakeConsole)
.Build();
// Act
var exitCode = await application.RunAsync(
Array.Empty<string>(),
new Dictionary<string, string>()
);
var stdErr = FakeConsole.ReadErrorString();
// Assert
exitCode.Should().NotBe(0);
stdErr.Should().Contain("Missing required option(s)");
}
} }

View File

@@ -21,24 +21,26 @@ public class ParameterBindingSpecs : SpecsBase
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandParameter(0)] [CommandParameter(0)]
public string Foo { get; set; } public string Foo { get; set; }
[CommandParameter(1)] [CommandParameter(1)]
public string Bar { get; set; } public string Bar { get; set; }
public ValueTask ExecuteAsync(IConsole console) public ValueTask ExecuteAsync(IConsole console)
{ {
console.Output.WriteLine(""Foo = "" + Foo); console.Output.WriteLine("Foo = " + Foo);
console.Output.WriteLine(""Bar = "" + Bar); console.Output.WriteLine("Bar = " + Bar);
return default; return default;
} }
}"); }
"""
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -67,33 +69,35 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandParameter(0)] [CommandParameter(0)]
public string Foo { get; set; } public string Foo { get; set; }
[CommandParameter(1)] [CommandParameter(1)]
public string Bar { get; set; } public string Bar { get; set; }
[CommandParameter(2)] [CommandParameter(2)]
public IReadOnlyList<string> Baz { get; set; } public IReadOnlyList<string> Baz { get; set; }
[CommandOption(""boo"")] [CommandOption("boo")]
public string Boo { get; set; } public string Boo { get; set; }
public ValueTask ExecuteAsync(IConsole console) public ValueTask ExecuteAsync(IConsole console)
{ {
console.Output.WriteLine(""Foo = "" + Foo); console.Output.WriteLine("Foo = " + Foo);
console.Output.WriteLine(""Bar = "" + Bar); console.Output.WriteLine("Bar = " + Bar);
foreach (var i in Baz) foreach (var i in Baz)
console.Output.WriteLine(""Baz = "" + i); console.Output.WriteLine("Baz = " + i);
return default; return default;
} }
}"); }
"""
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -125,24 +129,26 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandParameter(0)] [CommandParameter(0)]
public string Foo { get; set; } public string Foo { get; set; }
[CommandParameter(1, IsRequired = false)] [CommandParameter(1, IsRequired = false)]
public string Bar { get; set; } = ""xyz""; public string Bar { get; set; } = "xyz";
public ValueTask ExecuteAsync(IConsole console) public ValueTask ExecuteAsync(IConsole console)
{ {
console.Output.WriteLine(""Foo = "" + Foo); console.Output.WriteLine("Foo = " + Foo);
console.Output.WriteLine(""Bar = "" + Bar); console.Output.WriteLine("Bar = " + Bar);
return default; return default;
} }
}"); }
"""
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -171,18 +177,20 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandParameter(0)] [CommandParameter(0)]
public string Foo { get; set; } public string Foo { get; set; }
[CommandParameter(1)] [CommandParameter(1)]
public string Bar { get; set; } public string Bar { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"); }
"""
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -208,18 +216,20 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandParameter(0)] [CommandParameter(0)]
public string Foo { get; set; } public string Foo { get; set; }
[CommandParameter(1)] [CommandParameter(1)]
public IReadOnlyList<string> Bar { get; set; } public IReadOnlyList<string> Bar { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"); }
"""
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -245,18 +255,20 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandParameter(0)] [CommandParameter(0)]
public string Foo { get; set; } public string Foo { get; set; }
[CommandParameter(1)] [CommandParameter(1)]
public string Bar { get; set; } public string Bar { get; set; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"); }
"""
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)

View File

@@ -21,37 +21,38 @@ public class RoutingSpecs : SpecsBase
// Arrange // Arrange
var commandTypes = DynamicCommandBuilder.CompileMany( var commandTypes = DynamicCommandBuilder.CompileMany(
// language=cs // language=cs
@" """
[Command] [Command]
public class DefaultCommand : ICommand public class DefaultCommand : ICommand
{ {
public ValueTask ExecuteAsync(IConsole console) public ValueTask ExecuteAsync(IConsole console)
{ {
console.Output.WriteLine(""default""); console.Output.WriteLine("default");
return default; return default;
} }
} }
[Command(""cmd"")] [Command("cmd")]
public class NamedCommand : ICommand public class NamedCommand : ICommand
{ {
public ValueTask ExecuteAsync(IConsole console) public ValueTask ExecuteAsync(IConsole console)
{ {
console.Output.WriteLine(""cmd""); console.Output.WriteLine("cmd");
return default; return default;
} }
} }
[Command(""cmd child"")] [Command("cmd child")]
public class NamedChildCommand : ICommand public class NamedChildCommand : ICommand
{ {
public ValueTask ExecuteAsync(IConsole console) public ValueTask ExecuteAsync(IConsole console)
{ {
console.Output.WriteLine(""cmd child""); console.Output.WriteLine("cmd child");
return default; return default;
} }
} }
"); """
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommands(commandTypes) .AddCommands(commandTypes)
@@ -77,37 +78,38 @@ public class NamedChildCommand : ICommand
// Arrange // Arrange
var commandTypes = DynamicCommandBuilder.CompileMany( var commandTypes = DynamicCommandBuilder.CompileMany(
// language=cs // language=cs
@" """
[Command] [Command]
public class DefaultCommand : ICommand public class DefaultCommand : ICommand
{ {
public ValueTask ExecuteAsync(IConsole console) public ValueTask ExecuteAsync(IConsole console)
{ {
console.Output.WriteLine(""default""); console.Output.WriteLine("default");
return default; return default;
} }
} }
[Command(""cmd"")] [Command("cmd")]
public class NamedCommand : ICommand public class NamedCommand : ICommand
{ {
public ValueTask ExecuteAsync(IConsole console) public ValueTask ExecuteAsync(IConsole console)
{ {
console.Output.WriteLine(""cmd""); console.Output.WriteLine("cmd");
return default; return default;
} }
} }
[Command(""cmd child"")] [Command("cmd child")]
public class NamedChildCommand : ICommand public class NamedChildCommand : ICommand
{ {
public ValueTask ExecuteAsync(IConsole console) public ValueTask ExecuteAsync(IConsole console)
{ {
console.Output.WriteLine(""cmd child""); console.Output.WriteLine("cmd child");
return default; return default;
} }
} }
"); """
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommands(commandTypes) .AddCommands(commandTypes)
@@ -133,37 +135,38 @@ public class NamedChildCommand : ICommand
// Arrange // Arrange
var commandTypes = DynamicCommandBuilder.CompileMany( var commandTypes = DynamicCommandBuilder.CompileMany(
// language=cs // language=cs
@" """
[Command] [Command]
public class DefaultCommand : ICommand public class DefaultCommand : ICommand
{ {
public ValueTask ExecuteAsync(IConsole console) public ValueTask ExecuteAsync(IConsole console)
{ {
console.Output.WriteLine(""default""); console.Output.WriteLine("default");
return default; return default;
} }
} }
[Command(""cmd"")] [Command("cmd")]
public class NamedCommand : ICommand public class NamedCommand : ICommand
{ {
public ValueTask ExecuteAsync(IConsole console) public ValueTask ExecuteAsync(IConsole console)
{ {
console.Output.WriteLine(""cmd""); console.Output.WriteLine("cmd");
return default; return default;
} }
} }
[Command(""cmd child"")] [Command("cmd child")]
public class NamedChildCommand : ICommand public class NamedChildCommand : ICommand
{ {
public ValueTask ExecuteAsync(IConsole console) public ValueTask ExecuteAsync(IConsole console)
{ {
console.Output.WriteLine(""cmd child""); console.Output.WriteLine("cmd child");
return default; return default;
} }
} }
"); """
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommands(commandTypes) .AddCommands(commandTypes)

View File

@@ -4,6 +4,7 @@ using System.Threading.Tasks;
using CliFx.Infrastructure; using CliFx.Infrastructure;
using CliFx.Tests.Utils; using CliFx.Tests.Utils;
using FluentAssertions; using FluentAssertions;
using Microsoft.Extensions.DependencyInjection;
using Xunit; using Xunit;
using Xunit.Abstractions; using Xunit.Abstractions;
@@ -22,16 +23,18 @@ public class TypeActivationSpecs : SpecsBase
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
public ValueTask ExecuteAsync(IConsole console) public ValueTask ExecuteAsync(IConsole console)
{ {
console.Output.WriteLine(""foo""); console.Output.WriteLine("foo");
return default; return default;
} }
}"); }
"""
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -58,14 +61,16 @@ public class Command : ICommand
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
public Command(string foo) {} public Command(string foo) {}
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"); }
"""
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -87,30 +92,32 @@ public class Command : ICommand
} }
[Fact] [Fact]
public async Task Delegate_type_activator_can_initialize_a_type_using_a_custom_function() public async Task Custom_type_activator_can_initialize_a_type_using_a_given_function()
{ {
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
private readonly string _foo; private readonly string _foo;
public Command(string foo) => _foo = foo; public Command(string foo) => _foo = foo;
public ValueTask ExecuteAsync(IConsole console) public ValueTask ExecuteAsync(IConsole console)
{ {
console.Output.WriteLine(_foo); console.Output.WriteLine(_foo);
return default; return default;
} }
}"); }
"""
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
.UseConsole(FakeConsole) .UseConsole(FakeConsole)
.UseTypeActivator(type => Activator.CreateInstance(type, "hello world")!) .UseTypeActivator(type => Activator.CreateInstance(type, "Hello world")!)
.Build(); .Build();
// Act // Act
@@ -123,25 +130,73 @@ public class Command : ICommand
// Assert // Assert
exitCode.Should().Be(0); exitCode.Should().Be(0);
stdOut.Trim().Should().Be("hello world"); stdOut.Trim().Should().Be("Hello world");
} }
[Fact] [Fact]
public async Task Delegate_type_activator_fails_if_the_underlying_function_returns_null() public async Task Custom_type_activator_can_initialize_a_type_using_a_service_provider()
{ {
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // language=cs
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
public ValueTask ExecuteAsync(IConsole console) private readonly string _foo;
{
console.Output.WriteLine(""foo""); public Command(string foo) => _foo = foo;
return default;
public ValueTask ExecuteAsync(IConsole console)
{
console.Output.WriteLine(_foo);
return default;
}
}
"""
);
var serviceProvider = new ServiceCollection()
.AddSingleton(commandType, Activator.CreateInstance(commandType, "Hello world")!)
.BuildServiceProvider();
var application = new CliApplicationBuilder()
.AddCommand(commandType)
.UseConsole(FakeConsole)
.UseTypeActivator(serviceProvider)
.Build();
// Act
var exitCode = await application.RunAsync(
Array.Empty<string>(),
new Dictionary<string, string>()
);
var stdOut = FakeConsole.ReadOutputString();
// Assert
exitCode.Should().Be(0);
stdOut.Trim().Should().Be("Hello world");
} }
}");
[Fact]
public async Task Custom_type_activator_fails_if_the_underlying_function_returns_null()
{
// Arrange
var commandType = DynamicCommandBuilder.Compile(
// language=cs
"""
[Command]
public class Command : ICommand
{
public ValueTask ExecuteAsync(IConsole console)
{
console.Output.WriteLine("foo");
return default;
}
}
"""
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)

View File

@@ -61,7 +61,7 @@ internal static class DynamicCommandBuilder
var compilation = CSharpCompilation.Create( var compilation = CSharpCompilation.Create(
"CliFxTests_DynamicAssembly_" + Guid.NewGuid(), "CliFxTests_DynamicAssembly_" + Guid.NewGuid(),
new[] {ast}, new[] {ast},
ReferenceAssemblies.Net50 Net70.References.All
.Append(MetadataReference.CreateFromFile(typeof(ICommand).Assembly.Location)) .Append(MetadataReference.CreateFromFile(typeof(ICommand).Assembly.Location))
.Append(MetadataReference.CreateFromFile(typeof(DynamicCommandBuilder).Assembly.Location)), .Append(MetadataReference.CreateFromFile(typeof(DynamicCommandBuilder).Assembly.Location)),
// DLL to avoid having to define the Main() method // DLL to avoid having to define the Main() method
@@ -76,9 +76,10 @@ internal static class DynamicCommandBuilder
if (compilationErrors.Any()) if (compilationErrors.Any())
{ {
throw new InvalidOperationException( throw new InvalidOperationException(
"Failed to compile code." + $"""
Environment.NewLine + Failed to compile code.
string.Join(Environment.NewLine, compilationErrors.Select(e => e.ToString())) {string.Join(Environment.NewLine, compilationErrors.Select(e => e.ToString()))}
"""
); );
} }
@@ -94,9 +95,10 @@ internal static class DynamicCommandBuilder
if (emitErrors.Any()) if (emitErrors.Any())
{ {
throw new InvalidOperationException( throw new InvalidOperationException(
"Failed to emit code." + $"""
Environment.NewLine + Failed to emit code.
string.Join(Environment.NewLine, emitErrors.Select(e => e.ToString())) {string.Join(Environment.NewLine, emitErrors.Select(e => e.ToString()))}
"""
); );
} }

View File

@@ -24,7 +24,7 @@ public class ApplicationConfiguration
public bool IsPreviewModeAllowed { get; } public bool IsPreviewModeAllowed { get; }
/// <summary> /// <summary>
/// Initializes an instance of <see cref="ApplicationConfiguration"/>. /// Initializes an instance of <see cref="ApplicationConfiguration" />.
/// </summary> /// </summary>
public ApplicationConfiguration( public ApplicationConfiguration(
IReadOnlyList<Type> commandTypes, IReadOnlyList<Type> commandTypes,

View File

@@ -26,7 +26,7 @@ public class ApplicationMetadata
public string? Description { get; } public string? Description { get; }
/// <summary> /// <summary>
/// Initializes an instance of <see cref="ApplicationMetadata"/>. /// Initializes an instance of <see cref="ApplicationMetadata" />.
/// </summary> /// </summary>
public ApplicationMetadata( public ApplicationMetadata(
string title, string title,

View File

@@ -26,7 +26,7 @@ public sealed class CommandAttribute : Attribute
public string? Description { get; set; } public string? Description { get; set; }
/// <summary> /// <summary>
/// Initializes an instance of <see cref="CommandAttribute"/>. /// Initializes an instance of <see cref="CommandAttribute" />.
/// </summary> /// </summary>
public CommandAttribute(string name) public CommandAttribute(string name)
{ {
@@ -34,7 +34,7 @@ public sealed class CommandAttribute : Attribute
} }
/// <summary> /// <summary>
/// Initializes an instance of <see cref="CommandAttribute"/>. /// Initializes an instance of <see cref="CommandAttribute" />.
/// </summary> /// </summary>
public CommandAttribute() public CommandAttribute()
{ {

View File

@@ -14,7 +14,7 @@ public sealed class CommandOptionAttribute : Attribute
/// </summary> /// </summary>
/// <remarks> /// <remarks>
/// Must contain at least two characters and start with a letter. /// Must contain at least two characters and start with a letter.
/// Either <see cref="Name"/> or <see cref="ShortName"/> must be set. /// Either <see cref="Name" /> or <see cref="ShortName" /> must be set.
/// All options in a command must have unique names (comparison IS NOT case-sensitive). /// All options in a command must have unique names (comparison IS NOT case-sensitive).
/// </remarks> /// </remarks>
public string? Name { get; } public string? Name { get; }
@@ -23,7 +23,7 @@ public sealed class CommandOptionAttribute : Attribute
/// Option short name. /// Option short name.
/// </summary> /// </summary>
/// <remarks> /// <remarks>
/// Either <see cref="Name"/> or <see cref="ShortName"/> must be set. /// Either <see cref="Name" /> or <see cref="ShortName" /> must be set.
/// All options in a command must have unique short names (comparison IS case-sensitive). /// All options in a command must have unique short names (comparison IS case-sensitive).
/// </remarks> /// </remarks>
public char? ShortName { get; } public char? ShortName { get; }
@@ -32,11 +32,15 @@ public sealed class CommandOptionAttribute : Attribute
/// Whether this option is required (default: <c>false</c>). /// Whether this option is required (default: <c>false</c>).
/// If an option is required, the user will get an error if they don't set it. /// If an option is required, the user will get an error if they don't set it.
/// </summary> /// </summary>
/// <remarks>
/// You can use the <c>required</c> keyword on the property (introduced in C# 11) to implicitly
/// set <see cref="IsRequired" /> to <c>true</c>.
/// </remarks>
public bool IsRequired { get; set; } public bool IsRequired { get; set; }
/// <summary> /// <summary>
/// Environment variable whose value will be used as a fallback if the option /// 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> /// </summary>
public string? EnvironmentVariable { get; set; } public string? EnvironmentVariable { get; set; }
@@ -47,11 +51,11 @@ public sealed class CommandOptionAttribute : Attribute
public string? Description { get; set; } public string? Description { get; set; }
/// <summary> /// <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. /// a value expected by the underlying property.
/// </summary> /// </summary>
/// <remarks> /// <remarks>
/// Converter must derive from <see cref="BindingConverter{T}"/>. /// Converter must derive from <see cref="BindingConverter{T}" />.
/// </remarks> /// </remarks>
public Type? Converter { get; set; } public Type? Converter { get; set; }
@@ -60,12 +64,12 @@ public sealed class CommandOptionAttribute : Attribute
/// property, after it has been bound. /// property, after it has been bound.
/// </summary> /// </summary>
/// <remarks> /// <remarks>
/// Validators must derive from <see cref="BindingValidator{T}"/>. /// Validators must derive from <see cref="BindingValidator{T}" />.
/// </remarks> /// </remarks>
public Type[] Validators { get; set; } = Array.Empty<Type>(); public Type[] Validators { get; set; } = Array.Empty<Type>();
/// <summary> /// <summary>
/// Initializes an instance of <see cref="CommandOptionAttribute"/>. /// Initializes an instance of <see cref="CommandOptionAttribute" />.
/// </summary> /// </summary>
private CommandOptionAttribute(string? name, char? shortName) private CommandOptionAttribute(string? name, char? shortName)
{ {
@@ -74,15 +78,15 @@ public sealed class CommandOptionAttribute : Attribute
} }
/// <summary> /// <summary>
/// Initializes an instance of <see cref="CommandOptionAttribute"/>. /// Initializes an instance of <see cref="CommandOptionAttribute" />.
/// </summary> /// </summary>
public CommandOptionAttribute(string name, char shortName) public CommandOptionAttribute(string name, char shortName)
: this(name, (char?) shortName) : this(name, (char?)shortName)
{ {
} }
/// <summary> /// <summary>
/// Initializes an instance of <see cref="CommandOptionAttribute"/>. /// Initializes an instance of <see cref="CommandOptionAttribute" />.
/// </summary> /// </summary>
public CommandOptionAttribute(string name) public CommandOptionAttribute(string name)
: this(name, null) : this(name, null)
@@ -90,10 +94,10 @@ public sealed class CommandOptionAttribute : Attribute
} }
/// <summary> /// <summary>
/// Initializes an instance of <see cref="CommandOptionAttribute"/>. /// Initializes an instance of <see cref="CommandOptionAttribute" />.
/// </summary> /// </summary>
public CommandOptionAttribute(char shortName) public CommandOptionAttribute(char shortName)
: this(null, (char?) shortName) : this(null, (char?)shortName)
{ {
} }
} }

View File

@@ -47,11 +47,11 @@ public sealed class CommandParameterAttribute : Attribute
public string? Description { get; set; } public string? Description { get; set; }
/// <summary> /// <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. /// a value expected by the underlying property.
/// </summary> /// </summary>
/// <remarks> /// <remarks>
/// Converter must derive from <see cref="BindingConverter{T}"/>. /// Converter must derive from <see cref="BindingConverter{T}" />.
/// </remarks> /// </remarks>
public Type? Converter { get; set; } public Type? Converter { get; set; }
@@ -60,12 +60,12 @@ public sealed class CommandParameterAttribute : Attribute
/// property, after it has been bound. /// property, after it has been bound.
/// </summary> /// </summary>
/// <remarks> /// <remarks>
/// Validators must derive from <see cref="BindingValidator{T}"/>. /// Validators must derive from <see cref="BindingValidator{T}" />.
/// </remarks> /// </remarks>
public Type[] Validators { get; set; } = Array.Empty<Type>(); public Type[] Validators { get; set; } = Array.Empty<Type>();
/// <summary> /// <summary>
/// Initializes an instance of <see cref="CommandParameterAttribute"/>. /// Initializes an instance of <see cref="CommandParameterAttribute" />.
/// </summary> /// </summary>
public CommandParameterAttribute(int order) public CommandParameterAttribute(int order)
{ {

View File

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

View File

@@ -6,12 +6,13 @@ using System.Reflection;
using CliFx.Attributes; using CliFx.Attributes;
using CliFx.Infrastructure; using CliFx.Infrastructure;
using CliFx.Schema; using CliFx.Schema;
using CliFx.Utils;
using CliFx.Utils.Extensions; using CliFx.Utils.Extensions;
namespace CliFx; namespace CliFx;
/// <summary> /// <summary>
/// Builder for <see cref="CliApplication"/>. /// Builder for <see cref="CliApplication" />.
/// </summary> /// </summary>
public partial class CliApplicationBuilder public partial class CliApplicationBuilder
{ {
@@ -21,7 +22,7 @@ public partial class CliApplicationBuilder
private bool _isPreviewModeAllowed = true; private bool _isPreviewModeAllowed = true;
private string? _title; private string? _title;
private string? _executableName; private string? _executableName;
private string? _versionText; private string? _version;
private string? _description; private string? _description;
private IConsole? _console; private IConsole? _console;
private ITypeActivator? _typeActivator; private ITypeActivator? _typeActivator;
@@ -57,8 +58,8 @@ public partial class CliApplicationBuilder
/// Adds commands from the specified assembly to the application. /// Adds commands from the specified assembly to the application.
/// </summary> /// </summary>
/// <remarks> /// <remarks>
/// This method looks for public non-abstract classes that implement <see cref="ICommand"/> /// This method looks for public non-abstract classes that implement <see cref="ICommand" />
/// and are annotated by <see cref="CommandAttribute"/>. /// and are annotated by <see cref="CommandAttribute" />.
/// </remarks> /// </remarks>
public CliApplicationBuilder AddCommandsFrom(Assembly commandAssembly) public CliApplicationBuilder AddCommandsFrom(Assembly commandAssembly)
{ {
@@ -72,8 +73,8 @@ public partial class CliApplicationBuilder
/// Adds commands from the specified assemblies to the application. /// Adds commands from the specified assemblies to the application.
/// </summary> /// </summary>
/// <remarks> /// <remarks>
/// This method looks for public non-abstract classes that implement <see cref="ICommand"/> /// This method looks for public non-abstract classes that implement <see cref="ICommand" />
/// and are annotated by <see cref="CommandAttribute"/>. /// and are annotated by <see cref="CommandAttribute" />.
/// </remarks> /// </remarks>
public CliApplicationBuilder AddCommandsFrom(IEnumerable<Assembly> commandAssemblies) public CliApplicationBuilder AddCommandsFrom(IEnumerable<Assembly> commandAssemblies)
{ {
@@ -87,8 +88,8 @@ public partial class CliApplicationBuilder
/// Adds commands from the calling assembly to the application. /// Adds commands from the calling assembly to the application.
/// </summary> /// </summary>
/// <remarks> /// <remarks>
/// This method looks for public non-abstract classes that implement <see cref="ICommand"/> /// This method looks for public non-abstract classes that implement <see cref="ICommand" />
/// and are annotated by <see cref="CommandAttribute"/>. /// and are annotated by <see cref="CommandAttribute" />.
/// </remarks> /// </remarks>
public CliApplicationBuilder AddCommandsFromThisAssembly() => AddCommandsFrom(Assembly.GetCallingAssembly()); public CliApplicationBuilder AddCommandsFromThisAssembly() => AddCommandsFrom(Assembly.GetCallingAssembly());
@@ -144,7 +145,7 @@ public partial class CliApplicationBuilder
/// </remarks> /// </remarks>
public CliApplicationBuilder SetVersion(string version) public CliApplicationBuilder SetVersion(string version)
{ {
_versionText = version; _version = version;
return this; return this;
} }
@@ -158,7 +159,7 @@ public partial class CliApplicationBuilder
} }
/// <summary> /// <summary>
/// Configures the application to use the specified implementation of <see cref="IConsole"/>. /// Configures the application to use the specified implementation of <see cref="IConsole" />.
/// </summary> /// </summary>
public CliApplicationBuilder UseConsole(IConsole console) public CliApplicationBuilder UseConsole(IConsole console)
{ {
@@ -167,7 +168,7 @@ public partial class CliApplicationBuilder
} }
/// <summary> /// <summary>
/// Configures the application to use the specified implementation of <see cref="ITypeActivator"/>. /// Configures the application to use the specified implementation of <see cref="ITypeActivator" />.
/// </summary> /// </summary>
public CliApplicationBuilder UseTypeActivator(ITypeActivator typeActivator) public CliApplicationBuilder UseTypeActivator(ITypeActivator typeActivator)
{ {
@@ -182,14 +183,20 @@ public partial class CliApplicationBuilder
UseTypeActivator(new DelegateTypeActivator(typeActivator)); UseTypeActivator(new DelegateTypeActivator(typeActivator));
/// <summary> /// <summary>
/// Creates a configured instance of <see cref="CliApplication"/>. /// Configures the application to use the specified service provider for activating types.
/// </summary>
public CliApplicationBuilder UseTypeActivator(IServiceProvider serviceProvider) =>
UseTypeActivator(serviceProvider.GetService);
/// <summary>
/// Creates a configured instance of <see cref="CliApplication" />.
/// </summary> /// </summary>
public CliApplication Build() public CliApplication Build()
{ {
var metadata = new ApplicationMetadata( var metadata = new ApplicationMetadata(
_title ?? GetDefaultTitle(), _title ?? GetDefaultTitle(),
_executableName ?? GetDefaultExecutableName(), _executableName ?? GetDefaultExecutableName(),
_versionText ?? GetDefaultVersionText(), _version ?? GetDefaultVersionText(),
_description _description
); );
@@ -210,14 +217,9 @@ public partial class CliApplicationBuilder
public partial class CliApplicationBuilder public partial class CliApplicationBuilder
{ {
private static readonly Lazy<Assembly?> EntryAssemblyLazy = new(Assembly.GetEntryAssembly);
// Entry assembly can be null, for example in tests
private static Assembly? EntryAssembly => EntryAssemblyLazy.Value;
private static string GetDefaultTitle() private static string GetDefaultTitle()
{ {
var entryAssemblyName = EntryAssembly?.GetName().Name; var entryAssemblyName = EnvironmentEx.EntryAssembly?.GetName().Name;
if (string.IsNullOrWhiteSpace(entryAssemblyName)) if (string.IsNullOrWhiteSpace(entryAssemblyName))
return "App"; return "App";
@@ -226,26 +228,39 @@ public partial class CliApplicationBuilder
private static string GetDefaultExecutableName() private static string GetDefaultExecutableName()
{ {
var entryAssemblyLocation = EntryAssembly?.Location; var entryAssemblyLocation = EnvironmentEx.EntryAssembly?.Location;
if (string.IsNullOrWhiteSpace(entryAssemblyLocation)) if (string.IsNullOrWhiteSpace(entryAssemblyLocation))
return "app"; return "app";
// The assembly can be an .exe or a .dll, depending on how it was packaged // If the application was launched via matching EXE apphost, use that as the executable name
var isLaunchedViaAppHost = string.Equals(
EnvironmentEx.ProcessPath,
Path.ChangeExtension(entryAssemblyLocation, ".exe"),
StringComparison.OrdinalIgnoreCase
);
if (isLaunchedViaAppHost)
return Path.GetFileNameWithoutExtension(entryAssemblyLocation);
// Otherwise, use the entry assembly as the executable name.
// Prefix it with `dotnet` if it's a DLL file.
var isDll = string.Equals( var isDll = string.Equals(
Path.GetExtension(entryAssemblyLocation), Path.GetExtension(entryAssemblyLocation),
".dll", ".dll",
StringComparison.OrdinalIgnoreCase StringComparison.OrdinalIgnoreCase
); );
var name = isDll return isDll
? "dotnet " + Path.GetFileName(entryAssemblyLocation) ? "dotnet " + Path.GetFileName(entryAssemblyLocation)
: Path.GetFileNameWithoutExtension(entryAssemblyLocation); : Path.GetFileNameWithoutExtension(entryAssemblyLocation);
return name;
} }
private static string GetDefaultVersionText() => private static string GetDefaultVersionText()
EntryAssembly is not null {
? "v" + EntryAssembly.GetName().Version.ToSemanticString() var entryAssemblyVersion = EnvironmentEx.EntryAssembly?.GetName().Version;
: "v1.0"; if (entryAssemblyVersion is null)
return "v1.0";
return "v" + entryAssemblyVersion.ToSemanticString();
}
} }

View File

@@ -1,10 +1,13 @@
<Project Sdk="Microsoft.NET.Sdk"> <Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup> <PropertyGroup>
<TargetFrameworks>netstandard2.1;netstandard2.0</TargetFrameworks> <TargetFrameworks>netstandard2.0;netstandard2.1</TargetFrameworks>
<Authors>$(Company)</Authors>
<Description>Declarative framework for building command line applications</Description>
<IsPackable>true</IsPackable> <IsPackable>true</IsPackable>
</PropertyGroup>
<PropertyGroup>
<Authors>$(Company)</Authors>
<Description>Class-first framework for building command-line interfaces</Description>
<PackageTags>command line executable interface framework parser arguments cli app application net core</PackageTags> <PackageTags>command line executable interface framework parser arguments cli app application net core</PackageTags>
<PackageProjectUrl>https://github.com/Tyrrrz/CliFx</PackageProjectUrl> <PackageProjectUrl>https://github.com/Tyrrrz/CliFx</PackageProjectUrl>
<PackageReleaseNotes>https://github.com/Tyrrrz/CliFx/blob/master/Changelog.md</PackageReleaseNotes> <PackageReleaseNotes>https://github.com/Tyrrrz/CliFx/blob/master/Changelog.md</PackageReleaseNotes>
@@ -24,19 +27,15 @@
<ItemGroup> <ItemGroup>
<PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1" PrivateAssets="all" /> <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1" PrivateAssets="all" />
<PackageReference Include="Nullable" Version="1.3.0" PrivateAssets="all" /> <PackageReference Include="PolyShim" Version="1.1.0" PrivateAssets="all" />
<PackageReference Include="System.Threading.Tasks.Extensions" Version="4.5.4" Condition="'$(TargetFramework)' == 'netstandard2.0'" />
</ItemGroup> </ItemGroup>
<ItemGroup Condition="'$(TargetFramework)' == 'netstandard2.0'"> <!-- Embed the analyzer inside the package -->
<PackageReference Include="System.Threading.Tasks.Extensions" Version="4.5.4" />
</ItemGroup>
<!-- Pack the analyzer assembly inside the package -->
<ItemGroup> <ItemGroup>
<ProjectReference Include="../CliFx.Analyzers/CliFx.Analyzers.csproj" ReferenceOutputAssembly="false" OutputItemType="Analyzer" /> <ProjectReference Include="../CliFx.Analyzers/CliFx.Analyzers.csproj" ReferenceOutputAssembly="false" OutputItemType="analyzer" />
<None Include="../CliFx.Analyzers/bin/$(Configuration)/netstandard2.0/CliFx.Analyzers.deps.json" Pack="true" PackagePath="analyzers/dotnet/cs" Visible="false" />
<None Include="../CliFx.Analyzers/bin/$(Configuration)/netstandard2.0/CliFx.Analyzers.dll" Pack="true" PackagePath="analyzers/dotnet/cs" Visible="false" /> <None Include="../CliFx.Analyzers/bin/$(Configuration)/netstandard2.0/CliFx.Analyzers.dll" Pack="true" PackagePath="analyzers/dotnet/cs" Visible="false" />
<None Include="../CliFx.Analyzers/bin/$(Configuration)/netstandard2.0/Microsoft.CodeAnalysis.dll" Pack="true" PackagePath="analyzers/dotnet/cs" Visible="false" />
<None Include="../CliFx.Analyzers/bin/$(Configuration)/netstandard2.0/Microsoft.CodeAnalysis.CSharp.dll" Pack="true" PackagePath="analyzers/dotnet/cs" Visible="false" />
<None Include="../CliFx.Analyzers/bin/$(Configuration)/netstandard2.0/System.Buffers.dll" Pack="true" PackagePath="analyzers/dotnet/cs" Visible="false" /> <None Include="../CliFx.Analyzers/bin/$(Configuration)/netstandard2.0/System.Buffers.dll" Pack="true" PackagePath="analyzers/dotnet/cs" Visible="false" />
<None Include="../CliFx.Analyzers/bin/$(Configuration)/netstandard2.0/System.Collections.Immutable.dll" Pack="true" PackagePath="analyzers/dotnet/cs" Visible="false" /> <None Include="../CliFx.Analyzers/bin/$(Configuration)/netstandard2.0/System.Collections.Immutable.dll" Pack="true" PackagePath="analyzers/dotnet/cs" Visible="false" />
<None Include="../CliFx.Analyzers/bin/$(Configuration)/netstandard2.0/System.Memory.dll" Pack="true" PackagePath="analyzers/dotnet/cs" Visible="false" /> <None Include="../CliFx.Analyzers/bin/$(Configuration)/netstandard2.0/System.Memory.dll" Pack="true" PackagePath="analyzers/dotnet/cs" Visible="false" />

View File

@@ -31,7 +31,7 @@ internal class CommandBinder
return converter.Convert(rawValue); 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))) if (targetType.IsAssignableFrom(typeof(string)))
{ {
return rawValue; return rawValue;
@@ -77,7 +77,7 @@ internal class CommandBinder
: null; : null;
} }
// String-constructible (FileInfo, etc) // String-constructable (FileInfo, etc)
var stringConstructor = targetType.GetConstructor(new[] { typeof(string) }); var stringConstructor = targetType.GetConstructor(new[] { typeof(string) });
if (stringConstructor is not null) if (stringConstructor is not null)
{ {
@@ -99,11 +99,11 @@ internal class CommandBinder
} }
throw CliFxException.InternalError( throw CliFxException.InternalError(
$"{memberSchema.GetKind()} {memberSchema.GetFormattedIdentifier()} has an unsupported underlying property type." + $"""
Environment.NewLine + {memberSchema.GetKind()} {memberSchema.GetFormattedIdentifier()} has an unsupported underlying property type.
$"There is no known way to convert a string value into an instance of type `{targetType.FullName}`." + There is no known way to convert a string value into an instance of type `{targetType.FullName}`
Environment.NewLine + To fix this, either change the property to use a supported type or configure a custom converter.
"To fix this, either change the property to use a supported type or configure a custom converter." """
); );
} }
@@ -125,7 +125,7 @@ internal class CommandBinder
return array; return array;
} }
// Array-constructible (List<T>, HashSet<T>, etc) // Array-constructable (List<T>, HashSet<T>, etc)
var arrayConstructor = targetEnumerableType.GetConstructor(new[] { arrayType }); var arrayConstructor = targetEnumerableType.GetConstructor(new[] { arrayType });
if (arrayConstructor is not null) if (arrayConstructor is not null)
{ {
@@ -133,11 +133,11 @@ internal class CommandBinder
} }
throw CliFxException.InternalError( throw CliFxException.InternalError(
$"{memberSchema.GetKind()} {memberSchema.GetFormattedIdentifier()} has an unsupported underlying property type." + $"""
Environment.NewLine + {memberSchema.GetKind()} {memberSchema.GetFormattedIdentifier()} has an unsupported underlying property type.
$"There is no known way to convert an array of `{targetElementType.FullName}` into an instance of type `{targetEnumerableType.FullName}`." + There is no known way to convert an array of `{targetElementType.FullName}` into an instance of type `{targetEnumerableType.FullName}`.
Environment.NewLine + To fix this, change the property to use a type which can be assigned from an array or a type that has a constructor which accepts an array.
"To fix this, change the property to use a type which can be assigned from an array or a type that has a constructor which accepts an array." """
); );
} }
@@ -169,20 +169,21 @@ internal class CommandBinder
: ex.Message; : ex.Message;
throw CliFxException.UserError( throw CliFxException.UserError(
$"{memberSchema.GetKind()} {memberSchema.GetFormattedIdentifier()} cannot be set from provided argument(s):" + $"""
Environment.NewLine + {memberSchema.GetKind()} {memberSchema.GetFormattedIdentifier()} cannot be set from the provided argument(s):
rawValues.Select(v => '<' + v + '>').JoinToString(" ") + {rawValues.Select(v => '<' + v + '>').JoinToString(" ")}
Environment.NewLine + Error: {errorMessage}
$"Error: {errorMessage}", """,
ex ex
); );
} }
// Mismatch (scalar but too many values) // Mismatch (scalar but too many values)
throw CliFxException.UserError( throw CliFxException.UserError(
$"{memberSchema.GetKind()} {memberSchema.GetFormattedIdentifier()} expects a single argument, but provided with multiple:" + $"""
Environment.NewLine + {memberSchema.GetKind()} {memberSchema.GetFormattedIdentifier()} expects a single argument, but provided with multiple:
rawValues.Select(v => '<' + v + '>').JoinToString(" ") {rawValues.Select(v => '<' + v + '>').JoinToString(" ")}
"""
); );
} }
@@ -202,11 +203,11 @@ internal class CommandBinder
if (errors.Any()) if (errors.Any())
{ {
throw CliFxException.UserError( throw CliFxException.UserError(
$"{memberSchema.GetKind()} {memberSchema.GetFormattedIdentifier()} has been provided with an invalid value." + $"""
Environment.NewLine + {memberSchema.GetKind()} {memberSchema.GetFormattedIdentifier()} has been provided with an invalid value.
"Error(s):" + Error(s):
Environment.NewLine + {errors.Select(e => "- " + e.Message).JoinToString(Environment.NewLine)}
errors.Select(e => "- " + e.Message).JoinToString(Environment.NewLine) """
); );
} }
} }
@@ -264,22 +265,20 @@ internal class CommandBinder
if (remainingParameterInputs.Any()) if (remainingParameterInputs.Any())
{ {
throw CliFxException.UserError( throw CliFxException.UserError(
"Unexpected parameter(s):" + $"""
Environment.NewLine + Unexpected parameter(s):
remainingParameterInputs {remainingParameterInputs.Select(p => p.GetFormattedIdentifier()).JoinToString(" ")}
.Select(p => p.GetFormattedIdentifier()) """
.JoinToString(" ")
); );
} }
if (remainingRequiredParameterSchemas.Any()) if (remainingRequiredParameterSchemas.Any())
{ {
throw CliFxException.UserError( throw CliFxException.UserError(
"Missing required parameter(s):" + $"""
Environment.NewLine + Missing required parameter(s):
remainingRequiredParameterSchemas {remainingRequiredParameterSchemas.Select(p => p.GetFormattedIdentifier()).JoinToString(" ")}
.Select(p => p.GetFormattedIdentifier()) """
.JoinToString(" ")
); );
} }
} }
@@ -308,7 +307,7 @@ internal class CommandBinder
BindMember(optionSchema, commandInstance, rawValues); 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()) if (rawValues.Any())
remainingRequiredOptionSchemas.Remove(optionSchema); remainingRequiredOptionSchemas.Remove(optionSchema);
} }
@@ -321,7 +320,7 @@ internal class CommandBinder
BindMember(optionSchema, commandInstance, rawValues); 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()) if (rawValues.Any())
remainingRequiredOptionSchemas.Remove(optionSchema); remainingRequiredOptionSchemas.Remove(optionSchema);
} }
@@ -337,22 +336,20 @@ internal class CommandBinder
if (remainingOptionInputs.Any()) if (remainingOptionInputs.Any())
{ {
throw CliFxException.UserError( throw CliFxException.UserError(
"Unrecognized option(s):" + $"""
Environment.NewLine + Unrecognized option(s):
remainingOptionInputs {remainingOptionInputs.Select(o => o.GetFormattedIdentifier()).JoinToString(", ")}
.Select(o => o.GetFormattedIdentifier()) """
.JoinToString(", ")
); );
} }
if (remainingRequiredOptionSchemas.Any()) if (remainingRequiredOptionSchemas.Any())
{ {
throw CliFxException.UserError( throw CliFxException.UserError(
"Missing required option(s):" + $"""
Environment.NewLine + Missing required option(s):
remainingRequiredOptionSchemas {remainingRequiredOptionSchemas.Select(o => o.GetFormattedIdentifier()).JoinToString(", ")}
.Select(o => o.GetFormattedIdentifier()) """
.JoinToString(", ")
); );
} }
} }

View File

@@ -24,7 +24,7 @@ public partial class CliFxException : Exception
public bool ShowHelp { get; } public bool ShowHelp { get; }
/// <summary> /// <summary>
/// Initializes an instance of <see cref="CliFxException"/>. /// Initializes an instance of <see cref="CliFxException" />.
/// </summary> /// </summary>
public CliFxException( public CliFxException(
string message, string message,

View File

@@ -9,7 +9,7 @@ namespace CliFx.Exceptions;
public class CommandException : CliFxException public class CommandException : CliFxException
{ {
/// <summary> /// <summary>
/// Initializes an instance of <see cref="CommandException"/>. /// Initializes an instance of <see cref="CommandException" />.
/// </summary> /// </summary>
public CommandException( public CommandException(
string message, string message,

View File

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

View File

@@ -11,7 +11,7 @@ public class BindingValidationError
public string Message { get; } public string Message { get; }
/// <summary> /// <summary>
/// Initializes an instance of <see cref="BindingValidationError"/>. /// Initializes an instance of <see cref="BindingValidationError" />.
/// </summary> /// </summary>
public BindingValidationError(string message) => Message = message; public BindingValidationError(string message) => Message = message;
} }

View File

@@ -26,7 +26,7 @@ public abstract class BindingValidator<T> : IBindingValidator
/// Returns null if validation is successful, or an error in case of failure. /// Returns null if validation is successful, or an error in case of failure.
/// </summary> /// </summary>
/// <remarks> /// <remarks>
/// You can use the utility methods <see cref="Ok"/> and <see cref="Error"/> to /// You can use the utility methods <see cref="Ok" /> and <see cref="Error" /> to
/// create an appropriate result. /// create an appropriate result.
/// </remarks> /// </remarks>
public abstract BindingValidationError? Validate(T? value); public abstract BindingValidationError? Validate(T? value);

View File

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

View File

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

View File

@@ -4,12 +4,12 @@ using CliFx.Infrastructure;
namespace CliFx; namespace CliFx;
/// <summary> /// <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> /// </summary>
public interface ICommand public interface ICommand
{ {
/// <summary> /// <summary>
/// Executes the command using the specified implementation of <see cref="IConsole"/>. /// Executes the command using the specified implementation of <see cref="IConsole" />.
/// </summary> /// </summary>
/// <remarks> /// <remarks>
/// If the execution of the command is not asynchronous, simply end the method with /// If the execution of the command is not asynchronous, simply end the method with

View File

@@ -7,7 +7,7 @@ using System.Threading.Tasks;
namespace CliFx.Infrastructure; namespace CliFx.Infrastructure;
/// <summary> /// <summary>
/// Implements a <see cref="TextReader"/> for reading characters from a console stream. /// Implements a <see cref="TextReader" /> for reading characters from a console stream.
/// </summary> /// </summary>
// Both the underlying stream AND the stream reader must be synchronized! // Both the underlying stream AND the stream reader must be synchronized!
// https://github.com/Tyrrrz/CliFx/issues/123 // https://github.com/Tyrrrz/CliFx/issues/123
@@ -19,7 +19,7 @@ public partial class ConsoleReader : StreamReader
public IConsole Console { get; } public IConsole Console { get; }
/// <summary> /// <summary>
/// Initializes an instance of <see cref="ConsoleReader"/>. /// Initializes an instance of <see cref="ConsoleReader" />.
/// </summary> /// </summary>
public ConsoleReader(IConsole console, Stream stream, Encoding encoding) public ConsoleReader(IConsole console, Stream stream, Encoding encoding)
: base(stream, encoding, false, 4096) : base(stream, encoding, false, 4096)
@@ -28,7 +28,7 @@ public partial class ConsoleReader : StreamReader
} }
/// <summary> /// <summary>
/// Initializes an instance of <see cref="ConsoleReader"/>. /// Initializes an instance of <see cref="ConsoleReader" />.
/// </summary> /// </summary>
public ConsoleReader(IConsole console, Stream stream) public ConsoleReader(IConsole console, Stream stream)
: this(console, stream, System.Console.InputEncoding) : this(console, stream, System.Console.InputEncoding)
@@ -99,10 +99,8 @@ public partial class ConsoleReader : StreamReader
public partial class ConsoleReader public partial class ConsoleReader
{ {
internal static ConsoleReader Create(IConsole console, Stream? stream) => new( internal static ConsoleReader Create(IConsole console, Stream stream) => new(
console, console,
stream is not null Stream.Synchronized(stream)
? Stream.Synchronized(stream)
: Stream.Null
); );
} }

View File

@@ -8,7 +8,7 @@ using CliFx.Utils;
namespace CliFx.Infrastructure; namespace CliFx.Infrastructure;
/// <summary> /// <summary>
/// Implements a <see cref="TextWriter"/> for writing characters to a console stream. /// Implements a <see cref="TextWriter" /> for writing characters to a console stream.
/// </summary> /// </summary>
// Both the underlying stream AND the stream writer must be synchronized! // Both the underlying stream AND the stream writer must be synchronized!
// https://github.com/Tyrrrz/CliFx/issues/123 // https://github.com/Tyrrrz/CliFx/issues/123
@@ -20,7 +20,7 @@ public partial class ConsoleWriter : StreamWriter
public IConsole Console { get; } public IConsole Console { get; }
/// <summary> /// <summary>
/// Initializes an instance of <see cref="ConsoleWriter"/>. /// Initializes an instance of <see cref="ConsoleWriter" />.
/// </summary> /// </summary>
public ConsoleWriter(IConsole console, Stream stream, Encoding encoding) public ConsoleWriter(IConsole console, Stream stream, Encoding encoding)
: base(stream, encoding.WithoutPreamble(), 256) : base(stream, encoding.WithoutPreamble(), 256)
@@ -29,7 +29,7 @@ public partial class ConsoleWriter : StreamWriter
} }
/// <summary> /// <summary>
/// Initializes an instance of <see cref="ConsoleWriter"/>. /// Initializes an instance of <see cref="ConsoleWriter" />.
/// </summary> /// </summary>
public ConsoleWriter(IConsole console, Stream stream) public ConsoleWriter(IConsole console, Stream stream)
: this(console, stream, System.Console.OutputEncoding) : this(console, stream, System.Console.OutputEncoding)
@@ -272,10 +272,8 @@ public partial class ConsoleWriter : StreamWriter
public partial class ConsoleWriter public partial class ConsoleWriter
{ {
internal static ConsoleWriter Create(IConsole console, Stream? stream) => new( internal static ConsoleWriter Create(IConsole console, Stream stream) => new(
console, console,
stream is not null Stream.Synchronized(stream)
? Stream.Synchronized(stream)
: Stream.Null
) {AutoFlush = true}; ) {AutoFlush = true};
} }

View File

@@ -4,7 +4,7 @@ using CliFx.Exceptions;
namespace CliFx.Infrastructure; namespace CliFx.Infrastructure;
/// <summary> /// <summary>
/// Implementation of <see cref="ITypeActivator"/> that instantiates an object /// Implementation of <see cref="ITypeActivator" /> that instantiates an object
/// by using its parameterless constructor. /// by using its parameterless constructor.
/// </summary> /// </summary>
public class DefaultTypeActivator : ITypeActivator public class DefaultTypeActivator : ITypeActivator
@@ -20,11 +20,11 @@ public class DefaultTypeActivator : ITypeActivator
catch (MemberAccessException ex) catch (MemberAccessException ex)
{ {
throw CliFxException.InternalError( throw CliFxException.InternalError(
$"Failed to create an instance of type `{type.FullName}`, could not access the constructor." + $"""
Environment.NewLine + Failed to create an instance of type `{type.FullName}`, could not access the constructor.
"Default type activator is only capable of instantiating a type if it has a public parameterless constructor." + Default type activator is only capable of instantiating a type if it has a public parameterless constructor.
Environment.NewLine + To fix this, either add a parameterless constructor to the type or configure a custom activator for the application.
"To fix this, either add a parameterless constructor to the type or configure a custom activator for the application.", """,
ex ex
); );
} }

View File

@@ -4,7 +4,7 @@ using CliFx.Exceptions;
namespace CliFx.Infrastructure; namespace CliFx.Infrastructure;
/// <summary> /// <summary>
/// Implementation of <see cref="ITypeActivator"/> that instantiates an object /// Implementation of <see cref="ITypeActivator" /> that instantiates an object
/// by using a predefined function. /// by using a predefined function.
/// </summary> /// </summary>
public class DelegateTypeActivator : ITypeActivator public class DelegateTypeActivator : ITypeActivator
@@ -12,7 +12,7 @@ public class DelegateTypeActivator : ITypeActivator
private readonly Func<Type, object> _func; private readonly Func<Type, object> _func;
/// <summary> /// <summary>
/// Initializes an instance of <see cref="DelegateTypeActivator"/>. /// Initializes an instance of <see cref="DelegateTypeActivator" />.
/// </summary> /// </summary>
public DelegateTypeActivator(Func<Type, object> func) => _func = func; public DelegateTypeActivator(Func<Type, object> func) => _func = func;
@@ -24,11 +24,11 @@ public class DelegateTypeActivator : ITypeActivator
if (instance is null) if (instance is null)
{ {
throw CliFxException.InternalError( throw CliFxException.InternalError(
$"Failed to create an instance of type `{type.FullName}`, received <null> instead." + $"""
Environment.NewLine + Failed to create an instance of type `{type.FullName}`, received <null> instead.
"To fix this, ensure that the provided type activator is configured correctly, as it's not expected to return <null>." + To fix this, ensure that the provided type activator is configured correctly, as it's not expected to return <null>.
Environment.NewLine + If you are relying on a dependency container, this error may indicate that the specified type has not been registered.
"If you are relying on a dependency container, this error may indicate that the specified type has not been registered." """
); );
} }

View File

@@ -6,7 +6,7 @@ using System.Threading;
namespace CliFx.Infrastructure; namespace CliFx.Infrastructure;
/// <summary> /// <summary>
/// Implementation of <see cref="IConsole"/> that uses the provided fake /// Implementation of <see cref="IConsole" /> that uses the provided fake
/// standard input, output, and error streams. /// standard input, output, and error streams.
/// </summary> /// </summary>
/// <remarks> /// <remarks>
@@ -42,11 +42,10 @@ public class FakeConsole : IConsole, IDisposable
public ConsoleColor BackgroundColor { get; set; } = ConsoleColor.Black; public ConsoleColor BackgroundColor { get; set; } = ConsoleColor.Black;
/// <inheritdoc /> /// <inheritdoc />
public void ResetColor() public int WindowWidth { get; set; } = 232; // Windows defaults
{
ForegroundColor = ConsoleColor.Gray; /// <inheritdoc />
BackgroundColor = ConsoleColor.Black; public int WindowHeight { get; set; } = 14; // Windows defaults
}
/// <inheritdoc /> /// <inheritdoc />
public int CursorLeft { get; set; } public int CursorLeft { get; set; }
@@ -55,13 +54,39 @@ public class FakeConsole : IConsole, IDisposable
public int CursorTop { get; set; } public int CursorTop { get; set; }
/// <summary> /// <summary>
/// Initializes an instance of <see cref="FakeConsole"/>. /// Initializes an instance of <see cref="FakeConsole" />.
/// </summary> /// </summary>
public FakeConsole(Stream? input = null, Stream? output = null, Stream? error = null) public FakeConsole(Stream? input = null, Stream? output = null, Stream? error = null)
{ {
Input = ConsoleReader.Create(this, input); Input = ConsoleReader.Create(this, input ?? Stream.Null);
Output = ConsoleWriter.Create(this, output); Output = ConsoleWriter.Create(this, output ?? Stream.Null);
Error = ConsoleWriter.Create(this, error); Error = ConsoleWriter.Create(this, error ?? Stream.Null);
}
/// <inheritdoc />
public ConsoleKeyInfo ReadKey(bool intercept = false) =>
_keys.TryDequeue(out var key)
? key
: throw new InvalidOperationException(
"Cannot read key because there are no key presses enqueued. " +
$"Use the `{nameof(EnqueueKey)}(...)` method to simulate a key press."
);
/// <summary>
/// Enqueues a simulated key press, which can then be read by calling <see cref="ReadKey" />.
/// </summary>
public void EnqueueKey(ConsoleKeyInfo key) => _keys.Enqueue(key);
/// <inheritdoc />
public void ResetColor()
{
ForegroundColor = ConsoleColor.Gray;
BackgroundColor = ConsoleColor.Black;
}
/// <inheritdoc />
public void Clear()
{
} }
/// <inheritdoc /> /// <inheritdoc />
@@ -71,7 +96,7 @@ public class FakeConsole : IConsole, IDisposable
/// Sends a cancellation signal to the currently executing command. /// Sends a cancellation signal to the currently executing command.
/// </summary> /// </summary>
/// <remarks> /// <remarks>
/// If the command is not cancellation-aware (i.e. it doesn't call <see cref="IConsole.RegisterCancellationHandler"/>), /// If the command is not cancellation-aware (i.e. it doesn't call <see cref="IConsole.RegisterCancellationHandler" />),
/// this method will not have any effect. /// this method will not have any effect.
/// </remarks> /// </remarks>
public void RequestCancellation(TimeSpan? delay = null) public void RequestCancellation(TimeSpan? delay = null)
@@ -87,25 +112,6 @@ public class FakeConsole : IConsole, IDisposable
} }
} }
/// <inheritdoc />
public void Clear()
{
}
/// <inheritdoc />
public ConsoleKeyInfo ReadKey(bool intercept = false) =>
_keys.TryDequeue(out var key)
? key
: throw new InvalidOperationException(
"Cannot read key because there are no key presses enqueued. " +
$"Use the `{nameof(EnqueueKey)}(...)` method to simulate a key press."
);
/// <summary>
/// Enqueues a simulated key press, which can then be read by calling <see cref="ReadKey"/>.
/// </summary>
public void EnqueueKey(ConsoleKeyInfo key) => _keys.Enqueue(key);
/// <inheritdoc /> /// <inheritdoc />
public virtual void Dispose() => _cancellationTokenSource.Dispose(); public virtual void Dispose() => _cancellationTokenSource.Dispose();
} }

View File

@@ -3,7 +3,7 @@
namespace CliFx.Infrastructure; namespace CliFx.Infrastructure;
/// <summary> /// <summary>
/// Implementation of <see cref="IConsole"/> that uses fake /// Implementation of <see cref="IConsole" /> that uses fake
/// standard input, output, and error streams backed by in-memory stores. /// standard input, output, and error streams backed by in-memory stores.
/// </summary> /// </summary>
/// <remarks> /// <remarks>
@@ -24,7 +24,7 @@ public class FakeInMemoryConsole : FakeConsole
} }
/// <summary> /// <summary>
/// Initializes an instance of <see cref="FakeInMemoryConsole"/>. /// Initializes an instance of <see cref="FakeInMemoryConsole" />.
/// </summary> /// </summary>
public FakeInMemoryConsole() public FakeInMemoryConsole()
: this(new MemoryStream(), new MemoryStream(), new MemoryStream()) : this(new MemoryStream(), new MemoryStream(), new MemoryStream())

View File

@@ -15,7 +15,7 @@ public interface IConsole
ConsoleReader Input { get; } ConsoleReader Input { get; }
/// <summary> /// <summary>
/// Whether the input stream is redirected. /// Gets a value that indicates whether input has been redirected from the standard input stream.
/// </summary> /// </summary>
bool IsInputRedirected { get; } bool IsInputRedirected { get; }
@@ -25,7 +25,7 @@ public interface IConsole
ConsoleWriter Output { get; } ConsoleWriter Output { get; }
/// <summary> /// <summary>
/// Whether the output stream is redirected. /// Gets a value that indicates whether output has been redirected from the standard output stream.
/// </summary> /// </summary>
bool IsOutputRedirected { get; } bool IsOutputRedirected { get; }
@@ -35,39 +35,59 @@ public interface IConsole
ConsoleWriter Error { get; } ConsoleWriter Error { get; }
/// <summary> /// <summary>
/// Whether the error stream is redirected. /// Gets a value that indicates whether error output has been redirected from the standard error stream.
/// </summary> /// </summary>
bool IsErrorRedirected { get; } bool IsErrorRedirected { get; }
/// <summary> /// <summary>
/// Current foreground color. /// Gets or sets the foreground color of the console
/// </summary> /// </summary>
ConsoleColor ForegroundColor { get; set; } ConsoleColor ForegroundColor { get; set; }
/// <summary> /// <summary>
/// Current background color. /// Gets or sets the background color of the console.
/// </summary> /// </summary>
ConsoleColor BackgroundColor { get; set; } ConsoleColor BackgroundColor { get; set; }
/// <summary> /// <summary>
/// Resets foreground and background colors to their default values. /// Gets or sets the width of the console window.
/// </summary> /// </summary>
void ResetColor(); int WindowWidth { get; set; }
/// <summary> /// <summary>
/// Cursor left offset. /// Gets or sets the height of the console window.
/// </summary>
int WindowHeight { get; set; }
/// <summary>
/// Gets or sets the column position of the cursor within the buffer area.
/// </summary> /// </summary>
int CursorLeft { get; set; } int CursorLeft { get; set; }
/// <summary> /// <summary>
/// Cursor top offset. /// Gets or sets the row position of the cursor within the buffer area.
/// </summary> /// </summary>
int CursorTop { get; set; } int CursorTop { get; set; }
/// <summary>
/// Obtains the next character or function key pressed by the user.
/// </summary>
ConsoleKeyInfo ReadKey(bool intercept = false);
/// <summary>
/// Sets the foreground and background console colors to their defaults.
/// </summary>
void ResetColor();
/// <summary>
/// Clears the console buffer and corresponding console window of display information.
/// </summary>
void Clear();
/// <summary> /// <summary>
/// Registers a handler for the interrupt signal (Ctrl+C) on the console and returns /// Registers a handler for the interrupt signal (Ctrl+C) on the console and returns
/// a token representing the cancellation request. /// a token representing the cancellation request.
/// Subsequent calls to this method have no side-effects and return the same token. /// Subsequent calls to this method have no side effects and return the same token.
/// </summary> /// </summary>
/// <remarks> /// <remarks>
/// <para> /// <para>
@@ -82,25 +102,15 @@ public interface IConsole
/// </para> /// </para>
/// </remarks> /// </remarks>
CancellationToken RegisterCancellationHandler(); CancellationToken RegisterCancellationHandler();
/// <summary>
/// Clears the console buffer and corresponding console window of display information.
/// </summary>
void Clear();
/// <summary>
/// Obtains the next character or function key pressed by the user.
/// </summary>
ConsoleKeyInfo ReadKey(bool intercept = false);
} }
/// <summary> /// <summary>
/// Extensions for <see cref="IConsole"/>. /// Extensions for <see cref="IConsole" />.
/// </summary> /// </summary>
public static class ConsoleExtensions public static class ConsoleExtensions
{ {
/// <summary> /// <summary>
/// Sets the specified foreground color and returns an <see cref="IDisposable"/> /// Sets the specified foreground color and returns an <see cref="IDisposable" />
/// that will reset the color back to its previous value upon disposal. /// that will reset the color back to its previous value upon disposal.
/// </summary> /// </summary>
public static IDisposable WithForegroundColor(this IConsole console, ConsoleColor foregroundColor) public static IDisposable WithForegroundColor(this IConsole console, ConsoleColor foregroundColor)
@@ -112,7 +122,7 @@ public static class ConsoleExtensions
} }
/// <summary> /// <summary>
/// Sets the specified background color and returns an <see cref="IDisposable"/> /// Sets the specified background color and returns an <see cref="IDisposable" />
/// that will reset the color back to its previous value upon disposal. /// that will reset the color back to its previous value upon disposal.
/// </summary> /// </summary>
public static IDisposable WithBackgroundColor(this IConsole console, ConsoleColor backgroundColor) public static IDisposable WithBackgroundColor(this IConsole console, ConsoleColor backgroundColor)
@@ -124,7 +134,7 @@ public static class ConsoleExtensions
} }
/// <summary> /// <summary>
/// Sets the specified foreground and background colors and returns an <see cref="IDisposable"/> /// Sets the specified foreground and background colors and returns an <see cref="IDisposable" />
/// that will reset the colors back to their previous values upon disposal. /// that will reset the colors back to their previous values upon disposal.
/// </summary> /// </summary>
public static IDisposable WithColors( public static IDisposable WithColors(

Some files were not shown because too many files have changed in this diff Show More