141 Commits

Author SHA1 Message Date
dependabot[bot]
110c390a7b Bump the nuget group with 5 updates (#164)
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-10-02 16:12:23 +03:00
dependabot[bot]
63f57025e8 Bump the nuget group with 5 updates (#163)
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-08-04 14:13:09 +03:00
dependabot[bot]
7f2c00fe3a Bump the nuget group with 7 updates (#162)
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-07-01 18:58:48 +03:00
Tyrrrz
7638b997ff Reorganize dependency conditions 2025-06-08 21:15:32 +03:00
dependabot[bot]
d80d012938 Bump Basic.Reference.Assemblies.Net80 and 5 others (#160)
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-06-02 01:41:55 +03:00
Oleksii Holub
2a02d39dba Allow user-defined options to shadow implicit ones (--help, --version) (#159) 2025-05-12 22:53:08 +03:00
dependabot[bot]
c40b4f3501 Bump Microsoft.Extensions.DependencyInjection in the nuget group (#158)
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-05-03 23:23:58 +03:00
dependabot[bot]
3fb2a2319b Bump the nuget group with 3 updates (#155)
Bumps the nuget group with 3 updates: [FluentAssertions](https://github.com/fluentassertions/fluentassertions), [Microsoft.Extensions.DependencyInjection](https://github.com/dotnet/runtime) and [CliWrap](https://github.com/Tyrrrz/CliWrap).


Updates `FluentAssertions` from 8.1.1 to 8.2.0
- [Release notes](https://github.com/fluentassertions/fluentassertions/releases)
- [Changelog](https://github.com/fluentassertions/fluentassertions/blob/main/AcceptApiChanges.ps1)
- [Commits](https://github.com/fluentassertions/fluentassertions/compare/8.1.1...8.2.0)

Updates `Microsoft.Extensions.DependencyInjection` from 9.0.2 to 9.0.3
- [Release notes](https://github.com/dotnet/runtime/releases)
- [Commits](https://github.com/dotnet/runtime/compare/v9.0.2...v9.0.3)

Updates `CliWrap` from 3.8.1 to 3.8.2
- [Release notes](https://github.com/Tyrrrz/CliWrap/releases)
- [Commits](https://github.com/Tyrrrz/CliWrap/compare/3.8.1...3.8.2)

---
updated-dependencies:
- dependency-name: FluentAssertions
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: nuget
- dependency-name: Microsoft.Extensions.DependencyInjection
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: nuget
- dependency-name: CliWrap
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: nuget
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-04-01 18:35:54 +03:00
dependabot[bot]
1a5a0374c7 Bump the nuget group with 6 updates (#153)
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-03-03 21:47:10 +02:00
Tyrrrz
078ddeaf07 Handle breaking changes 2025-02-02 21:49:30 +02:00
dependabot[bot]
c79a8c6502 Bump the nuget group with 8 updates (#152)
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-02-02 21:36:15 +02:00
dependabot[bot]
cfbd8f9e76 Bump the nuget group with 4 updates (#151)
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-01-01 18:18:20 +02:00
dependabot[bot]
e329f0fc78 Bump the nuget group with 6 updates (#150)
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-12-01 18:44:30 +02:00
Tyrrrz
bc2164499b Disable NuGet audit in benchmarks 2024-11-12 22:47:27 +02:00
Tyrrrz
f5ff6193e8 Use .NET 9 2024-11-12 22:38:15 +02:00
dependabot[bot]
36b2b07a1d Bump the nuget group with 7 updates (#149)
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-11-02 00:46:43 +02:00
Tyrrrz
73bf19d766 Add readme note about keyed services with M.E.DI
Related to #148
2024-10-26 21:51:37 +03:00
Tyrrrz
093b6767c4 Resolve dependency conflicts 2024-10-01 21:49:03 +03:00
dependabot[bot]
e4671e50bb Bump the nuget group with 3 updates (#147)
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-10-01 21:35:02 +03:00
dependabot[bot]
ab48098e06 Bump the nuget group with 5 updates (#146)
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-09-01 19:05:41 +03:00
dependabot[bot]
e99a95ef7c Bump the nuget group with 2 updates (#145)
Bumps the nuget group with 2 updates: [xunit](https://github.com/xunit/xunit) and [xunit.runner.visualstudio](https://github.com/xunit/visualstudio.xunit).


Updates `xunit` from 2.8.1 to 2.9.0
- [Commits](https://github.com/xunit/xunit/compare/2.8.1...2.9.0)

Updates `xunit.runner.visualstudio` from 2.8.1 to 2.8.2
- [Release notes](https://github.com/xunit/visualstudio.xunit/releases)
- [Commits](https://github.com/xunit/visualstudio.xunit/compare/2.8.1...2.8.2)

---
updated-dependencies:
- dependency-name: xunit
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: nuget
- dependency-name: xunit.runner.visualstudio
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: nuget
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-08-01 22:54:53 +03:00
Tyrrrz
bcb34055ac Fix System.Command.Line usage 2024-05-31 18:56:49 +03:00
dependabot[bot]
fe935b5775 Bump the nuget group across 1 directory with 6 updates (#144)
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-05-31 18:48:56 +03:00
Oleksii Holub
7dcd523bfe Create dependabot.yml 2024-05-31 03:32:15 +03:00
Tyrrrz
30bc1d3330 Clean up 2024-05-20 22:42:04 +03:00
Tyrrrz
a5a4ad05a0 Remove missing file references 2024-05-20 18:07:19 +03:00
Tyrrrz
0b77895ca5 Remove changelog 2024-04-28 19:00:24 +03:00
Tyrrrz
54994755b1 Update issue forms 2024-04-28 18:59:11 +03:00
Oleksii Holub
aee63cb9f2 Add Write(...), ``WriteLine(...), Read() and ReadLine() extension methods for IConsole (#140) 2024-01-23 23:57:33 +02:00
Tyrrrz
4bdd3ccc6c Refactor 2024-01-23 23:31:48 +02:00
Tyrrrz
6aa72e45e8 Use latest C# features 2024-01-12 00:10:27 +02:00
Tyrrrz
76e8d47e03 Update license 2024-01-01 03:09:19 +02:00
Tyrrrz
6304b8ab9c Update package release notes link 2023-12-31 16:29:15 +02:00
Tyrrrz
98b50d0e8e Fix typo 2023-12-27 19:24:40 +02:00
Tyrrrz
5aea869c2a Set default version for use during local development 2023-12-27 16:24:32 +02:00
Tyrrrz
425c8f4022 Standardize exception messages 2023-12-25 18:59:30 +02:00
Tyrrrz
490398f773 Refactor with C# 12 features 2023-12-10 22:51:57 +02:00
Tyrrrz
5854f36756 Fix workflows 2023-11-30 00:31:36 +02:00
Tyrrrz
ec6c72e6a3 Don't run the same job for both push and pull_request 2023-11-25 18:58:15 +02:00
Tyrrrz
41bc64be4a Suffix unstable packages with git hash 2023-11-24 20:54:28 +02:00
Tyrrrz
7df0e77e4d Fix typo 2023-11-23 18:44:56 +02:00
Tyrrrz
914e8e17cd Switch to a new versioning strategy 2023-11-23 18:39:03 +02:00
Tyrrrz
40f106d0b0 Update workflows 2023-11-16 21:34:22 +02:00
Tyrrrz
566dd4a9a7 Update version 2023-11-16 00:46:26 +02:00
Tyrrrz
9beb439323 Update NuGet packages 2023-11-16 00:46:16 +02:00
Tyrrrz
029257a915 Update to .NET 8 2023-11-14 20:26:29 +02:00
AliReZa Sabouri
d330fbbb63 Expect same environment variables with different case on Windows (#138) 2023-11-14 18:41:20 +02:00
Tyrrrz
236867f547 Formatting 2023-11-12 20:25:01 +02:00
Tyrrrz
b41e9b4929 Update NuGet packages 2023-11-12 19:08:54 +02:00
Tyrrrz
ff06b8896f More I_can_try pattern in tests 2023-11-11 22:51:42 +02:00
Tyrrrz
0fe9c89fa0 Use the I_can_try_to... naming pattern in tests 2023-11-11 22:35:00 +02:00
Tyrrrz
8646c9de5e Remove some shared project properties 2023-11-11 16:21:53 +02:00
Tyrrrz
a33c42a163 Update gitignore file 2023-11-09 13:41:55 +02:00
Tyrrrz
55cea48cbd Simplify workflows 2023-10-29 00:49:52 +03:00
Tyrrrz
e67eda3515 Make package deployment off by default 2023-10-29 00:39:14 +03:00
Tyrrrz
4412c20e97 Clean up workflow file 2023-10-29 00:32:17 +03:00
Tyrrrz
9eb84c6649 Simplify workflows 2023-10-29 00:25:19 +03:00
Tyrrrz
2ef37ab6d9 Use console instead of sh for syntax highlighting 2023-09-29 13:30:56 +03:00
Tyrrrz
38a73772fc Treat all warnings as errors 2023-09-20 21:32:01 +03:00
Tyrrrz
aed53eb090 Fix formatting 2023-08-22 21:36:05 +03:00
Tyrrrz
21b601da66 Use CSharpier 2023-08-22 21:20:04 +03:00
Tyrrrz
a4726fcefd Normalize injected language tags 2023-08-20 22:14:38 +03:00
Tyrrrz
ab24ca8604 Update issue forms 2023-08-18 01:40:36 +03:00
Tyrrrz
3533bff344 Update issue forms 2023-08-13 13:40:52 +03:00
Tyrrrz
1b096b679e Update issue forms 2023-08-12 21:07:26 +03:00
Tyrrrz
cb61b31e9d Update NuGet packages 2023-08-07 21:56:23 +03:00
Tyrrrz
d8f183c404 Better error messages in CliApplicationBuilder 2023-08-07 21:55:48 +03:00
Tyrrrz
c95b6c32d5 Run test dummy through the app host 2023-08-07 21:55:37 +03:00
Tyrrrz
d2e390c691 Update NuGet packages 2023-08-06 00:20:24 +03:00
Tyrrrz
66ef221586 Add dispatchable workflow for pre-releases 2023-07-26 22:28:37 +03:00
Tyrrrz
2d3bb30125 Update readme 2023-07-17 00:53:16 +03:00
Tyrrrz
5d72692aa5 Update NuGet packages 2023-07-17 00:52:32 +03:00
Tyrrrz
3be17db784 Update NuGet packages 2023-06-26 23:00:43 +03:00
Tyrrrz
4aef8ce8fb Clean up 2023-06-26 22:57:57 +03:00
Tyrrrz
8c1cff3bb7 Add favicon to demo 2023-05-27 13:38:20 +03:00
Tyrrrz
669d8bfe20 Update favicon 2023-05-27 12:41:15 +03:00
Tyrrrz
4dce7bddb4 Update NuGet packages 2023-05-25 08:56:22 +03:00
Tyrrrz
a621e89e89 Consistency in command descriptions 2023-05-20 05:50:04 +03:00
Tyrrrz
5ea11e3a23 Update readme 2023-05-20 03:14:54 +03:00
Tyrrrz
7cb61182d2 Remove unused usings 2023-05-20 03:07:15 +03:00
Tyrrrz
99c59431c4 Update version 2023-05-18 07:30:32 +03:00
Tyrrrz
f376081489 Update NuGet packages 2023-05-18 07:20:27 +03:00
Tyrrrz
00a1e12b5c Test naming consistency 2023-05-17 23:51:21 +03:00
Tyrrrz
81f8b17451 Fix cancellation tests 2023-05-16 02:43:47 +03:00
Tyrrrz
aa8315b68d Clean up 2023-05-16 01:56:28 +03:00
Tyrrrz
e52781c25a Refactor 2023-05-16 01:36:03 +03:00
Tyrrrz
01f29a5375 Fix tests 2023-05-15 05:50:29 +03:00
Tyrrrz
013cb8f66b Add an overload of UseTypeActivator(...) that takes a list of added command types 2023-05-15 05:29:46 +03:00
Tyrrrz
9c715f458e Update version 2023-04-28 17:10:37 +03:00
Tyrrrz
90d93a57ee Remove package readme 2023-04-28 17:09:35 +03:00
Tyrrrz
8da4a61eb7 Fix warnings in local build 2023-04-28 17:07:37 +03:00
Tyrrrz
f718370642 Update NuGet packages 2023-04-28 17:03:30 +03:00
Tyrrrz
83c7af72bf Downgrade target Roslyn version in analyzers
Closes #135
2023-04-28 17:02:50 +03:00
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
169 changed files with 6095 additions and 5916 deletions

View File

@@ -1,42 +1,77 @@
name: 🐞 Bug report name: 🐛 Bug report
description: Report broken functionality. description: Report broken functionality.
labels: [bug] labels: [bug]
body: body:
- type: markdown - type: markdown
attributes: attributes:
value: | value: |
🧐 **Guidelines:** - Avoid generic or vague titles such as "Something's not working" or "A couple of problems" — be as descriptive as possible.
- Keep your issue focused on one single problem. If you have multiple bug reports, please create a separate issue for each of them.
- Issues should represent **complete and actionable** work items. If you are unsure about something or have a question, please start a [discussion](https://github.com/Tyrrrz/CliFx/discussions/new) instead.
- Remember that **CliFx** is an open-source project funded by the community. If you find it useful, **please consider [donating](https://tyrrrz.me/donate) to support its development**.
- Search through [existing issues](https://github.com/Tyrrrz/CliFx/issues?q=is%3Aissue) first to ensure that this bug has not been reported before. ___
- Write a descriptive title for your issue. Avoid generic or vague titles such as "Something's not working" or "A couple of problems".
- Keep your issue focused on one single problem. If you have multiple bug reports, 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 reporting a bug, please use [discussions](https://github.com/Tyrrrz/CliFx/discussions/new) instead.
- type: input - type: input
attributes: attributes:
label: Version label: Version
description: Which version of CliFx does this bug affect? description: Which version of the package does this bug affect? Make sure you're not using an outdated version.
placeholder: ver X.Y.Z placeholder: v1.0.0
validations: validations:
required: true required: true
- type: textarea - type: input
attributes: attributes:
label: Details label: Platform
description: Clear and thorough explanation of the bug. description: Which platform do you experience this bug on?
placeholder: I was doing X expecting Y to happen, but Z happened instead. placeholder: .NET 7.0 / Windows 11
validations: validations:
required: true required: true
- type: textarea - type: textarea
attributes: attributes:
label: Steps to reproduce label: Steps to reproduce
description: Minimum steps required to reproduce the bug. description: >
placeholder: | Minimum steps required to reproduce the bug, including prerequisites, code snippets, or other relevant items.
- Step 1 The information provided in this field must be readily actionable, meaning that anyone should be able to reproduce the bug by following these steps.
- Step 2 If the reproduction steps are too complex to fit in this field, please provide a link to a repository instead.
- Step 3 placeholder: |
validations: - Step 1
required: true - Step 2
- Step 3
validations:
required: true
- type: textarea
attributes:
label: Details
description: Clear and thorough explanation of the bug, including any additional information you may find relevant.
placeholder: |
- Expected behavior: ...
- Actual behavior: ...
validations:
required: true
- type: checkboxes
attributes:
label: Checklist
description: Quick list of checks to ensure that everything is in order.
options:
- label: I have looked through existing issues to make sure that this bug has not been reported before
required: true
- label: I have provided a descriptive title for this issue
required: true
- label: I have made sure that this bug is reproducible on the latest version of the package
required: true
- label: I have provided all the information needed to reproduce this bug as efficiently as possible
required: true
- label: I have sponsored this project
required: false
- label: I have not read any of the above and just checked all the boxes to submit the issue
required: false
- type: markdown
attributes:
value: |
If you are struggling to provide actionable reproduction steps, or if something else is preventing you from creating a complete bug report, please start a [discussion](https://github.com/Tyrrrz/CliFx/discussions/new) instead.

View File

@@ -1,8 +1,11 @@
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: 🗨 Discussions
url: https://github.com/Tyrrrz/CliFx/discussions/new
about: Ask and answer questions.
- 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.
- name: 🗨 Discussions
url: https://github.com/Tyrrrz/CliFx/discussions/new
about: Ask and answer questions.

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

22
.github/dependabot.yml vendored Normal file
View File

@@ -0,0 +1,22 @@
version: 2
updates:
- package-ecosystem: github-actions
directory: "/"
schedule:
interval: monthly
labels:
- enhancement
groups:
actions:
patterns:
- "*"
- package-ecosystem: nuget
directory: "/"
schedule:
interval: monthly
labels:
- enhancement
groups:
nuget:
patterns:
- "*"

View File

@@ -1,13 +1,34 @@
name: main name: main
on: [push, pull_request] on:
workflow_dispatch:
inputs:
package-version:
type: string
description: Package version
required: false
deploy:
type: boolean
description: Deploy package
required: false
default: false
push:
branches:
- master
tags:
- "*"
pull_request:
branches:
- master
jobs: jobs:
main: main:
uses: Tyrrrz/.github/.github/workflows/nuget.yml@master uses: Tyrrrz/.github/.github/workflows/nuget.yml@master
with: with:
dotnet-version: 6.0.x deploy: ${{ inputs.deploy || github.ref_type == 'tag' }}
package-version: ${{ inputs.package-version || (github.ref_type == 'tag' && github.ref_name) || format('0.0.0-ci-{0}', github.sha) }}
dotnet-version: 9.0.x
secrets: secrets:
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }} CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
NUGET_TOKEN: ${{ secrets.NUGET_TOKEN }} NUGET_TOKEN: ${{ secrets.NUGET_TOKEN }}
DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }} DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}

21
.gitignore vendored
View File

@@ -1,21 +1,12 @@
# User-specific files # User-specific files
.vs/
.idea/
*.suo *.suo
*.user *.user
*.userosscache
*.sln.docstates
.idea/
# Build results # Build results
[Dd]ebug/ bin/
[Dd]ebugPublic/ obj/
[Rr]elease/
[Rr]eleases/
[Xx]64/
[Xx]86/
[Bb]uild/
bld/
[Bb]in/
[Oo]bj/
# Coverage # Test results
*.opencover.xml TestResults/

View File

@@ -1,153 +0,0 @@
### 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).
- Added `FakeConsole.EnqueueKey(...)` to facilitate the testing of `IConsole.ReadKey()`. You can use this method to simulate key presses in your application.
- Extended analyzers that verify the correctness of specified converters and validators. They now also ensure that the specified types are compatible with the type of the underlying property.
- Improved diagnostics produced by analyzers. Where relevant, highlighted code is now limited to the property or type identifier, instead of the whole property or type declaration. Also extended the diagnostic messages with additional information.
- Fixed an issue where throwing an exception inside a constructor of a command type resulted in an unrelated error message about the absence of a parameterless constructor.
### v2.2.2 (30-Jan-2022)
- Fixed an issue where `ConsoleWriter` and `ConsoleReader` were not properly thread-safe.
- Fixed an issue where the analyzer failed to load under certain circumstances when running inside Visual Studio.
### v2.2.1 (16-Jan-2022)
- 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)
- Added support for optional parameters. A parameter can be marked as optional by setting `IsRequired = false` on the attribute. Only one parameter is allowed to be optional and such parameter must be the last in order. (Thanks [@AliReZa Sabouri](https://github.com/alirezanet))
- Fixed an issue where parameters and options bound to properties implemented as default interface members were not working correctly. (Thanks [@AliReZa Sabouri](https://github.com/alirezanet))
### v2.1 (04-Jan-2022)
- Added `IConsole.Clear()` with corresponding implementations in `SystemConsole`, `FakeConsole`, and `FakeInMemoryConsole`. (Thanks [@Alex Rosenfeld](https://github.com/alexrosenfeld10))
- Added `IConsole.ReadKey()` with corresponding implementations in `SystemConsole`, `FakeConsole`, and `FakeInMemoryConsole`. (Thanks [@Alex Rosenfeld](https://github.com/alexrosenfeld10))
- Fixed an issue that caused parameters to appear out of order in the usage format section of the help text. (Thanks [@David Fallah](https://github.com/TAGC))
### v2.0.6 (17-Jul-2021)
- 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)
- Fixed an issue where calling `IConsole.Output.Encoding.EncodingName` and some other members threw an exception.
- Added readme file to the package.
### v2.0.4 (24-Apr-2021)
- Fixed an issue where output and error streams in `SystemConsole` defaulted to UTF8 encoding with BOM when the application was running with UTF8 codepage. `ConsoleWriter` will now discard preamble from the specified encoding. This fix brings the behavior of `SystemConsole` in line with .NET's own `System.Console` which also discards preamble for output and error streams.
- Fixed an issue where help text tried to show default values for parameters and options whose type does not override `ToString()` method.
- Fixed an issue where help text didn't show default values for parameters and options whose type is an enumerable of nullable enums. (Thanks [@Robert Dailey](https://github.com/rcdailey))
- Fixed an issue where specific parts of the help text weren't legible in some terminals due to low color resolution. Removed the usage of `ConsoleColor.DarkGray` in help text.
### v2.0.3 (09-Apr-2021)
- Improved help text by showing valid values for non-scalar enum parameters and options. (Thanks [@Robert Dailey](https://github.com/rcdailey))
### v2.0.2 (31-Mar-2021)
- Fixed an issue where having a transitive reference to CliFx sometimes resulted in `SystemConsoleShouldBeAvoidedAnalyzer` throwing `NullReferenceException` during build.
- Fixed some documentation typos and inconsistencies.
### v2.0.1 (24-Mar-2021)
- Fixed an issue where some exceptions with async stack traces generated on .NET 3.1 or earlier were not parsed and formatted correctly.
- Fixed an issue where help text applied slightly incorrect formatting when displaying choices for enum-based parameters and properties.
### v2.0 (21-Mar-2021)
> Note: this major release includes many breaking changes.
> Please refer to the readme to find updated instructions and usage examples.
- Renamed property `EnvironmentVariableName` to `EnvironmentVariable` on `CommandOption` attribute.
- Removed most of schema validation checks that used to take place during application startup. Going forward, CliFx will be relying solely on its built-in set of Roslyn analyzers to catch common errors in command configuration.
- Removed `ProgressTicker` utility. The recommended migration path is to use the [Spectre.Console](https://github.com/spectresystems/spectre.console) library which provides a wide array of console widgets and components. See [this wiki page](https://github.com/Tyrrrz/CliFx/wiki/Integrating-with-Spectre.Console) to learn how to integrate Spectre.Console with CliFx.
- Removed `MemoryStreamWriter` utility as it's no longer used within CliFx.
- Improved wording in all error messages.
- Renamed some methods on `CliApplicationBuilder`:
- `UseTitle()` renamed to `SetTitle()`
- `UseExecutableName()` renamed to `SetExecutableName()`
- `UseVersionText()` renamed to `SetVersion()`
- `UseDescription()` renamed to `SetDescription()`
- Changed the behavior of autogenerated help text:
- Changed the color scheme to a more neutral set of tones
- Assigned separate colors to parameters and options to make them visually stand out
- Usage section no longer lists usage formats of all descendant commands
- Command section now also lists available subcommands for each of the current command's subcommands
- Changed the behavior of `[preview]` directive. Running the application with this directive will now also print all resolved environment variables, in addition to parsed command line arguments.
- Reworked `IArgumentValueConverter`/`ArgumentValueConverter` into `BindingConverter`. Method `ConvertFrom(...)` has been renamed to `Convert(...)`.
- Reworked `ArgumentValueValidator` into `BindingValidator`. This class exposes an abstract `Validate(...)` method that returns a nullable `BindingValidationError`. This class also provides utility methods `Ok()` and `Error(...)` to help create corresponding validation results.
- Changed the type of `IConsole.Output` and `IConsole.Error` from `StreamWriter` to `ConsoleWriter`. This type derives from `StreamWriter` and additionally exposes a `Console` property that refers to the console instance that owns the stream. This change enables you to author extension methods scoped specifically to console output and error streams.
- Changed the type of `IConsole.Input` from `StreamReader` to `ConsoleReader`. This type derives from `StreamReader` 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 the console input stream.
- Changed methods `IConsole.WithForegroundColor(...)`, `IConsole.WithBackgroundColor(...)`, and `IConsole.WithColors(...)` to return `IDisposable`, replacing the delegate parameter they previously had. You can wrap the returned `IDisposable` in a using statement to ensure that the console colors get reset back to their original values once the execution reaches the end of the block.
- Renamed `IConsole.GetCancellationToken()` to `IConsole.RegisterCancellationHandler()`.
- Reworked `VirtualConsole` into `FakeConsole`. This class no longer takes `CancellationToken` as a constructor parameter, but instead encapsulates its own instance of `CancellationTokenSource` that can be triggered using the provided `RequestCancellation()` method.
- Removed `VirtualConsole.CreateBuffered()` and replaced it with the `FakeInMemoryConsole` class. This class derives from `FakeConsole` and uses in-memory standard input, output, and error streams. It also provides methods to easily read the data written to the streams.
- Moved some types to different namespaces:
- `IConsole`/`FakeConsole`/`FakeInMemoryConsole` moved from `CliFx` to `CliFx.Infrastructure`
- `ITypeActivator`/`DefaultTypeActivator`/`DelegateTypeActivator` moved from `CliFx` to `CliFx.Infrastructure`
- `BindingValidator`/`BindingConverter` moved from `CliFx` to `CliFx.Extensibility`
### v1.6 (06-Dec-2020)
- Added support for custom value validators. You can now create a type that inherits from `CliFx.ArgumentValueValidator<T>` to implement reusable validation logic for command arguments. To use a validator, include it in the `Validators` property on the `CommandOption` or `CommandParameter` attribute. (Thanks [@Oleksandr Shustov](https://github.com/AlexandrShustov))
- Added `CliFx.ArgumentValueConverter<T>` class that you can inherit from to implement custom value converters. `CliFx.IArgumentValueConverter` interface is still available, but it is recommended to inherit from the generic class instead, due to the type safety it provides. The interface may become internal or get removed in one of the future major versions.
- Updated requirements for option names and short names: short names now must be letter characters (lowercase or uppercase), while names must now start with a letter character. This means option names can no longer start with a digit or a special character. This change makes it possible to pass negative number values without the need to quote them, i.e. `--my-number -5`.
### v1.5 (23-Oct-2020)
- Added pretty-printing for unhandled exceptions thrown from within the application. This makes the errors easier to parse visually and should help in troubleshooting. This change does not affect `CommandException`, as it already has special treatment. (Thanks [@Mårten Åsberg](https://github.com/89netraM))
- Added support for custom value converters. You can now create a type that implements `CliFx.IArgumentValueConverter` and specify it as a converter for your parameters or options via the `Converter` named property. This should enable conversion between raw argument values and custom types which are not string-initializable. (Thanks [@Oleksandr Shustov](https://github.com/AlexandrShustov))
- Improved help text so that it also shows minimal usage examples for child and descendant commands, besides the actual command it was requested on. This should improve user experience for applications with many nested commands. (Thanks [@Nikiforov Alexey](https://github.com/NikiforovAll))
### v1.4 (20-Aug-2020)
- Added `VirtualConsole.CreateBuffered()` method to simplify test setup when using in-memory backing stores for output and error streams. Please refer to the readme for updated recommendations on how to test applications built with CliFx.
- Added generic `CliApplicationBuilder.AddCommand<TCommand>()`. This overload simplifies adding commands one-by-one as it also checks that the type implements `ICommand`.
### v1.3.2 (31-Jul-2020)
- Fixed an issue where a command was incorrectly allowed to execute when the user did not specify any value for a non-scalar parameter. Since they are always required, a parameter needs to be bound to at least one value. (Thanks [@Daniel Hix](https://github.com/ADustyOldMuffin))
- Fixed an issue where `CliApplication.RunAsync(...)` threw `ArgumentException` if there were two environment variables, whose names differed only in case. Environment variable names are now treated case-sensitively. (Thanks [@Ron Myers](https://github.com/ron-myers))
### v1.3.1 (19-Jul-2020)
- Running the application with the debug directive (`myapp [debug]`) will now also try to launch a debugger instance. In most cases it will save time as you won't need to attach the debugger manually. (Thanks [@Volodymyr Shkolka](https://github.com/BlackGad))
- Fixed an issue where unhandled generic exceptions (i.e. not `CommandException`) sometimes caused the application to incorrectly return successful exit code due to an overflow issue on Unix systems. Starting from this version, all unhandled generic exceptions will produce `1` as the exit code when thrown. Instances of `CommandException` can still be configured to return any specified exit code, but it's recommended to constrain the values between `1` and `255` to avoid overflow issues. (Thanks [@Ihor Nechyporuk](https://github.com/inech))
### v1.3 (23-May-2020)
- 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))
- Changed default version text to only show 3 version components instead of 4, if the last component (revision) is not specified or is zero. This makes the default version text compliant with semantic versioning.
- Fixed an issue where it was possible to define a command with an option that has the same name or short name as built-in help or version options. Previously it would lead to the user-defined option being ignored in favor of the built-in option. Now this will throw an exception instead.
- Changed the underlying representation of `StreamReader`/`StreamWriter` objects used in `SystemConsole` and `VirtualConsole` to be thread-safe.
### v1.2 (11-May-2020)
- 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))
- Improved help text shown for enum options and parameters by providing the list of valid values that the enum can accept. (Thanks [@Domn Werner](https://github.com/domn1995))
- Fixed an issue where it was possible to set an option without providing a value, while the option was marked as required.
- Fixed an issue where it was possible to configure an option with an empty name or a name consisting of a single character. If you want to use a single character as a name, you should set the option's short name instead.
- Added `CursorLeft` and `CursorTop` properties to `IConsole` and its implementations. In `VirtualConsole`, these are just auto-properties.
- Improved exception messages.
- Improved exceptions related to user input by also showing help text after the error message. (Thanks [@Domn Werner](https://github.com/domn1995))
### v1.1 (16-Mar-2020)
- 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 options can be set to multiple argument values while specifying them with mixed naming. For example, `--option value1 -o value2 --option value3` would result in the option being set to corresponding three values, assuming `--option` and `-o` match with the same option.

View File

@@ -1,7 +1,7 @@
<Project Sdk="Microsoft.NET.Sdk"> <Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup> <PropertyGroup>
<TargetFramework>net6.0</TargetFramework> <TargetFramework>net9.0</TargetFramework>
</PropertyGroup> </PropertyGroup>
<ItemGroup> <ItemGroup>
@@ -9,14 +9,15 @@
</ItemGroup> </ItemGroup>
<ItemGroup> <ItemGroup>
<PackageReference Include="Basic.Reference.Assemblies" Version="1.2.4" /> <PackageReference Include="Basic.Reference.Assemblies.Net80" Version="1.8.3" />
<PackageReference Include="GitHubActionsTestLogger" Version="1.4.1" PrivateAssets="all" /> <PackageReference Include="coverlet.collector" Version="6.0.4" PrivateAssets="all" />
<PackageReference Include="FluentAssertions" Version="6.6.0" /> <PackageReference Include="CSharpier.MsBuild" Version="0.30.6" PrivateAssets="all" />
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.1.0" /> <PackageReference Include="GitHubActionsTestLogger" Version="2.4.1" PrivateAssets="all" />
<PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.1.0" /> <PackageReference Include="FluentAssertions" Version="8.7.0" />
<PackageReference Include="xunit" Version="2.4.1" /> <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.14.1" />
<PackageReference Include="xunit.runner.visualstudio" Version="2.4.5" PrivateAssets="all" /> <PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.11.0" />
<PackageReference Include="coverlet.collector" Version="3.1.2" PrivateAssets="all" /> <PackageReference Include="xunit" Version="2.9.3" />
<PackageReference Include="xunit.runner.visualstudio" Version="3.1.5" PrivateAssets="all" />
</ItemGroup> </ItemGroup>
<ItemGroup> <ItemGroup>

View File

@@ -12,12 +12,13 @@ public class CommandMustBeAnnotatedAnalyzerSpecs
public void Analyzer_reports_an_error_if_a_command_is_not_annotated_with_the_command_attribute() public void Analyzer_reports_an_error_if_a_command_is_not_annotated_with_the_command_attribute()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
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);
@@ -27,13 +28,14 @@ public class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_if_a_command_is_annotated_with_the_command_attribute() public void Analyzer_does_not_report_an_error_if_a_command_is_annotated_with_the_command_attribute()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
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);
@@ -43,12 +45,13 @@ public abstract class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_if_a_command_is_implemented_as_an_abstract_class() public void Analyzer_does_not_report_an_error_if_a_command_is_implemented_as_an_abstract_class()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
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);
@@ -58,14 +61,15 @@ public abstract class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_on_a_class_that_is_not_a_command() public void Analyzer_does_not_report_an_error_on_a_class_that_is_not_a_command()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
public class Foo public class Foo
{ {
public int Bar { get; set; } = 5; public int Bar { get; init; } = 5;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
} }
} }

View File

@@ -6,19 +6,21 @@ namespace CliFx.Analyzers.Tests;
public class CommandMustImplementInterfaceAnalyzerSpecs public class CommandMustImplementInterfaceAnalyzerSpecs
{ {
private static DiagnosticAnalyzer Analyzer { get; } = new CommandMustImplementInterfaceAnalyzer(); private static DiagnosticAnalyzer Analyzer { get; } =
new CommandMustImplementInterfaceAnalyzer();
[Fact] [Fact]
public void Analyzer_reports_an_error_if_a_command_does_not_implement_ICommand_interface() public void Analyzer_reports_an_error_if_a_command_does_not_implement_ICommand_interface()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand 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);
@@ -28,13 +30,14 @@ public class MyCommand
public void Analyzer_does_not_report_an_error_if_a_command_implements_ICommand_interface() public void Analyzer_does_not_report_an_error_if_a_command_implements_ICommand_interface()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
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().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -44,14 +47,15 @@ public class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_on_a_class_that_is_not_a_command() public void Analyzer_does_not_report_an_error_on_a_class_that_is_not_a_command()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
public class Foo public class Foo
{ {
public int Bar { get; set; } = 5; public int Bar { get; init; } = 5;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
} }
} }

View File

@@ -13,10 +13,9 @@ public class GeneralSpecs
{ {
// Arrange // Arrange
var analyzers = typeof(AnalyzerBase) var analyzers = typeof(AnalyzerBase)
.Assembly .Assembly.GetTypes()
.GetTypes()
.Where(t => !t.IsAbstract && t.IsAssignableTo(typeof(DiagnosticAnalyzer))) .Where(t => !t.IsAbstract && t.IsAssignableTo(typeof(DiagnosticAnalyzer)))
.Select(t => (DiagnosticAnalyzer) Activator.CreateInstance(t)!) .Select(t => (DiagnosticAnalyzer)Activator.CreateInstance(t)!)
.ToArray(); .ToArray();
// Act // Act
@@ -27,4 +26,4 @@ public class GeneralSpecs
// Assert // Assert
diagnosticIds.Should().OnlyHaveUniqueItems(); diagnosticIds.Should().OnlyHaveUniqueItems();
} }
} }

View File

@@ -12,13 +12,14 @@ public class OptionMustBeInsideCommandAnalyzerSpecs
public void Analyzer_reports_an_error_if_an_option_is_inside_a_class_that_is_not_a_command() public void Analyzer_reports_an_error_if_an_option_is_inside_a_class_that_is_not_a_command()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
public class MyClass public class MyClass
{ {
[CommandOption(""foo"")] [CommandOption("foo")]
public string Foo { get; set; } public string? Foo { get; init; }
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().ProduceDiagnostics(code); Analyzer.Should().ProduceDiagnostics(code);
@@ -28,16 +29,17 @@ public class MyClass
public void Analyzer_does_not_report_an_error_if_an_option_is_inside_a_command() public void Analyzer_does_not_report_an_error_if_an_option_is_inside_a_command()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
[CommandOption(""foo"")] [CommandOption("foo")]
public string Foo { get; set; } public string? Foo { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -47,13 +49,14 @@ public class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_if_an_option_is_inside_an_abstract_class() public void Analyzer_does_not_report_an_error_if_an_option_is_inside_an_abstract_class()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
public abstract class MyCommand public abstract class MyCommand
{ {
[CommandOption(""foo"")] [CommandOption("foo")]
public string Foo { get; set; } public string? Foo { get; init; }
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -63,17 +66,18 @@ public abstract class MyCommand
public void Analyzer_does_not_report_an_error_on_a_property_that_is_not_an_option() public void Analyzer_does_not_report_an_error_on_a_property_that_is_not_an_option()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
public string Foo { get; set; } public string? Foo { get; init; }
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,110 @@
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
// lang=csharp
const string code = """
[Command]
public class MyCommand : ICommand
{
[CommandOption('f', IsRequired = false)]
public required string Foo { get; init; }
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
// lang=csharp
const string code = """
[Command]
public class MyCommand : ICommand
{
[CommandOption('f')]
public required string Foo { get; init; }
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
// lang=csharp
const string code = """
[Command]
public class MyCommand : ICommand
{
[CommandOption('f', IsRequired = false)]
public string? Foo { get; init; }
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
// lang=csharp
const string code = """
[Command]
public class MyCommand : ICommand
{
[CommandOption('f')]
public required string Foo { get; init; }
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
// lang=csharp
const string code = """
[Command]
public class MyCommand : ICommand
{
public required string Foo { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default;
}
""";
// Act & assert
Analyzer.Should().NotProduceDiagnostics(code);
}
}

View File

@@ -6,22 +6,24 @@ namespace CliFx.Analyzers.Tests;
public class OptionMustHaveNameOrShortNameAnalyzerSpecs public class OptionMustHaveNameOrShortNameAnalyzerSpecs
{ {
private static DiagnosticAnalyzer Analyzer { get; } = new OptionMustHaveNameOrShortNameAnalyzer(); private static DiagnosticAnalyzer Analyzer { get; } =
new OptionMustHaveNameOrShortNameAnalyzer();
[Fact] [Fact]
public void Analyzer_reports_an_error_if_an_option_does_not_have_a_name_or_short_name() public void Analyzer_reports_an_error_if_an_option_does_not_have_a_name_or_short_name()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
[CommandOption(null)] [CommandOption(null)]
public string Foo { get; set; } public string? Foo { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().ProduceDiagnostics(code); Analyzer.Should().ProduceDiagnostics(code);
@@ -31,16 +33,17 @@ public class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_if_an_option_has_a_name() public void Analyzer_does_not_report_an_error_if_an_option_has_a_name()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
[CommandOption(""foo"")] [CommandOption("foo")]
public string Foo { get; set; } public string? Foo { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -50,16 +53,17 @@ public class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_if_an_option_has_a_short_name() public void Analyzer_does_not_report_an_error_if_an_option_has_a_short_name()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
[CommandOption('f')] [CommandOption('f')]
public string Foo { get; set; } public string? Foo { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -69,17 +73,18 @@ public class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_on_a_property_that_is_not_an_option() public void Analyzer_does_not_report_an_error_on_a_property_that_is_not_an_option()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
public string Foo { get; set; } public string? Foo { get; init; }
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

@@ -12,19 +12,20 @@ public class OptionMustHaveUniqueNameAnalyzerSpecs
public void Analyzer_reports_an_error_if_an_option_has_the_same_name_as_another_option() public void Analyzer_reports_an_error_if_an_option_has_the_same_name_as_another_option()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
[CommandOption(""foo"")] [CommandOption("foo")]
public string Foo { get; set; } public string? Foo { get; init; }
[CommandOption(""foo"")] [CommandOption("foo")]
public string Bar { get; set; } public string? Bar { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().ProduceDiagnostics(code); Analyzer.Should().ProduceDiagnostics(code);
@@ -34,19 +35,20 @@ public class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_if_an_option_has_a_unique_name() public void Analyzer_does_not_report_an_error_if_an_option_has_a_unique_name()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
[CommandOption(""foo"")] [CommandOption("foo")]
public string Foo { get; set; } public string? Foo { get; init; }
[CommandOption(""bar"")] [CommandOption("bar")]
public string Bar { get; set; } public string? Bar { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -56,16 +58,17 @@ public class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_if_an_option_does_not_have_a_name() public void Analyzer_does_not_report_an_error_if_an_option_does_not_have_a_name()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
[CommandOption('f')] [CommandOption('f')]
public string Foo { get; set; } public string? Foo { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -75,17 +78,18 @@ public class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_on_a_property_that_is_not_an_option() public void Analyzer_does_not_report_an_error_on_a_property_that_is_not_an_option()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
public string Foo { get; set; } public string? Foo { get; init; }
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

@@ -6,25 +6,27 @@ namespace CliFx.Analyzers.Tests;
public class OptionMustHaveUniqueShortNameAnalyzerSpecs public class OptionMustHaveUniqueShortNameAnalyzerSpecs
{ {
private static DiagnosticAnalyzer Analyzer { get; } = new OptionMustHaveUniqueShortNameAnalyzer(); private static DiagnosticAnalyzer Analyzer { get; } =
new OptionMustHaveUniqueShortNameAnalyzer();
[Fact] [Fact]
public void Analyzer_reports_an_error_if_an_option_has_the_same_short_name_as_another_option() public void Analyzer_reports_an_error_if_an_option_has_the_same_short_name_as_another_option()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
[CommandOption('f')] [CommandOption('f')]
public string Foo { get; set; } public string? Foo { get; init; }
[CommandOption('f')] [CommandOption('f')]
public string Bar { get; set; } public string? Bar { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().ProduceDiagnostics(code); Analyzer.Should().ProduceDiagnostics(code);
@@ -34,19 +36,20 @@ public class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_if_an_option_has_a_unique_short_name() public void Analyzer_does_not_report_an_error_if_an_option_has_a_unique_short_name()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
[CommandOption('f')] [CommandOption('f')]
public string Foo { get; set; } public string? Foo { get; init; }
[CommandOption('b')] [CommandOption('b')]
public string Bar { get; set; } public string? Bar { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -56,19 +59,20 @@ public class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_if_an_option_has_a_short_name_which_is_unique_only_in_casing() public void Analyzer_does_not_report_an_error_if_an_option_has_a_short_name_which_is_unique_only_in_casing()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
[CommandOption('f')] [CommandOption('f')]
public string Foo { get; set; } public string? Foo { get; init; }
[CommandOption('F')] [CommandOption('F')]
public string Bar { get; set; } public string? Bar { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -78,16 +82,17 @@ public class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_if_an_option_does_not_have_a_short_name() public void Analyzer_does_not_report_an_error_if_an_option_does_not_have_a_short_name()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
[CommandOption(""foo"")] [CommandOption("foo")]
public string Foo { get; set; } public string? Foo { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -97,17 +102,18 @@ public class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_on_a_property_that_is_not_an_option() public void Analyzer_does_not_report_an_error_on_a_property_that_is_not_an_option()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
public string Foo { get; set; } public string? Foo { get; init; }
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

@@ -6,27 +6,29 @@ namespace CliFx.Analyzers.Tests;
public class OptionMustHaveValidConverterAnalyzerSpecs 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_an_option_has_a_converter_that_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 // lang=csharp
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; init; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().ProduceDiagnostics(code); Analyzer.Should().ProduceDiagnostics(code);
@@ -36,21 +38,22 @@ public class MyCommand : ICommand
public void Analyzer_reports_an_error_if_an_option_has_a_converter_that_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 // lang=csharp
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; init; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().ProduceDiagnostics(code); Analyzer.Should().ProduceDiagnostics(code);
@@ -60,21 +63,22 @@ public class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_if_an_option_has_a_converter_that_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 // lang=csharp
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; init; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -84,21 +88,22 @@ public class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_if_a_nullable_option_has_a_converter_that_derives_from_a_compatible_BindingConverter() public void Analyzer_does_not_report_an_error_if_a_nullable_option_has_a_converter_that_derives_from_a_compatible_BindingConverter()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
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 int? Foo { get; set; } public int? Foo { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -108,21 +113,22 @@ public class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_if_a_non_scalar_option_has_a_converter_that_derives_from_a_compatible_BindingConverter() public void Analyzer_does_not_report_an_error_if_a_non_scalar_option_has_a_converter_that_derives_from_a_compatible_BindingConverter()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
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 IReadOnlyList<string> Foo { get; set; } public IReadOnlyList<string>? Foo { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -132,16 +138,17 @@ public class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_if_an_option_does_not_have_a_converter() public void Analyzer_does_not_report_an_error_if_an_option_does_not_have_a_converter()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
[CommandOption(""foo"")] [CommandOption("foo")]
public string Foo { get; set; } public string? Foo { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -151,17 +158,18 @@ public class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_on_a_property_that_is_not_an_option() public void Analyzer_does_not_report_an_error_on_a_property_that_is_not_an_option()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
public string Foo { get; set; } public string? Foo { get; init; }
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

@@ -12,16 +12,17 @@ public class OptionMustHaveValidNameAnalyzerSpecs
public void Analyzer_reports_an_error_if_an_option_has_a_name_which_is_too_short() public void Analyzer_reports_an_error_if_an_option_has_a_name_which_is_too_short()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
[CommandOption(""f"")] [CommandOption("f")]
public string Foo { get; set; } public string? Foo { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().ProduceDiagnostics(code); Analyzer.Should().ProduceDiagnostics(code);
@@ -31,16 +32,17 @@ public class MyCommand : ICommand
public void Analyzer_reports_an_error_if_an_option_has_a_name_that_starts_with_a_non_letter_character() public void Analyzer_reports_an_error_if_an_option_has_a_name_that_starts_with_a_non_letter_character()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
[CommandOption(""1foo"")] [CommandOption("1foo")]
public string Foo { get; set; } public string? Foo { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().ProduceDiagnostics(code); Analyzer.Should().ProduceDiagnostics(code);
@@ -50,16 +52,17 @@ public class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_if_an_option_has_a_valid_name() public void Analyzer_does_not_report_an_error_if_an_option_has_a_valid_name()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
[CommandOption(""foo"")] [CommandOption("foo")]
public string Foo { get; set; } public string? Foo { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -69,16 +72,17 @@ public class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_if_an_option_does_not_have_a_name() public void Analyzer_does_not_report_an_error_if_an_option_does_not_have_a_name()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
[CommandOption('f')] [CommandOption('f')]
public string Foo { get; set; } public string? Foo { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -88,17 +92,18 @@ public class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_on_a_property_that_is_not_an_option() public void Analyzer_does_not_report_an_error_on_a_property_that_is_not_an_option()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
public string Foo { get; set; } public string? Foo { get; init; }
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

@@ -6,22 +6,24 @@ namespace CliFx.Analyzers.Tests;
public class OptionMustHaveValidShortNameAnalyzerSpecs public class OptionMustHaveValidShortNameAnalyzerSpecs
{ {
private static DiagnosticAnalyzer Analyzer { get; } = new OptionMustHaveValidShortNameAnalyzer(); private static DiagnosticAnalyzer Analyzer { get; } =
new OptionMustHaveValidShortNameAnalyzer();
[Fact] [Fact]
public void Analyzer_reports_an_error_if_an_option_has_a_short_name_which_is_not_a_letter_character() public void Analyzer_reports_an_error_if_an_option_has_a_short_name_which_is_not_a_letter_character()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
[CommandOption('1')] [CommandOption('1')]
public string Foo { get; set; } public string? Foo { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().ProduceDiagnostics(code); Analyzer.Should().ProduceDiagnostics(code);
@@ -31,16 +33,17 @@ public class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_if_an_option_has_a_valid_short_name() public void Analyzer_does_not_report_an_error_if_an_option_has_a_valid_short_name()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
[CommandOption('f')] [CommandOption('f')]
public string Foo { get; set; } public string? Foo { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -50,16 +53,17 @@ public class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_if_an_option_does_not_have_a_short_name() public void Analyzer_does_not_report_an_error_if_an_option_does_not_have_a_short_name()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
[CommandOption(""foo"")] [CommandOption("foo")]
public string Foo { get; set; } public string? Foo { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -69,17 +73,18 @@ public class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_on_a_property_that_is_not_an_option() public void Analyzer_does_not_report_an_error_on_a_property_that_is_not_an_option()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
public string Foo { get; set; } public string? Foo { get; init; }
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

@@ -6,27 +6,29 @@ namespace CliFx.Analyzers.Tests;
public class OptionMustHaveValidValidatorsAnalyzerSpecs 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_an_option_has_a_validator_that_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 // lang=csharp
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; init; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().ProduceDiagnostics(code); Analyzer.Should().ProduceDiagnostics(code);
@@ -36,21 +38,22 @@ public class MyCommand : ICommand
public void Analyzer_reports_an_error_if_an_option_has_a_validator_that_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 // lang=csharp
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; init; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().ProduceDiagnostics(code); Analyzer.Should().ProduceDiagnostics(code);
@@ -60,21 +63,22 @@ public class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_if_an_option_has_validators_that_all_derive_from_compatible_BindingValidators() public void Analyzer_does_not_report_an_error_if_an_option_has_validators_that_all_derive_from_compatible_BindingValidators()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
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; init; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -84,16 +88,17 @@ public class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_if_an_option_does_not_have_validators() public void Analyzer_does_not_report_an_error_if_an_option_does_not_have_validators()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
[CommandOption(""foo"")] [CommandOption("foo")]
public string Foo { get; set; } public string? Foo { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -103,17 +108,18 @@ public class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_on_a_property_that_is_not_an_option() public void Analyzer_does_not_report_an_error_on_a_property_that_is_not_an_option()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
public string Foo { get; set; } public string? Foo { get; init; }
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

@@ -6,19 +6,21 @@ namespace CliFx.Analyzers.Tests;
public class ParameterMustBeInsideCommandAnalyzerSpecs public class ParameterMustBeInsideCommandAnalyzerSpecs
{ {
private static DiagnosticAnalyzer Analyzer { get; } = new ParameterMustBeInsideCommandAnalyzer(); private static DiagnosticAnalyzer Analyzer { get; } =
new ParameterMustBeInsideCommandAnalyzer();
[Fact] [Fact]
public void Analyzer_reports_an_error_if_a_parameter_is_inside_a_class_that_is_not_a_command() public void Analyzer_reports_an_error_if_a_parameter_is_inside_a_class_that_is_not_a_command()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
public class MyClass public class MyClass
{ {
[CommandParameter(0)] [CommandParameter(0)]
public string Foo { get; set; } public required string Foo { get; init; }
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().ProduceDiagnostics(code); Analyzer.Should().ProduceDiagnostics(code);
@@ -28,16 +30,17 @@ public class MyClass
public void Analyzer_does_not_report_an_error_if_a_parameter_is_inside_a_command() public void Analyzer_does_not_report_an_error_if_a_parameter_is_inside_a_command()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
[CommandParameter(0)] [CommandParameter(0)]
public string Foo { get; set; } public required string Foo { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -47,13 +50,14 @@ public class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_if_a_parameter_is_inside_an_abstract_class() public void Analyzer_does_not_report_an_error_if_a_parameter_is_inside_an_abstract_class()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
public abstract class MyCommand public abstract class MyCommand
{ {
[CommandParameter(0)] [CommandParameter(0)]
public string Foo { get; set; } public required string Foo { get; init; }
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -63,17 +67,18 @@ public abstract class MyCommand
public void Analyzer_does_not_report_an_error_on_a_property_that_is_not_a_parameter() public void Analyzer_does_not_report_an_error_on_a_property_that_is_not_a_parameter()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
public string Foo { get; set; } public string? Foo { get; init; }
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

@@ -6,25 +6,27 @@ namespace CliFx.Analyzers.Tests;
public class ParameterMustBeLastIfNonRequiredAnalyzerSpecs public class ParameterMustBeLastIfNonRequiredAnalyzerSpecs
{ {
private static DiagnosticAnalyzer Analyzer { get; } = new ParameterMustBeLastIfNonRequiredAnalyzer(); private static DiagnosticAnalyzer Analyzer { get; } =
new ParameterMustBeLastIfNonRequiredAnalyzer();
[Fact] [Fact]
public void Analyzer_reports_an_error_if_a_non_required_parameter_is_not_the_last_in_order() public void Analyzer_reports_an_error_if_a_non_required_parameter_is_not_the_last_in_order()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
[CommandParameter(0, Name = ""foo"", IsRequired = false)] [CommandParameter(0, IsRequired = false)]
public string Foo { get; set; } public string? Foo { get; init; }
[CommandParameter(1, Name = ""bar"")] [CommandParameter(1)]
public string Bar { get; set; } public required string Bar { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().ProduceDiagnostics(code); Analyzer.Should().ProduceDiagnostics(code);
@@ -34,19 +36,20 @@ public class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_if_a_non_required_parameter_is_the_last_in_order() public void Analyzer_does_not_report_an_error_if_a_non_required_parameter_is_the_last_in_order()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
[CommandParameter(0, Name = ""foo"")] [CommandParameter(0)]
public string Foo { get; set; } public required string Foo { get; init; }
[CommandParameter(1, Name = ""bar"", IsRequired = false)] [CommandParameter(1, IsRequired = false)]
public string Bar { get; set; } public string? Bar { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -56,19 +59,20 @@ public class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_if_no_non_required_parameters_are_defined() public void Analyzer_does_not_report_an_error_if_no_non_required_parameters_are_defined()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
[CommandParameter(0, Name = ""foo"")] [CommandParameter(0)]
public string Foo { get; set; } public required string Foo { get; init; }
[CommandParameter(1, Name = ""bar"", IsRequired = true)] [CommandParameter(1)]
public string Bar { get; set; } public required string Bar { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -78,17 +82,18 @@ public class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_on_a_property_that_is_not_a_parameter() public void Analyzer_does_not_report_an_error_on_a_property_that_is_not_a_parameter()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
public string Foo { get; set; } public string? Foo { get; init; }
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

@@ -6,25 +6,27 @@ namespace CliFx.Analyzers.Tests;
public class ParameterMustBeLastIfNonScalarAnalyzerSpecs public class ParameterMustBeLastIfNonScalarAnalyzerSpecs
{ {
private static DiagnosticAnalyzer Analyzer { get; } = new ParameterMustBeLastIfNonScalarAnalyzer(); private static DiagnosticAnalyzer Analyzer { get; } =
new ParameterMustBeLastIfNonScalarAnalyzer();
[Fact] [Fact]
public void Analyzer_reports_an_error_if_a_non_scalar_parameter_is_not_the_last_in_order() public void Analyzer_reports_an_error_if_a_non_scalar_parameter_is_not_the_last_in_order()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
[CommandParameter(0)] [CommandParameter(0)]
public string[] Foo { get; set; } public required string[] Foo { get; init; }
[CommandParameter(1)] [CommandParameter(1)]
public string Bar { get; set; } public required string Bar { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().ProduceDiagnostics(code); Analyzer.Should().ProduceDiagnostics(code);
@@ -34,19 +36,20 @@ public class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_if_a_non_scalar_parameter_is_the_last_in_order() public void Analyzer_does_not_report_an_error_if_a_non_scalar_parameter_is_the_last_in_order()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
[CommandParameter(0)] [CommandParameter(0)]
public string Foo { get; set; } public required string Foo { get; init; }
[CommandParameter(1)] [CommandParameter(1)]
public string[] Bar { get; set; } public required string[] Bar { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -56,19 +59,20 @@ public class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_if_no_non_scalar_parameters_are_defined() public void Analyzer_does_not_report_an_error_if_no_non_scalar_parameters_are_defined()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
[CommandParameter(0)] [CommandParameter(0)]
public string Foo { get; set; } public required string Foo { get; init; }
[CommandParameter(1)] [CommandParameter(1)]
public string Bar { get; set; } public required string Bar { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -78,17 +82,18 @@ public class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_on_a_property_that_is_not_a_parameter() public void Analyzer_does_not_report_an_error_on_a_property_that_is_not_a_parameter()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
public string Foo { get; set; } public string? Foo { get; init; }
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,110 @@
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
// lang=csharp
const string code = """
[Command]
public class MyCommand : ICommand
{
[CommandParameter(0, IsRequired = false)]
public required string? Foo { get; init; }
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
// lang=csharp
const string code = """
[Command]
public class MyCommand : ICommand
{
[CommandParameter(0)]
public required string Foo { get; init; }
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
// lang=csharp
const string code = """
[Command]
public class MyCommand : ICommand
{
[CommandParameter(0, IsRequired = false)]
public string? Foo { get; init; }
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
// lang=csharp
const string code = """
[Command]
public class MyCommand : ICommand
{
[CommandParameter(0)]
public required string Foo { get; init; }
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
// lang=csharp
const string code = """
[Command]
public class MyCommand : ICommand
{
public required string Foo { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default;
}
""";
// Act & assert
Analyzer.Should().NotProduceDiagnostics(code);
}
}

View File

@@ -6,25 +6,27 @@ namespace CliFx.Analyzers.Tests;
public class ParameterMustBeSingleIfNonRequiredAnalyzerSpecs public class ParameterMustBeSingleIfNonRequiredAnalyzerSpecs
{ {
private static DiagnosticAnalyzer Analyzer { get; } = new ParameterMustBeSingleIfNonRequiredAnalyzer(); private static DiagnosticAnalyzer Analyzer { get; } =
new ParameterMustBeSingleIfNonRequiredAnalyzer();
[Fact] [Fact]
public void Analyzer_reports_an_error_if_more_than_one_non_required_parameters_are_defined() public void Analyzer_reports_an_error_if_more_than_one_non_required_parameters_are_defined()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
[CommandParameter(0, IsRequired = false)] [CommandParameter(0, IsRequired = false)]
public string Foo { get; set; } public string? Foo { get; init; }
[CommandParameter(1, IsRequired = false)] [CommandParameter(1, IsRequired = false)]
public string Bar { get; set; } public string? Bar { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().ProduceDiagnostics(code); Analyzer.Should().ProduceDiagnostics(code);
@@ -34,19 +36,20 @@ public class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_if_only_one_non_required_parameter_is_defined() public void Analyzer_does_not_report_an_error_if_only_one_non_required_parameter_is_defined()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
[CommandParameter(0)] [CommandParameter(0)]
public string Foo { get; set; } public required string Foo { get; init; }
[CommandParameter(1, IsRequired = false)] [CommandParameter(1, IsRequired = false)]
public string Bar { get; set; } public string? Bar { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -56,19 +59,20 @@ public class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_if_no_non_required_parameters_are_defined() public void Analyzer_does_not_report_an_error_if_no_non_required_parameters_are_defined()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
[CommandParameter(0)] [CommandParameter(0)]
public string Foo { get; set; } public required string Foo { get; init; }
[CommandParameter(1, IsRequired = true)] [CommandParameter(1)]
public string Bar { get; set; } public required string Bar { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -78,17 +82,18 @@ public class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_on_a_property_that_is_not_a_parameter() public void Analyzer_does_not_report_an_error_on_a_property_that_is_not_a_parameter()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
public string Foo { get; set; } public string? Foo { get; init; }
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

@@ -6,25 +6,27 @@ namespace CliFx.Analyzers.Tests;
public class ParameterMustBeSingleIfNonScalarAnalyzerSpecs public class ParameterMustBeSingleIfNonScalarAnalyzerSpecs
{ {
private static DiagnosticAnalyzer Analyzer { get; } = new ParameterMustBeSingleIfNonScalarAnalyzer(); private static DiagnosticAnalyzer Analyzer { get; } =
new ParameterMustBeSingleIfNonScalarAnalyzer();
[Fact] [Fact]
public void Analyzer_reports_an_error_if_more_than_one_non_scalar_parameters_are_defined() public void Analyzer_reports_an_error_if_more_than_one_non_scalar_parameters_are_defined()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
[CommandParameter(0)] [CommandParameter(0)]
public string[] Foo { get; set; } public required string[] Foo { get; init; }
[CommandParameter(1)] [CommandParameter(1)]
public string[] Bar { get; set; } public required string[] Bar { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().ProduceDiagnostics(code); Analyzer.Should().ProduceDiagnostics(code);
@@ -34,19 +36,20 @@ public class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_if_only_one_non_scalar_parameter_is_defined() public void Analyzer_does_not_report_an_error_if_only_one_non_scalar_parameter_is_defined()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
[CommandParameter(0)] [CommandParameter(0)]
public string Foo { get; set; } public required string Foo { get; init; }
[CommandParameter(1)] [CommandParameter(1)]
public string[] Bar { get; set; } public required string[] Bar { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -56,19 +59,20 @@ public class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_if_no_non_scalar_parameters_are_defined() public void Analyzer_does_not_report_an_error_if_no_non_scalar_parameters_are_defined()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
[CommandParameter(0)] [CommandParameter(0)]
public string Foo { get; set; } public required string Foo { get; init; }
[CommandParameter(1)] [CommandParameter(1)]
public string Bar { get; set; } public required string Bar { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -78,17 +82,18 @@ public class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_on_a_property_that_is_not_a_parameter() public void Analyzer_does_not_report_an_error_on_a_property_that_is_not_a_parameter()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
public string Foo { get; set; } public string? Foo { get; init; }
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

@@ -12,19 +12,20 @@ public class ParameterMustHaveUniqueNameAnalyzerSpecs
public void Analyzer_reports_an_error_if_a_parameter_has_the_same_name_as_another_parameter() public void Analyzer_reports_an_error_if_a_parameter_has_the_same_name_as_another_parameter()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
[CommandParameter(0, Name = ""foo"")] [CommandParameter(0, Name = "foo")]
public string Foo { get; set; } public required string Foo { get; init; }
[CommandParameter(1, Name = ""foo"")] [CommandParameter(1, Name = "foo")]
public string Bar { get; set; } public required string Bar { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().ProduceDiagnostics(code); Analyzer.Should().ProduceDiagnostics(code);
@@ -34,19 +35,20 @@ public class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_if_a_parameter_has_unique_name() public void Analyzer_does_not_report_an_error_if_a_parameter_has_unique_name()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
[CommandParameter(0, Name = ""foo"")] [CommandParameter(0, Name = "foo")]
public string Foo { get; set; } public required string Foo { get; init; }
[CommandParameter(1, Name = ""bar"")] [CommandParameter(1, Name = "bar")]
public string Bar { get; set; } public required string Bar { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -56,17 +58,18 @@ public class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_on_a_property_that_is_not_a_parameter() public void Analyzer_does_not_report_an_error_on_a_property_that_is_not_a_parameter()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
public string Foo { get; set; } public string? Foo { get; init; }
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

@@ -6,25 +6,27 @@ namespace CliFx.Analyzers.Tests;
public class ParameterMustHaveUniqueOrderAnalyzerSpecs public class ParameterMustHaveUniqueOrderAnalyzerSpecs
{ {
private static DiagnosticAnalyzer Analyzer { get; } = new ParameterMustHaveUniqueOrderAnalyzer(); private static DiagnosticAnalyzer Analyzer { get; } =
new ParameterMustHaveUniqueOrderAnalyzer();
[Fact] [Fact]
public void Analyzer_reports_an_error_if_a_parameter_has_the_same_order_as_another_parameter() public void Analyzer_reports_an_error_if_a_parameter_has_the_same_order_as_another_parameter()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
[CommandParameter(0)] [CommandParameter(0)]
public string Foo { get; set; } public required string Foo { get; init; }
[CommandParameter(0)] [CommandParameter(0)]
public string Bar { get; set; } public required string Bar { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().ProduceDiagnostics(code); Analyzer.Should().ProduceDiagnostics(code);
@@ -34,19 +36,20 @@ public class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_if_a_parameter_has_unique_order() public void Analyzer_does_not_report_an_error_if_a_parameter_has_unique_order()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
[CommandParameter(0)] [CommandParameter(0)]
public string Foo { get; set; } public required string Foo { get; init; }
[CommandParameter(1)] [CommandParameter(1)]
public string Bar { get; set; } public required string Bar { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -56,17 +59,18 @@ public class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_on_a_property_that_is_not_a_parameter() public void Analyzer_does_not_report_an_error_on_a_property_that_is_not_a_parameter()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
public string Foo { get; set; } public string? Foo { get; init; }
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

@@ -6,27 +6,29 @@ namespace CliFx.Analyzers.Tests;
public class ParameterMustHaveValidConverterAnalyzerSpecs 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_a_parameter_has_a_converter_that_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 // lang=csharp
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 required string Foo { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().ProduceDiagnostics(code); Analyzer.Should().ProduceDiagnostics(code);
@@ -36,22 +38,22 @@ public class MyCommand : ICommand
public void Analyzer_reports_an_error_if_a_parameter_has_a_converter_that_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 // lang=csharp
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 required string Foo { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default;
}";
public ValueTask ExecuteAsync(IConsole console) => default;
}
""";
// Act & assert // Act & assert
Analyzer.Should().ProduceDiagnostics(code); Analyzer.Should().ProduceDiagnostics(code);
@@ -61,21 +63,22 @@ public class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_if_a_parameter_has_a_converter_that_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 // lang=csharp
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 required string Foo { get; init; }
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,21 +88,22 @@ public class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_if_a_nullable_parameter_has_a_converter_that_derives_from_a_compatible_BindingConverter() public void Analyzer_does_not_report_an_error_if_a_nullable_parameter_has_a_converter_that_derives_from_a_compatible_BindingConverter()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
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 int? Foo { get; set; } public int? Foo { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -109,21 +113,22 @@ public class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_if_a_non_scalar_parameter_has_a_converter_that_derives_from_a_compatible_BindingConverter() public void Analyzer_does_not_report_an_error_if_a_non_scalar_parameter_has_a_converter_that_derives_from_a_compatible_BindingConverter()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
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 IReadOnlyList<string> Foo { get; set; } public required IReadOnlyList<string> Foo { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -133,16 +138,17 @@ public class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_if_a_parameter_does_not_have_a_converter() public void Analyzer_does_not_report_an_error_if_a_parameter_does_not_have_a_converter()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
[CommandParameter(0)] [CommandParameter(0)]
public string Foo { get; set; } public required string Foo { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -152,17 +158,18 @@ public class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_on_a_property_that_is_not_a_parameter() public void Analyzer_does_not_report_an_error_on_a_property_that_is_not_a_parameter()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
public string Foo { get; set; } public string? Foo { get; init; }
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

@@ -6,27 +6,29 @@ namespace CliFx.Analyzers.Tests;
public class ParameterMustHaveValidValidatorsAnalyzerSpecs 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_a_parameter_has_a_validator_that_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 // lang=csharp
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 required string Foo { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().ProduceDiagnostics(code); Analyzer.Should().ProduceDiagnostics(code);
@@ -36,21 +38,22 @@ public class MyCommand : ICommand
public void Analyzer_reports_an_error_if_a_parameter_has_a_validator_that_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 // lang=csharp
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 required string Foo { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().ProduceDiagnostics(code); Analyzer.Should().ProduceDiagnostics(code);
@@ -60,21 +63,22 @@ public class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_if_a_parameter_has_validators_that_all_derive_from_compatible_BindingValidators() public void Analyzer_does_not_report_an_error_if_a_parameter_has_validators_that_all_derive_from_compatible_BindingValidators()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
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 required string Foo { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -84,16 +88,17 @@ public class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_if_a_parameter_does_not_have_validators() public void Analyzer_does_not_report_an_error_if_a_parameter_does_not_have_validators()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
[CommandParameter(0)] [CommandParameter(0)]
public string Foo { get; set; } public required string Foo { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -103,17 +108,18 @@ public class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_on_a_property_that_is_not_a_parameter() public void Analyzer_does_not_report_an_error_on_a_property_that_is_not_a_parameter()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
public string Foo { get; set; } public string? Foo { get; init; }
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

@@ -6,23 +6,25 @@ namespace CliFx.Analyzers.Tests;
public class SystemConsoleShouldBeAvoidedAnalyzerSpecs public class SystemConsoleShouldBeAvoidedAnalyzerSpecs
{ {
private static DiagnosticAnalyzer Analyzer { get; } = new SystemConsoleShouldBeAvoidedAnalyzer(); private static DiagnosticAnalyzer Analyzer { get; } =
new SystemConsoleShouldBeAvoidedAnalyzer();
[Fact] [Fact]
public void Analyzer_reports_an_error_if_a_command_calls_a_method_on_SystemConsole() public void Analyzer_reports_an_error_if_a_command_calls_a_method_on_SystemConsole()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
public ValueTask ExecuteAsync(IConsole console) public ValueTask ExecuteAsync(IConsole console)
{ {
Console.WriteLine(""Hello world""); Console.WriteLine("Hello world");
return default; return default;
} }
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().ProduceDiagnostics(code); Analyzer.Should().ProduceDiagnostics(code);
@@ -32,17 +34,19 @@ public class MyCommand : ICommand
public void Analyzer_reports_an_error_if_a_command_accesses_a_property_on_SystemConsole() public void Analyzer_reports_an_error_if_a_command_accesses_a_property_on_SystemConsole()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
public ValueTask ExecuteAsync(IConsole console) public ValueTask ExecuteAsync(IConsole console)
{ {
Console.ForegroundColor = ConsoleColor.Black; Console.ForegroundColor = ConsoleColor.Black;
return default; return default;
} }
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().ProduceDiagnostics(code); Analyzer.Should().ProduceDiagnostics(code);
} }
@@ -51,17 +55,18 @@ public class MyCommand : ICommand
public void Analyzer_reports_an_error_if_a_command_calls_a_method_on_a_property_of_SystemConsole() public void Analyzer_reports_an_error_if_a_command_calls_a_method_on_a_property_of_SystemConsole()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
public ValueTask ExecuteAsync(IConsole console) public ValueTask ExecuteAsync(IConsole console)
{ {
Console.Error.WriteLine(""Hello world""); Console.Error.WriteLine("Hello world");
return default; return default;
} }
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().ProduceDiagnostics(code); Analyzer.Should().ProduceDiagnostics(code);
@@ -71,17 +76,18 @@ public class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_if_a_command_interacts_with_the_console_through_IConsole() public void Analyzer_does_not_report_an_error_if_a_command_interacts_with_the_console_through_IConsole()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand public class MyCommand : ICommand
{ {
public ValueTask ExecuteAsync(IConsole console) public ValueTask ExecuteAsync(IConsole console)
{ {
console.Output.WriteLine(""Hello world""); console.WriteLine("Hello world");
return default; return default;
} }
}"; }
""";
// Act & assert // Act & assert
Analyzer.Should().NotProduceDiagnostics(code); Analyzer.Should().NotProduceDiagnostics(code);
@@ -91,15 +97,16 @@ public class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_if_IConsole_is_not_available_in_the_current_method() public void Analyzer_does_not_report_an_error_if_IConsole_is_not_available_in_the_current_method()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand 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);
@@ -109,18 +116,19 @@ public class MyCommand : ICommand
public void Analyzer_does_not_report_an_error_if_a_command_does_not_access_SystemConsole() public void Analyzer_does_not_report_an_error_if_a_command_does_not_access_SystemConsole()
{ {
// Arrange // Arrange
// language=cs // lang=csharp
const string code = @" const string code = """
[Command] [Command]
public class MyCommand : ICommand 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

@@ -13,14 +13,12 @@ using Microsoft.CodeAnalysis.Text;
namespace CliFx.Analyzers.Tests.Utils; namespace CliFx.Analyzers.Tests.Utils;
internal class AnalyzerAssertions : ReferenceTypeAssertions<DiagnosticAnalyzer, AnalyzerAssertions> internal class AnalyzerAssertions(DiagnosticAnalyzer analyzer, AssertionChain assertionChain)
: ReferenceTypeAssertions<DiagnosticAnalyzer, AnalyzerAssertions>(analyzer, assertionChain)
{ {
protected override string Identifier { get; } = "analyzer"; private readonly AssertionChain _assertionChain = assertionChain;
public AnalyzerAssertions(DiagnosticAnalyzer analyzer) protected override string Identifier => "analyzer";
: base(analyzer)
{
}
private Compilation Compile(string sourceCode) private Compilation Compile(string sourceCode)
{ {
@@ -29,13 +27,12 @@ internal class AnalyzerAssertions : ReferenceTypeAssertions<DiagnosticAnalyzer,
{ {
"System", "System",
"System.Collections.Generic", "System.Collections.Generic",
"System.Threading.Tasks" "System.Threading.Tasks",
}; };
// Get default CliFx namespaces // Get default CliFx namespaces
var defaultCliFxNamespaces = typeof(ICommand) var defaultCliFxNamespaces = typeof(ICommand)
.Assembly .Assembly.GetTypes()
.GetTypes()
.Where(t => t.IsPublic) .Where(t => t.IsPublic)
.Select(t => t.Namespace) .Select(t => t.Namespace)
.Distinct() .Distinct()
@@ -43,23 +40,24 @@ internal class AnalyzerAssertions : ReferenceTypeAssertions<DiagnosticAnalyzer,
// Append default imports to the source code // Append default imports to the source code
var sourceCodeWithUsings = var sourceCodeWithUsings =
string.Join(Environment.NewLine, defaultSystemNamespaces.Select(n => $"using {n};")) + string.Join(Environment.NewLine, defaultSystemNamespaces.Select(n => $"using {n};"))
string.Join(Environment.NewLine, defaultCliFxNamespaces.Select(n => $"using {n};")) + + string.Join(Environment.NewLine, defaultCliFxNamespaces.Select(n => $"using {n};"))
Environment.NewLine + + Environment.NewLine
sourceCode; + sourceCode;
// Parse the source code // Parse the source code
var ast = SyntaxFactory.ParseSyntaxTree( var ast = SyntaxFactory.ParseSyntaxTree(
SourceText.From(sourceCodeWithUsings), SourceText.From(sourceCodeWithUsings),
CSharpParseOptions.Default CSharpParseOptions.Default.WithLanguageVersion(LanguageVersion.Preview)
); );
// Compile the code to IL // Compile the code to IL
var compilation = CSharpCompilation.Create( var compilation = CSharpCompilation.Create(
"CliFxTests_DynamicAssembly_" + Guid.NewGuid(), "CliFxTests_DynamicAssembly_" + Guid.NewGuid(),
new[] { ast }, [ast],
ReferenceAssemblies.Net50 Net80.References.All.Append(
.Append(MetadataReference.CreateFromFile(typeof(ICommand).Assembly.Location)), 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 +70,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()))}
"""
); );
} }
@@ -102,44 +101,46 @@ internal class AnalyzerAssertions : ReferenceTypeAssertions<DiagnosticAnalyzer,
var producedDiagnosticIds = producedDiagnostics.Select(d => d.Id).Distinct().ToArray(); var producedDiagnosticIds = producedDiagnostics.Select(d => d.Id).Distinct().ToArray();
var isSuccessfulAssertion = var isSuccessfulAssertion =
expectedDiagnosticIds.Intersect(producedDiagnosticIds).Count() == expectedDiagnosticIds.Intersect(producedDiagnosticIds).Count()
expectedDiagnosticIds.Length; == expectedDiagnosticIds.Length;
Execute.Assertion.ForCondition(isSuccessfulAssertion).FailWith(() => _assertionChain
{ .ForCondition(isSuccessfulAssertion)
var buffer = new StringBuilder(); .FailWith(() =>
buffer.AppendLine("Expected and produced diagnostics do not match.");
buffer.AppendLine();
buffer.AppendLine("Expected diagnostics:");
foreach (var expectedDiagnostic in expectedDiagnostics)
{ {
buffer.Append(" - "); var buffer = new StringBuilder();
buffer.Append(expectedDiagnostic.Id);
buffer.AppendLine("Expected and produced diagnostics do not match.");
buffer.AppendLine(); buffer.AppendLine();
}
buffer.AppendLine(); buffer.AppendLine("Expected diagnostics:");
buffer.AppendLine("Produced diagnostics:"); foreach (var expectedDiagnostic in expectedDiagnostics)
if (producedDiagnostics.Any())
{
foreach (var producedDiagnostic in producedDiagnostics)
{ {
buffer.Append(" - "); buffer.Append(" - ");
buffer.Append(producedDiagnostic); buffer.Append(expectedDiagnostic.Id);
buffer.AppendLine();
} }
}
else
{
buffer.AppendLine(" < none >");
}
return new FailReason(buffer.ToString()); buffer.AppendLine();
});
buffer.AppendLine("Produced diagnostics:");
if (producedDiagnostics.Any())
{
foreach (var producedDiagnostic in producedDiagnostics)
{
buffer.Append(" - ");
buffer.Append(producedDiagnostic);
}
}
else
{
buffer.AppendLine(" < none >");
}
return new FailReason(buffer.ToString());
});
} }
public void NotProduceDiagnostics(string sourceCode) public void NotProduceDiagnostics(string sourceCode)
@@ -147,27 +148,30 @@ internal class AnalyzerAssertions : ReferenceTypeAssertions<DiagnosticAnalyzer,
var producedDiagnostics = GetProducedDiagnostics(sourceCode); var producedDiagnostics = GetProducedDiagnostics(sourceCode);
var isSuccessfulAssertion = !producedDiagnostics.Any(); var isSuccessfulAssertion = !producedDiagnostics.Any();
Execute.Assertion.ForCondition(isSuccessfulAssertion).FailWith(() => _assertionChain
{ .ForCondition(isSuccessfulAssertion)
var buffer = new StringBuilder(); .FailWith(() =>
buffer.AppendLine("Expected no produced diagnostics.");
buffer.AppendLine();
buffer.AppendLine("Produced diagnostics:");
foreach (var producedDiagnostic in producedDiagnostics)
{ {
buffer.Append(" - "); var buffer = new StringBuilder();
buffer.Append(producedDiagnostic);
}
return new FailReason(buffer.ToString()); buffer.AppendLine("Expected no produced diagnostics.");
}); buffer.AppendLine();
buffer.AppendLine("Produced diagnostics:");
foreach (var producedDiagnostic in producedDiagnostics)
{
buffer.Append(" - ");
buffer.Append(producedDiagnostic);
}
return new FailReason(buffer.ToString());
});
} }
} }
internal static class AnalyzerAssertionsExtensions internal static class AnalyzerAssertionsExtensions
{ {
public static AnalyzerAssertions Should(this DiagnosticAnalyzer analyzer) => new(analyzer); public static AnalyzerAssertions Should(this DiagnosticAnalyzer analyzer) =>
} new(analyzer, AssertionChain.GetOrCreate());
}

View File

@@ -14,7 +14,8 @@ public abstract class AnalyzerBase : DiagnosticAnalyzer
protected AnalyzerBase( protected AnalyzerBase(
string diagnosticTitle, string diagnosticTitle,
string diagnosticMessage, string diagnosticMessage,
DiagnosticSeverity diagnosticSeverity = DiagnosticSeverity.Error) DiagnosticSeverity diagnosticSeverity = DiagnosticSeverity.Error
)
{ {
SupportedDiagnostic = new DiagnosticDescriptor( SupportedDiagnostic = new DiagnosticDescriptor(
"CliFx_" + GetType().Name.TrimEnd("Analyzer"), "CliFx_" + GetType().Name.TrimEnd("Analyzer"),
@@ -36,4 +37,4 @@ public abstract class AnalyzerBase : DiagnosticAnalyzer
context.EnableConcurrentExecution(); context.EnableConcurrentExecution();
context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.None); context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.None);
} }
} }

View File

@@ -3,14 +3,25 @@
<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>
<!-- Keep this dependency as low as possible since we can't bundle it --> <PackageReference Include="CSharpier.MsBuild" Version="0.30.6" PrivateAssets="all" />
<!-- https://github.com/Tyrrrz/CliFx/issues/127 --> <!-- Make sure to target the lowest possible version of the compiler for wider support -->
<PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="3.8.0" PrivateAssets="all" /> <PackageReference Include="Microsoft.CodeAnalysis" Version="3.0.0" PrivateAssets="all" />
<PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="3.0.0" PrivateAssets="all" />
<PackageReference Include="PolyShim" Version="1.15.0" PrivateAssets="all" />
</ItemGroup> </ItemGroup>
</Project> </Project>

View File

@@ -8,19 +8,17 @@ using Microsoft.CodeAnalysis.Diagnostics;
namespace CliFx.Analyzers; namespace CliFx.Analyzers;
[DiagnosticAnalyzer(LanguageNames.CSharp)] [DiagnosticAnalyzer(LanguageNames.CSharp)]
public class CommandMustBeAnnotatedAnalyzer : AnalyzerBase public class CommandMustBeAnnotatedAnalyzer()
: AnalyzerBase(
$"Commands must be annotated with `{SymbolNames.CliFxCommandAttribute}`",
$"This type must be annotated with `{SymbolNames.CliFxCommandAttribute}` in order to be a valid command."
)
{ {
public CommandMustBeAnnotatedAnalyzer()
: base(
$"Commands must be annotated with `{SymbolNames.CliFxCommandAttribute}`",
$"This type must be annotated with `{SymbolNames.CliFxCommandAttribute}` in order to be a valid command.")
{
}
private void Analyze( private void Analyze(
SyntaxNodeAnalysisContext context, SyntaxNodeAnalysisContext context,
ClassDeclarationSyntax classDeclaration, ClassDeclarationSyntax classDeclaration,
ITypeSymbol type) ITypeSymbol type
)
{ {
// Ignore abstract classes, because they may be used to define // Ignore abstract classes, because they may be used to define
// base implementations for commands, in which case the command // base implementations for commands, in which case the command
@@ -28,12 +26,11 @@ public class CommandMustBeAnnotatedAnalyzer : AnalyzerBase
if (type.IsAbstract) if (type.IsAbstract)
return; return;
var implementsCommandInterface = type var implementsCommandInterface = type.AllInterfaces.Any(i =>
.AllInterfaces i.DisplayNameMatches(SymbolNames.CliFxCommandInterface)
.Any(i => i.DisplayNameMatches(SymbolNames.CliFxCommandInterface)); );
var hasCommandAttribute = type var hasCommandAttribute = type.GetAttributes()
.GetAttributes()
.Select(a => a.AttributeClass) .Select(a => a.AttributeClass)
.Any(c => c.DisplayNameMatches(SymbolNames.CliFxCommandAttribute)); .Any(c => c.DisplayNameMatches(SymbolNames.CliFxCommandAttribute));
@@ -41,9 +38,7 @@ public class CommandMustBeAnnotatedAnalyzer : AnalyzerBase
// then it's very likely a user error. // then it's very likely a user error.
if (implementsCommandInterface && !hasCommandAttribute) if (implementsCommandInterface && !hasCommandAttribute)
{ {
context.ReportDiagnostic( context.ReportDiagnostic(CreateDiagnostic(classDeclaration.Identifier.GetLocation()));
CreateDiagnostic(classDeclaration.Identifier.GetLocation())
);
} }
} }
@@ -52,4 +47,4 @@ public class CommandMustBeAnnotatedAnalyzer : AnalyzerBase
base.Initialize(context); base.Initialize(context);
context.HandleClassDeclaration(Analyze); context.HandleClassDeclaration(Analyze);
} }
} }

View File

@@ -8,36 +8,31 @@ using Microsoft.CodeAnalysis.Diagnostics;
namespace CliFx.Analyzers; namespace CliFx.Analyzers;
[DiagnosticAnalyzer(LanguageNames.CSharp)] [DiagnosticAnalyzer(LanguageNames.CSharp)]
public class CommandMustImplementInterfaceAnalyzer : AnalyzerBase public class CommandMustImplementInterfaceAnalyzer()
: AnalyzerBase(
$"Commands must implement `{SymbolNames.CliFxCommandInterface}` interface",
$"This type must implement `{SymbolNames.CliFxCommandInterface}` interface in order to be a valid command."
)
{ {
public CommandMustImplementInterfaceAnalyzer()
: base(
$"Commands must implement `{SymbolNames.CliFxCommandInterface}` interface",
$"This type must implement `{SymbolNames.CliFxCommandInterface}` interface in order to be a valid command.")
{
}
private void Analyze( private void Analyze(
SyntaxNodeAnalysisContext context, SyntaxNodeAnalysisContext context,
ClassDeclarationSyntax classDeclaration, ClassDeclarationSyntax classDeclaration,
ITypeSymbol type) ITypeSymbol type
)
{ {
var hasCommandAttribute = type var hasCommandAttribute = type.GetAttributes()
.GetAttributes()
.Select(a => a.AttributeClass) .Select(a => a.AttributeClass)
.Any(c => c.DisplayNameMatches(SymbolNames.CliFxCommandAttribute)); .Any(c => c.DisplayNameMatches(SymbolNames.CliFxCommandAttribute));
var implementsCommandInterface = type var implementsCommandInterface = type.AllInterfaces.Any(i =>
.AllInterfaces i.DisplayNameMatches(SymbolNames.CliFxCommandInterface)
.Any(i => i.DisplayNameMatches(SymbolNames.CliFxCommandInterface)); );
// If the attribute is present, but the interface is not implemented, // If the attribute is present, but the interface is not implemented,
// it's very likely a user error. // it's very likely a user error.
if (hasCommandAttribute && !implementsCommandInterface) if (hasCommandAttribute && !implementsCommandInterface)
{ {
context.ReportDiagnostic( context.ReportDiagnostic(CreateDiagnostic(classDeclaration.Identifier.GetLocation()));
CreateDiagnostic(classDeclaration.Identifier.GetLocation())
);
} }
} }
@@ -46,4 +41,4 @@ public class CommandMustImplementInterfaceAnalyzer : AnalyzerBase
base.Initialize(context); base.Initialize(context);
context.HandleClassDeclaration(Analyze); context.HandleClassDeclaration(Analyze);
} }
} }

View File

@@ -5,38 +5,37 @@ using Microsoft.CodeAnalysis;
namespace CliFx.Analyzers.ObjectModel; namespace CliFx.Analyzers.ObjectModel;
internal partial class CommandOptionSymbol : ICommandMemberSymbol internal partial class CommandOptionSymbol(
IPropertySymbol property,
string? name,
char? shortName,
bool? isRequired,
ITypeSymbol? converterType,
IReadOnlyList<ITypeSymbol> validatorTypes
) : ICommandMemberSymbol
{ {
public IPropertySymbol Property { get; } public IPropertySymbol Property { get; } = property;
public string? Name { get; } public string? Name { get; } = name;
public char? ShortName { get; } public char? ShortName { get; } = shortName;
public ITypeSymbol? ConverterType { get; } public bool? IsRequired { get; } = isRequired;
public IReadOnlyList<ITypeSymbol> ValidatorTypes { get; } public ITypeSymbol? ConverterType { get; } = converterType;
public CommandOptionSymbol( public IReadOnlyList<ITypeSymbol> ValidatorTypes { get; } = validatorTypes;
IPropertySymbol property,
string? name,
char? shortName,
ITypeSymbol? converterType,
IReadOnlyList<ITypeSymbol> validatorTypes)
{
Property = property;
Name = name;
ShortName = shortName;
ConverterType = converterType;
ValidatorTypes = validatorTypes;
}
} }
internal partial class CommandOptionSymbol internal partial class CommandOptionSymbol
{ {
private static AttributeData? TryGetOptionAttribute(IPropertySymbol property) => property private static AttributeData? TryGetOptionAttribute(IPropertySymbol property) =>
.GetAttributes() property
.FirstOrDefault(a => a.AttributeClass?.DisplayNameMatches(SymbolNames.CliFxCommandOptionAttribute) == true); .GetAttributes()
.FirstOrDefault(a =>
a.AttributeClass?.DisplayNameMatches(SymbolNames.CliFxCommandOptionAttribute)
== true
);
public static CommandOptionSymbol? TryResolve(IPropertySymbol property) public static CommandOptionSymbol? TryResolve(IPropertySymbol property)
{ {
@@ -44,36 +43,47 @@ internal partial class CommandOptionSymbol
if (attribute is null) if (attribute is null)
return null; return null;
var name = attribute var name =
.ConstructorArguments attribute
.Where(a => a.Type?.SpecialType == SpecialType.System_String) .ConstructorArguments.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 =
.ConstructorArguments attribute
.Where(a => a.Type?.SpecialType == SpecialType.System_Char) .ConstructorArguments.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")
.Select(a => a.Value.Value) .Select(a => a.Value.Value)
.Cast<ITypeSymbol?>() .Cast<ITypeSymbol?>()
.FirstOrDefault(); .FirstOrDefault();
var validators = attribute var validators = attribute
.NamedArguments .NamedArguments.Where(a => a.Key == "Validators")
.Where(a => a.Key == "Validators")
.SelectMany(a => a.Value.Values) .SelectMany(a => a.Value.Values)
.Select(c => c.Value) .Select(c => c.Value)
.Cast<ITypeSymbol>() .Cast<ITypeSymbol>()
.ToArray(); .ToArray();
return new CommandOptionSymbol(property, name, shortName, converter, validators); return new CommandOptionSymbol(
property,
name,
shortName,
isRequired,
converter,
validators
);
} }
public static bool IsOptionProperty(IPropertySymbol property) => public static bool IsOptionProperty(IPropertySymbol property) =>
TryGetOptionAttribute(property) is not null; TryGetOptionAttribute(property) is not null;
} }

View File

@@ -5,42 +5,37 @@ using Microsoft.CodeAnalysis;
namespace CliFx.Analyzers.ObjectModel; namespace CliFx.Analyzers.ObjectModel;
internal partial class CommandParameterSymbol : ICommandMemberSymbol internal partial class CommandParameterSymbol(
IPropertySymbol property,
int order,
string? name,
bool? isRequired,
ITypeSymbol? converterType,
IReadOnlyList<ITypeSymbol> validatorTypes
) : ICommandMemberSymbol
{ {
public IPropertySymbol Property { get; } public IPropertySymbol Property { get; } = property;
public int Order { get; } public int Order { get; } = order;
public string? Name { get; } public string? Name { get; } = name;
public bool? IsRequired { get; } public bool? IsRequired { get; } = isRequired;
public ITypeSymbol? ConverterType { get; } public ITypeSymbol? ConverterType { get; } = converterType;
public IReadOnlyList<ITypeSymbol> ValidatorTypes { get; } public IReadOnlyList<ITypeSymbol> ValidatorTypes { get; } = validatorTypes;
public CommandParameterSymbol(
IPropertySymbol property,
int order,
string? name,
bool? isRequired,
ITypeSymbol? converterType,
IReadOnlyList<ITypeSymbol> validatorTypes)
{
Property = property;
Order = order;
Name = name;
IsRequired = isRequired;
ConverterType = converterType;
ValidatorTypes = validatorTypes;
}
} }
internal partial class CommandParameterSymbol internal partial class CommandParameterSymbol
{ {
private static AttributeData? TryGetParameterAttribute(IPropertySymbol property) => property private static AttributeData? TryGetParameterAttribute(IPropertySymbol property) =>
.GetAttributes() property
.FirstOrDefault(a => a.AttributeClass?.DisplayNameMatches(SymbolNames.CliFxCommandParameterAttribute) == true); .GetAttributes()
.FirstOrDefault(a =>
a.AttributeClass?.DisplayNameMatches(SymbolNames.CliFxCommandParameterAttribute)
== true
);
public static CommandParameterSymbol? TryResolve(IPropertySymbol property) public static CommandParameterSymbol? TryResolve(IPropertySymbol property)
{ {
@@ -48,33 +43,28 @@ internal partial class CommandParameterSymbol
if (attribute is null) if (attribute is null)
return null; return null;
var order = (int)attribute var order = (int)attribute.ConstructorArguments.Select(a => a.Value).First()!;
.ConstructorArguments
.Select(a => a.Value)
.First()!;
var name = attribute var name =
.NamedArguments attribute
.Where(a => a.Key == "Name") .NamedArguments.Where(a => a.Key == "Name")
.Select(a => a.Value.Value) .Select(a => a.Value.Value)
.FirstOrDefault() as string; .FirstOrDefault() as string;
var isRequired = attribute var isRequired =
.NamedArguments attribute
.Where(a => a.Key == "IsRequired") .NamedArguments.Where(a => a.Key == "IsRequired")
.Select(a => a.Value.Value) .Select(a => a.Value.Value)
.FirstOrDefault() as bool?; .FirstOrDefault() as bool?;
var converter = attribute var converter = attribute
.NamedArguments .NamedArguments.Where(a => a.Key == "Converter")
.Where(a => a.Key == "Converter")
.Select(a => a.Value.Value) .Select(a => a.Value.Value)
.Cast<ITypeSymbol?>() .Cast<ITypeSymbol?>()
.FirstOrDefault(); .FirstOrDefault();
var validators = attribute var validators = attribute
.NamedArguments .NamedArguments.Where(a => a.Key == "Validators")
.Where(a => a.Key == "Validators")
.SelectMany(a => a.Value.Values) .SelectMany(a => a.Value.Values)
.Select(c => c.Value) .Select(c => c.Value)
.Cast<ITypeSymbol>() .Cast<ITypeSymbol>()
@@ -85,4 +75,4 @@ internal partial class CommandParameterSymbol
public static bool IsParameterProperty(IPropertySymbol property) => public static bool IsParameterProperty(IPropertySymbol property) =>
TryGetParameterAttribute(property) is not null; TryGetParameterAttribute(property) is not null;
} }

View File

@@ -16,6 +16,6 @@ internal interface ICommandMemberSymbol
internal static class CommandMemberSymbolExtensions internal static class CommandMemberSymbolExtensions
{ {
public static bool IsScalar(this ICommandMemberSymbol member) => public static bool IsScalar(this ICommandMemberSymbol member) =>
member.Property.Type.SpecialType == SpecialType.System_String || member.Property.Type.SpecialType == SpecialType.System_String
member.Property.Type.TryGetEnumerableUnderlyingType() is null; || member.Property.Type.TryGetEnumerableUnderlyingType() is null;
} }

View File

@@ -4,9 +4,10 @@ internal static class SymbolNames
{ {
public const string CliFxCommandInterface = "CliFx.ICommand"; public const string CliFxCommandInterface = "CliFx.ICommand";
public const string CliFxCommandAttribute = "CliFx.Attributes.CommandAttribute"; public const string CliFxCommandAttribute = "CliFx.Attributes.CommandAttribute";
public const string CliFxCommandParameterAttribute = "CliFx.Attributes.CommandParameterAttribute"; public const string CliFxCommandParameterAttribute =
"CliFx.Attributes.CommandParameterAttribute";
public const string CliFxCommandOptionAttribute = "CliFx.Attributes.CommandOptionAttribute"; public const string CliFxCommandOptionAttribute = "CliFx.Attributes.CommandOptionAttribute";
public const string CliFxConsoleInterface = "CliFx.Infrastructure.IConsole"; public const string CliFxConsoleInterface = "CliFx.Infrastructure.IConsole";
public const string CliFxBindingConverterClass = "CliFx.Extensibility.BindingConverter<T>"; public const string CliFxBindingConverterClass = "CliFx.Extensibility.BindingConverter<T>";
public const string CliFxBindingValidatorClass = "CliFx.Extensibility.BindingValidator<T>"; public const string CliFxBindingValidatorClass = "CliFx.Extensibility.BindingValidator<T>";
} }

View File

@@ -8,19 +8,17 @@ using Microsoft.CodeAnalysis.Diagnostics;
namespace CliFx.Analyzers; namespace CliFx.Analyzers;
[DiagnosticAnalyzer(LanguageNames.CSharp)] [DiagnosticAnalyzer(LanguageNames.CSharp)]
public class OptionMustBeInsideCommandAnalyzer : AnalyzerBase public class OptionMustBeInsideCommandAnalyzer()
: AnalyzerBase(
"Options must be defined inside commands",
$"This option must be defined inside a class that implements `{SymbolNames.CliFxCommandInterface}`."
)
{ {
public OptionMustBeInsideCommandAnalyzer()
: base(
"Options must be defined inside commands",
$"This option must be defined inside a class that implements `{SymbolNames.CliFxCommandInterface}`.")
{
}
private void Analyze( private void Analyze(
SyntaxNodeAnalysisContext context, SyntaxNodeAnalysisContext context,
PropertyDeclarationSyntax propertyDeclaration, PropertyDeclarationSyntax propertyDeclaration,
IPropertySymbol property) IPropertySymbol property
)
{ {
if (property.ContainingType is null) if (property.ContainingType is null)
return; return;
@@ -31,10 +29,9 @@ public class OptionMustBeInsideCommandAnalyzer : AnalyzerBase
if (!CommandOptionSymbol.IsOptionProperty(property)) if (!CommandOptionSymbol.IsOptionProperty(property))
return; return;
var isInsideCommand = property var isInsideCommand = property.ContainingType.AllInterfaces.Any(i =>
.ContainingType i.DisplayNameMatches(SymbolNames.CliFxCommandInterface)
.AllInterfaces );
.Any(i => i.DisplayNameMatches(SymbolNames.CliFxCommandInterface));
if (!isInsideCommand) if (!isInsideCommand)
{ {
@@ -49,4 +46,4 @@ public class OptionMustBeInsideCommandAnalyzer : AnalyzerBase
base.Initialize(context); base.Initialize(context);
context.HandlePropertyDeclaration(Analyze); context.HandlePropertyDeclaration(Analyze);
} }
} }

View File

@@ -0,0 +1,43 @@
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(
"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

@@ -7,19 +7,17 @@ using Microsoft.CodeAnalysis.Diagnostics;
namespace CliFx.Analyzers; namespace CliFx.Analyzers;
[DiagnosticAnalyzer(LanguageNames.CSharp)] [DiagnosticAnalyzer(LanguageNames.CSharp)]
public class OptionMustHaveNameOrShortNameAnalyzer : AnalyzerBase public class OptionMustHaveNameOrShortNameAnalyzer()
: AnalyzerBase(
"Options must have either a name or short name specified",
"This option must have either a name or short name specified."
)
{ {
public OptionMustHaveNameOrShortNameAnalyzer()
: base(
"Options must have either a name or short name specified",
"This option must have either a name or short name specified.")
{
}
private void Analyze( private void Analyze(
SyntaxNodeAnalysisContext context, SyntaxNodeAnalysisContext context,
PropertyDeclarationSyntax propertyDeclaration, PropertyDeclarationSyntax propertyDeclaration,
IPropertySymbol property) IPropertySymbol property
)
{ {
var option = CommandOptionSymbol.TryResolve(property); var option = CommandOptionSymbol.TryResolve(property);
if (option is null) if (option is null)
@@ -38,4 +36,4 @@ public class OptionMustHaveNameOrShortNameAnalyzer : AnalyzerBase
base.Initialize(context); base.Initialize(context);
context.HandlePropertyDeclaration(Analyze); context.HandlePropertyDeclaration(Analyze);
} }
} }

View File

@@ -9,21 +9,19 @@ using Microsoft.CodeAnalysis.Diagnostics;
namespace CliFx.Analyzers; namespace CliFx.Analyzers;
[DiagnosticAnalyzer(LanguageNames.CSharp)] [DiagnosticAnalyzer(LanguageNames.CSharp)]
public class OptionMustHaveUniqueNameAnalyzer : AnalyzerBase public class OptionMustHaveUniqueNameAnalyzer()
: AnalyzerBase(
"Options must have unique names",
"This option's name must be unique within the command (comparison IS NOT case sensitive). "
+ "Specified name: `{0}`. "
+ "Property bound to another option with the same name: `{1}`."
)
{ {
public OptionMustHaveUniqueNameAnalyzer()
: base(
"Options must have unique names",
"This option's name must be unique within the command (comparison IS NOT case sensitive). " +
"Specified name: `{0}`. " +
"Property bound to another option with the same name: `{1}`.")
{
}
private void Analyze( private void Analyze(
SyntaxNodeAnalysisContext context, SyntaxNodeAnalysisContext context,
PropertyDeclarationSyntax propertyDeclaration, PropertyDeclarationSyntax propertyDeclaration,
IPropertySymbol property) IPropertySymbol property
)
{ {
if (property.ContainingType is null) if (property.ContainingType is null)
return; return;
@@ -36,10 +34,9 @@ public class OptionMustHaveUniqueNameAnalyzer : AnalyzerBase
return; return;
var otherProperties = property var otherProperties = property
.ContainingType .ContainingType.GetMembers()
.GetMembers()
.OfType<IPropertySymbol>() .OfType<IPropertySymbol>()
.Where(m => !m.Equals(property, SymbolEqualityComparer.Default)) .Where(m => !m.Equals(property))
.ToArray(); .ToArray();
foreach (var otherProperty in otherProperties) foreach (var otherProperty in otherProperties)
@@ -69,4 +66,4 @@ public class OptionMustHaveUniqueNameAnalyzer : AnalyzerBase
base.Initialize(context); base.Initialize(context);
context.HandlePropertyDeclaration(Analyze); context.HandlePropertyDeclaration(Analyze);
} }
} }

View File

@@ -8,21 +8,19 @@ using Microsoft.CodeAnalysis.Diagnostics;
namespace CliFx.Analyzers; namespace CliFx.Analyzers;
[DiagnosticAnalyzer(LanguageNames.CSharp)] [DiagnosticAnalyzer(LanguageNames.CSharp)]
public class OptionMustHaveUniqueShortNameAnalyzer : AnalyzerBase public class OptionMustHaveUniqueShortNameAnalyzer()
: AnalyzerBase(
"Options must have unique short names",
"This option's short name must be unique within the command (comparison IS case sensitive). "
+ "Specified short name: `{0}` "
+ "Property bound to another option with the same short name: `{1}`."
)
{ {
public OptionMustHaveUniqueShortNameAnalyzer()
: base(
"Options must have unique short names",
"This option's short name must be unique within the command (comparison IS case sensitive). " +
"Specified short name: `{0}` " +
"Property bound to another option with the same short name: `{1}`.")
{
}
private void Analyze( private void Analyze(
SyntaxNodeAnalysisContext context, SyntaxNodeAnalysisContext context,
PropertyDeclarationSyntax propertyDeclaration, PropertyDeclarationSyntax propertyDeclaration,
IPropertySymbol property) IPropertySymbol property
)
{ {
if (property.ContainingType is null) if (property.ContainingType is null)
return; return;
@@ -35,10 +33,9 @@ public class OptionMustHaveUniqueShortNameAnalyzer : AnalyzerBase
return; return;
var otherProperties = property var otherProperties = property
.ContainingType .ContainingType.GetMembers()
.GetMembers()
.OfType<IPropertySymbol>() .OfType<IPropertySymbol>()
.Where(m => !m.Equals(property, SymbolEqualityComparer.Default)) .Where(m => !m.Equals(property))
.ToArray(); .ToArray();
foreach (var otherProperty in otherProperties) foreach (var otherProperty in otherProperties)
@@ -68,4 +65,4 @@ public class OptionMustHaveUniqueShortNameAnalyzer : AnalyzerBase
base.Initialize(context); base.Initialize(context);
context.HandlePropertyDeclaration(Analyze); context.HandlePropertyDeclaration(Analyze);
} }
} }

View File

@@ -8,19 +8,17 @@ using Microsoft.CodeAnalysis.Diagnostics;
namespace CliFx.Analyzers; namespace CliFx.Analyzers;
[DiagnosticAnalyzer(LanguageNames.CSharp)] [DiagnosticAnalyzer(LanguageNames.CSharp)]
public class OptionMustHaveValidConverterAnalyzer : AnalyzerBase public class OptionMustHaveValidConverterAnalyzer()
: AnalyzerBase(
$"Option converters must derive from `{SymbolNames.CliFxBindingConverterClass}`",
$"Converter specified for this option must derive from a compatible `{SymbolNames.CliFxBindingConverterClass}`."
)
{ {
public OptionMustHaveValidConverterAnalyzer()
: base(
$"Option converters must derive from `{SymbolNames.CliFxBindingConverterClass}`",
$"Converter specified for this option must derive from a compatible `{SymbolNames.CliFxBindingConverterClass}`.")
{
}
private void Analyze( private void Analyze(
SyntaxNodeAnalysisContext context, SyntaxNodeAnalysisContext context,
PropertyDeclarationSyntax propertyDeclaration, PropertyDeclarationSyntax propertyDeclaration,
IPropertySymbol property) IPropertySymbol property
)
{ {
var option = CommandOptionSymbol.TryResolve(property); var option = CommandOptionSymbol.TryResolve(property);
if (option is null) if (option is null)
@@ -30,20 +28,25 @@ public class OptionMustHaveValidConverterAnalyzer : AnalyzerBase
return; return;
var converterValueType = option var converterValueType = option
.ConverterType .ConverterType.GetBaseTypes()
.GetBaseTypes() .FirstOrDefault(t =>
.FirstOrDefault(t => t.ConstructedFrom.DisplayNameMatches(SymbolNames.CliFxBindingConverterClass))? t.ConstructedFrom.DisplayNameMatches(SymbolNames.CliFxBindingConverterClass)
.TypeArguments )
.FirstOrDefault(); ?.TypeArguments.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
var isCompatible = var isCompatible =
converterValueType is not null && (option.IsScalar() converterValueType is not null
// Scalar && (
? context.Compilation.IsAssignable(converterValueType, property.Type) option.IsScalar()
// Non-scalar (assume we can handle all IEnumerable types for simplicity) // Scalar
: property.Type.TryGetEnumerableUnderlyingType() is { } enumerableUnderlyingType && ? context.Compilation.IsAssignable(converterValueType, property.Type)
context.Compilation.IsAssignable(converterValueType, enumerableUnderlyingType) // Non-scalar (assume we can handle all IEnumerable types for simplicity)
: property.Type.TryGetEnumerableUnderlyingType() is { } enumerableUnderlyingType
&& context.Compilation.IsAssignable(
converterValueType,
enumerableUnderlyingType
)
); );
if (!isCompatible) if (!isCompatible)
@@ -59,4 +62,4 @@ public class OptionMustHaveValidConverterAnalyzer : AnalyzerBase
base.Initialize(context); base.Initialize(context);
context.HandlePropertyDeclaration(Analyze); context.HandlePropertyDeclaration(Analyze);
} }
} }

View File

@@ -7,20 +7,18 @@ using Microsoft.CodeAnalysis.Diagnostics;
namespace CliFx.Analyzers; namespace CliFx.Analyzers;
[DiagnosticAnalyzer(LanguageNames.CSharp)] [DiagnosticAnalyzer(LanguageNames.CSharp)]
public class OptionMustHaveValidNameAnalyzer : AnalyzerBase public class OptionMustHaveValidNameAnalyzer()
: AnalyzerBase(
"Options must have valid names",
"This option's name must be at least 2 characters long and must start with a letter. "
+ "Specified name: `{0}`."
)
{ {
public OptionMustHaveValidNameAnalyzer()
: base(
"Options must have valid names",
"This option's name must be at least 2 characters long and must start with a letter. " +
"Specified name: `{0}`.")
{
}
private void Analyze( private void Analyze(
SyntaxNodeAnalysisContext context, SyntaxNodeAnalysisContext context,
PropertyDeclarationSyntax propertyDeclaration, PropertyDeclarationSyntax propertyDeclaration,
IPropertySymbol property) IPropertySymbol property
)
{ {
var option = CommandOptionSymbol.TryResolve(property); var option = CommandOptionSymbol.TryResolve(property);
if (option is null) if (option is null)
@@ -32,10 +30,7 @@ public class OptionMustHaveValidNameAnalyzer : AnalyzerBase
if (option.Name.Length < 2 || !char.IsLetter(option.Name[0])) if (option.Name.Length < 2 || !char.IsLetter(option.Name[0]))
{ {
context.ReportDiagnostic( context.ReportDiagnostic(
CreateDiagnostic( CreateDiagnostic(propertyDeclaration.Identifier.GetLocation(), option.Name)
propertyDeclaration.Identifier.GetLocation(),
option.Name
)
); );
} }
} }
@@ -45,4 +40,4 @@ public class OptionMustHaveValidNameAnalyzer : AnalyzerBase
base.Initialize(context); base.Initialize(context);
context.HandlePropertyDeclaration(Analyze); context.HandlePropertyDeclaration(Analyze);
} }
} }

View File

@@ -7,20 +7,18 @@ using Microsoft.CodeAnalysis.Diagnostics;
namespace CliFx.Analyzers; namespace CliFx.Analyzers;
[DiagnosticAnalyzer(LanguageNames.CSharp)] [DiagnosticAnalyzer(LanguageNames.CSharp)]
public class OptionMustHaveValidShortNameAnalyzer : AnalyzerBase public class OptionMustHaveValidShortNameAnalyzer()
: AnalyzerBase(
"Option short names must be letter characters",
"This option's short name must be a single letter character. "
+ "Specified short name: `{0}`."
)
{ {
public OptionMustHaveValidShortNameAnalyzer()
: base(
"Option short names must be letter characters",
"This option's short name must be a single letter character. " +
"Specified short name: `{0}`.")
{
}
private void Analyze( private void Analyze(
SyntaxNodeAnalysisContext context, SyntaxNodeAnalysisContext context,
PropertyDeclarationSyntax propertyDeclaration, PropertyDeclarationSyntax propertyDeclaration,
IPropertySymbol property) IPropertySymbol property
)
{ {
var option = CommandOptionSymbol.TryResolve(property); var option = CommandOptionSymbol.TryResolve(property);
if (option is null) if (option is null)
@@ -32,10 +30,7 @@ public class OptionMustHaveValidShortNameAnalyzer : AnalyzerBase
if (!char.IsLetter(option.ShortName.Value)) if (!char.IsLetter(option.ShortName.Value))
{ {
context.ReportDiagnostic( context.ReportDiagnostic(
CreateDiagnostic( CreateDiagnostic(propertyDeclaration.Identifier.GetLocation(), option.ShortName)
propertyDeclaration.Identifier.GetLocation(),
option.ShortName
)
); );
} }
} }
@@ -45,4 +40,4 @@ public class OptionMustHaveValidShortNameAnalyzer : AnalyzerBase
base.Initialize(context); base.Initialize(context);
context.HandlePropertyDeclaration(Analyze); context.HandlePropertyDeclaration(Analyze);
} }
} }

View File

@@ -8,19 +8,17 @@ using Microsoft.CodeAnalysis.Diagnostics;
namespace CliFx.Analyzers; namespace CliFx.Analyzers;
[DiagnosticAnalyzer(LanguageNames.CSharp)] [DiagnosticAnalyzer(LanguageNames.CSharp)]
public class OptionMustHaveValidValidatorsAnalyzer : AnalyzerBase public class OptionMustHaveValidValidatorsAnalyzer()
: AnalyzerBase(
$"Option validators must derive from `{SymbolNames.CliFxBindingValidatorClass}`",
$"Each validator specified for this option must derive from a compatible `{SymbolNames.CliFxBindingValidatorClass}`."
)
{ {
public OptionMustHaveValidValidatorsAnalyzer()
: base(
$"Option validators must derive from `{SymbolNames.CliFxBindingValidatorClass}`",
$"Each validator specified for this option must derive from a compatible `{SymbolNames.CliFxBindingValidatorClass}`.")
{
}
private void Analyze( private void Analyze(
SyntaxNodeAnalysisContext context, SyntaxNodeAnalysisContext context,
PropertyDeclarationSyntax propertyDeclaration, PropertyDeclarationSyntax propertyDeclaration,
IPropertySymbol property) IPropertySymbol property
)
{ {
var option = CommandOptionSymbol.TryResolve(property); var option = CommandOptionSymbol.TryResolve(property);
if (option is null) if (option is null)
@@ -30,14 +28,15 @@ public class OptionMustHaveValidValidatorsAnalyzer : AnalyzerBase
{ {
var validatorValueType = validatorType var validatorValueType = validatorType
.GetBaseTypes() .GetBaseTypes()
.FirstOrDefault(t => t.ConstructedFrom.DisplayNameMatches(SymbolNames.CliFxBindingValidatorClass))? .FirstOrDefault(t =>
.TypeArguments t.ConstructedFrom.DisplayNameMatches(SymbolNames.CliFxBindingValidatorClass)
.FirstOrDefault(); )
?.TypeArguments.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
var isCompatible = var isCompatible =
validatorValueType is not null && validatorValueType is not null
context.Compilation.IsAssignable(property.Type, validatorValueType); && context.Compilation.IsAssignable(property.Type, validatorValueType);
if (!isCompatible) if (!isCompatible)
{ {
@@ -56,4 +55,4 @@ public class OptionMustHaveValidValidatorsAnalyzer : AnalyzerBase
base.Initialize(context); base.Initialize(context);
context.HandlePropertyDeclaration(Analyze); context.HandlePropertyDeclaration(Analyze);
} }
} }

View File

@@ -8,19 +8,17 @@ using Microsoft.CodeAnalysis.Diagnostics;
namespace CliFx.Analyzers; namespace CliFx.Analyzers;
[DiagnosticAnalyzer(LanguageNames.CSharp)] [DiagnosticAnalyzer(LanguageNames.CSharp)]
public class ParameterMustBeInsideCommandAnalyzer : AnalyzerBase public class ParameterMustBeInsideCommandAnalyzer()
: AnalyzerBase(
"Parameters must be defined inside commands",
$"This parameter must be defined inside a class that implements `{SymbolNames.CliFxCommandInterface}`."
)
{ {
public ParameterMustBeInsideCommandAnalyzer()
: base(
"Parameters must be defined inside commands",
$"This parameter must be defined inside a class that implements `{SymbolNames.CliFxCommandInterface}`.")
{
}
private void Analyze( private void Analyze(
SyntaxNodeAnalysisContext context, SyntaxNodeAnalysisContext context,
PropertyDeclarationSyntax propertyDeclaration, PropertyDeclarationSyntax propertyDeclaration,
IPropertySymbol property) IPropertySymbol property
)
{ {
if (property.ContainingType is null) if (property.ContainingType is null)
return; return;
@@ -31,10 +29,9 @@ public class ParameterMustBeInsideCommandAnalyzer : AnalyzerBase
if (!CommandParameterSymbol.IsParameterProperty(property)) if (!CommandParameterSymbol.IsParameterProperty(property))
return; return;
var isInsideCommand = property var isInsideCommand = property.ContainingType.AllInterfaces.Any(i =>
.ContainingType i.DisplayNameMatches(SymbolNames.CliFxCommandInterface)
.AllInterfaces );
.Any(i => i.DisplayNameMatches(SymbolNames.CliFxCommandInterface));
if (!isInsideCommand) if (!isInsideCommand)
{ {
@@ -49,4 +46,4 @@ public class ParameterMustBeInsideCommandAnalyzer : AnalyzerBase
base.Initialize(context); base.Initialize(context);
context.HandlePropertyDeclaration(Analyze); context.HandlePropertyDeclaration(Analyze);
} }
} }

View File

@@ -8,20 +8,18 @@ using Microsoft.CodeAnalysis.Diagnostics;
namespace CliFx.Analyzers; namespace CliFx.Analyzers;
[DiagnosticAnalyzer(LanguageNames.CSharp)] [DiagnosticAnalyzer(LanguageNames.CSharp)]
public class ParameterMustBeLastIfNonRequiredAnalyzer : AnalyzerBase public class ParameterMustBeLastIfNonRequiredAnalyzer()
: AnalyzerBase(
"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). "
+ "Property bound to another non-required parameter: `{0}`."
)
{ {
public ParameterMustBeLastIfNonRequiredAnalyzer()
: base(
"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). " +
"Property bound to another non-required parameter: `{0}`.")
{
}
private void Analyze( private void Analyze(
SyntaxNodeAnalysisContext context, SyntaxNodeAnalysisContext context,
PropertyDeclarationSyntax propertyDeclaration, PropertyDeclarationSyntax propertyDeclaration,
IPropertySymbol property) IPropertySymbol property
)
{ {
if (property.ContainingType is null) if (property.ContainingType is null)
return; return;
@@ -34,10 +32,9 @@ public class ParameterMustBeLastIfNonRequiredAnalyzer : AnalyzerBase
return; return;
var otherProperties = property var otherProperties = property
.ContainingType .ContainingType.GetMembers()
.GetMembers()
.OfType<IPropertySymbol>() .OfType<IPropertySymbol>()
.Where(m => !m.Equals(property, SymbolEqualityComparer.Default)) .Where(m => !m.Equals(property))
.ToArray(); .ToArray();
foreach (var otherProperty in otherProperties) foreach (var otherProperty in otherProperties)
@@ -63,4 +60,4 @@ public class ParameterMustBeLastIfNonRequiredAnalyzer : AnalyzerBase
base.Initialize(context); base.Initialize(context);
context.HandlePropertyDeclaration(Analyze); context.HandlePropertyDeclaration(Analyze);
} }
} }

View File

@@ -8,20 +8,18 @@ using Microsoft.CodeAnalysis.Diagnostics;
namespace CliFx.Analyzers; namespace CliFx.Analyzers;
[DiagnosticAnalyzer(LanguageNames.CSharp)] [DiagnosticAnalyzer(LanguageNames.CSharp)]
public class ParameterMustBeLastIfNonScalarAnalyzer : AnalyzerBase public class ParameterMustBeLastIfNonScalarAnalyzer()
: AnalyzerBase(
"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). "
+ "Property bound to another non-scalar parameter: `{0}`."
)
{ {
public ParameterMustBeLastIfNonScalarAnalyzer()
: base(
"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). " +
"Property bound to another non-scalar parameter: `{0}`.")
{
}
private void Analyze( private void Analyze(
SyntaxNodeAnalysisContext context, SyntaxNodeAnalysisContext context,
PropertyDeclarationSyntax propertyDeclaration, PropertyDeclarationSyntax propertyDeclaration,
IPropertySymbol property) IPropertySymbol property
)
{ {
if (property.ContainingType is null) if (property.ContainingType is null)
return; return;
@@ -34,10 +32,9 @@ public class ParameterMustBeLastIfNonScalarAnalyzer : AnalyzerBase
return; return;
var otherProperties = property var otherProperties = property
.ContainingType .ContainingType.GetMembers()
.GetMembers()
.OfType<IPropertySymbol>() .OfType<IPropertySymbol>()
.Where(m => !m.Equals(property, SymbolEqualityComparer.Default)) .Where(m => !m.Equals(property))
.ToArray(); .ToArray();
foreach (var otherProperty in otherProperties) foreach (var otherProperty in otherProperties)
@@ -63,4 +60,4 @@ public class ParameterMustBeLastIfNonScalarAnalyzer : AnalyzerBase
base.Initialize(context); base.Initialize(context);
context.HandlePropertyDeclaration(Analyze); context.HandlePropertyDeclaration(Analyze);
} }
} }

View File

@@ -0,0 +1,43 @@
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(
"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

@@ -8,20 +8,18 @@ using Microsoft.CodeAnalysis.Diagnostics;
namespace CliFx.Analyzers; namespace CliFx.Analyzers;
[DiagnosticAnalyzer(LanguageNames.CSharp)] [DiagnosticAnalyzer(LanguageNames.CSharp)]
public class ParameterMustBeSingleIfNonRequiredAnalyzer : AnalyzerBase public class ParameterMustBeSingleIfNonRequiredAnalyzer()
: AnalyzerBase(
"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. "
+ "Property bound to another non-required parameter: `{0}`."
)
{ {
public ParameterMustBeSingleIfNonRequiredAnalyzer()
: base(
"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. " +
"Property bound to another non-required parameter: `{0}`.")
{
}
private void Analyze( private void Analyze(
SyntaxNodeAnalysisContext context, SyntaxNodeAnalysisContext context,
PropertyDeclarationSyntax propertyDeclaration, PropertyDeclarationSyntax propertyDeclaration,
IPropertySymbol property) IPropertySymbol property
)
{ {
if (property.ContainingType is null) if (property.ContainingType is null)
return; return;
@@ -34,10 +32,9 @@ public class ParameterMustBeSingleIfNonRequiredAnalyzer : AnalyzerBase
return; return;
var otherProperties = property var otherProperties = property
.ContainingType .ContainingType.GetMembers()
.GetMembers()
.OfType<IPropertySymbol>() .OfType<IPropertySymbol>()
.Where(m => !m.Equals(property, SymbolEqualityComparer.Default)) .Where(m => !m.Equals(property))
.ToArray(); .ToArray();
foreach (var otherProperty in otherProperties) foreach (var otherProperty in otherProperties)
@@ -63,4 +60,4 @@ public class ParameterMustBeSingleIfNonRequiredAnalyzer : AnalyzerBase
base.Initialize(context); base.Initialize(context);
context.HandlePropertyDeclaration(Analyze); context.HandlePropertyDeclaration(Analyze);
} }
} }

View File

@@ -8,20 +8,18 @@ using Microsoft.CodeAnalysis.Diagnostics;
namespace CliFx.Analyzers; namespace CliFx.Analyzers;
[DiagnosticAnalyzer(LanguageNames.CSharp)] [DiagnosticAnalyzer(LanguageNames.CSharp)]
public class ParameterMustBeSingleIfNonScalarAnalyzer : AnalyzerBase public class ParameterMustBeSingleIfNonScalarAnalyzer()
: AnalyzerBase(
"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. "
+ "Property bound to another non-scalar parameter: `{0}`."
)
{ {
public ParameterMustBeSingleIfNonScalarAnalyzer()
: base(
"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. " +
"Property bound to another non-scalar parameter: `{0}`.")
{
}
private void Analyze( private void Analyze(
SyntaxNodeAnalysisContext context, SyntaxNodeAnalysisContext context,
PropertyDeclarationSyntax propertyDeclaration, PropertyDeclarationSyntax propertyDeclaration,
IPropertySymbol property) IPropertySymbol property
)
{ {
if (property.ContainingType is null) if (property.ContainingType is null)
return; return;
@@ -34,10 +32,9 @@ public class ParameterMustBeSingleIfNonScalarAnalyzer : AnalyzerBase
return; return;
var otherProperties = property var otherProperties = property
.ContainingType .ContainingType.GetMembers()
.GetMembers()
.OfType<IPropertySymbol>() .OfType<IPropertySymbol>()
.Where(m => !m.Equals(property, SymbolEqualityComparer.Default)) .Where(m => !m.Equals(property))
.ToArray(); .ToArray();
foreach (var otherProperty in otherProperties) foreach (var otherProperty in otherProperties)
@@ -63,4 +60,4 @@ public class ParameterMustBeSingleIfNonScalarAnalyzer : AnalyzerBase
base.Initialize(context); base.Initialize(context);
context.HandlePropertyDeclaration(Analyze); context.HandlePropertyDeclaration(Analyze);
} }
} }

View File

@@ -9,21 +9,19 @@ using Microsoft.CodeAnalysis.Diagnostics;
namespace CliFx.Analyzers; namespace CliFx.Analyzers;
[DiagnosticAnalyzer(LanguageNames.CSharp)] [DiagnosticAnalyzer(LanguageNames.CSharp)]
public class ParameterMustHaveUniqueNameAnalyzer : AnalyzerBase public class ParameterMustHaveUniqueNameAnalyzer()
: AnalyzerBase(
"Parameters must have unique names",
"This parameter's name must be unique within the command (comparison IS NOT case sensitive). "
+ "Specified name: `{0}`. "
+ "Property bound to another parameter with the same name: `{1}`."
)
{ {
public ParameterMustHaveUniqueNameAnalyzer()
: base(
"Parameters must have unique names",
"This parameter's name must be unique within the command (comparison IS NOT case sensitive). " +
"Specified name: `{0}`. " +
"Property bound to another parameter with the same name: `{1}`.")
{
}
private void Analyze( private void Analyze(
SyntaxNodeAnalysisContext context, SyntaxNodeAnalysisContext context,
PropertyDeclarationSyntax propertyDeclaration, PropertyDeclarationSyntax propertyDeclaration,
IPropertySymbol property) IPropertySymbol property
)
{ {
if (property.ContainingType is null) if (property.ContainingType is null)
return; return;
@@ -36,10 +34,9 @@ public class ParameterMustHaveUniqueNameAnalyzer : AnalyzerBase
return; return;
var otherProperties = property var otherProperties = property
.ContainingType .ContainingType.GetMembers()
.GetMembers()
.OfType<IPropertySymbol>() .OfType<IPropertySymbol>()
.Where(m => !m.Equals(property, SymbolEqualityComparer.Default)) .Where(m => !m.Equals(property))
.ToArray(); .ToArray();
foreach (var otherProperty in otherProperties) foreach (var otherProperty in otherProperties)
@@ -51,7 +48,13 @@ public class ParameterMustHaveUniqueNameAnalyzer : AnalyzerBase
if (string.IsNullOrWhiteSpace(otherParameter.Name)) if (string.IsNullOrWhiteSpace(otherParameter.Name))
continue; continue;
if (string.Equals(parameter.Name, otherParameter.Name, StringComparison.OrdinalIgnoreCase)) if (
string.Equals(
parameter.Name,
otherParameter.Name,
StringComparison.OrdinalIgnoreCase
)
)
{ {
context.ReportDiagnostic( context.ReportDiagnostic(
CreateDiagnostic( CreateDiagnostic(
@@ -69,4 +72,4 @@ public class ParameterMustHaveUniqueNameAnalyzer : AnalyzerBase
base.Initialize(context); base.Initialize(context);
context.HandlePropertyDeclaration(Analyze); context.HandlePropertyDeclaration(Analyze);
} }
} }

View File

@@ -8,21 +8,19 @@ using Microsoft.CodeAnalysis.Diagnostics;
namespace CliFx.Analyzers; namespace CliFx.Analyzers;
[DiagnosticAnalyzer(LanguageNames.CSharp)] [DiagnosticAnalyzer(LanguageNames.CSharp)]
public class ParameterMustHaveUniqueOrderAnalyzer : AnalyzerBase public class ParameterMustHaveUniqueOrderAnalyzer()
: AnalyzerBase(
"Parameters must have unique order",
"This parameter's order must be unique within the command. "
+ "Specified order: {0}. "
+ "Property bound to another parameter with the same order: `{1}`."
)
{ {
public ParameterMustHaveUniqueOrderAnalyzer()
: base(
"Parameters must have unique order",
"This parameter's order must be unique within the command. " +
"Specified order: {0}. " +
"Property bound to another parameter with the same order: `{1}`.")
{
}
private void Analyze( private void Analyze(
SyntaxNodeAnalysisContext context, SyntaxNodeAnalysisContext context,
PropertyDeclarationSyntax propertyDeclaration, PropertyDeclarationSyntax propertyDeclaration,
IPropertySymbol property) IPropertySymbol property
)
{ {
if (property.ContainingType is null) if (property.ContainingType is null)
return; return;
@@ -32,10 +30,9 @@ public class ParameterMustHaveUniqueOrderAnalyzer : AnalyzerBase
return; return;
var otherProperties = property var otherProperties = property
.ContainingType .ContainingType.GetMembers()
.GetMembers()
.OfType<IPropertySymbol>() .OfType<IPropertySymbol>()
.Where(m => !m.Equals(property, SymbolEqualityComparer.Default)) .Where(m => !m.Equals(property))
.ToArray(); .ToArray();
foreach (var otherProperty in otherProperties) foreach (var otherProperty in otherProperties)
@@ -62,4 +59,4 @@ public class ParameterMustHaveUniqueOrderAnalyzer : AnalyzerBase
base.Initialize(context); base.Initialize(context);
context.HandlePropertyDeclaration(Analyze); context.HandlePropertyDeclaration(Analyze);
} }
} }

View File

@@ -8,19 +8,17 @@ using Microsoft.CodeAnalysis.Diagnostics;
namespace CliFx.Analyzers; namespace CliFx.Analyzers;
[DiagnosticAnalyzer(LanguageNames.CSharp)] [DiagnosticAnalyzer(LanguageNames.CSharp)]
public class ParameterMustHaveValidConverterAnalyzer : AnalyzerBase public class ParameterMustHaveValidConverterAnalyzer()
: AnalyzerBase(
$"Parameter converters must derive from `{SymbolNames.CliFxBindingConverterClass}`",
$"Converter specified for this parameter must derive from a compatible `{SymbolNames.CliFxBindingConverterClass}`."
)
{ {
public ParameterMustHaveValidConverterAnalyzer()
: base(
$"Parameter converters must derive from `{SymbolNames.CliFxBindingConverterClass}`",
$"Converter specified for this parameter must derive from a compatible `{SymbolNames.CliFxBindingConverterClass}`.")
{
}
private void Analyze( private void Analyze(
SyntaxNodeAnalysisContext context, SyntaxNodeAnalysisContext context,
PropertyDeclarationSyntax propertyDeclaration, PropertyDeclarationSyntax propertyDeclaration,
IPropertySymbol property) IPropertySymbol property
)
{ {
var parameter = CommandParameterSymbol.TryResolve(property); var parameter = CommandParameterSymbol.TryResolve(property);
if (parameter is null) if (parameter is null)
@@ -30,20 +28,25 @@ public class ParameterMustHaveValidConverterAnalyzer : AnalyzerBase
return; return;
var converterValueType = parameter var converterValueType = parameter
.ConverterType .ConverterType.GetBaseTypes()
.GetBaseTypes() .FirstOrDefault(t =>
.FirstOrDefault(t => t.ConstructedFrom.DisplayNameMatches(SymbolNames.CliFxBindingConverterClass))? t.ConstructedFrom.DisplayNameMatches(SymbolNames.CliFxBindingConverterClass)
.TypeArguments )
.FirstOrDefault(); ?.TypeArguments.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
var isCompatible = var isCompatible =
converterValueType is not null && (parameter.IsScalar() converterValueType is not null
// Scalar && (
? context.Compilation.IsAssignable(converterValueType, property.Type) parameter.IsScalar()
// Non-scalar (assume we can handle all IEnumerable types for simplicity) // Scalar
: property.Type.TryGetEnumerableUnderlyingType() is { } enumerableUnderlyingType && ? context.Compilation.IsAssignable(converterValueType, property.Type)
context.Compilation.IsAssignable(converterValueType, enumerableUnderlyingType) // Non-scalar (assume we can handle all IEnumerable types for simplicity)
: property.Type.TryGetEnumerableUnderlyingType() is { } enumerableUnderlyingType
&& context.Compilation.IsAssignable(
converterValueType,
enumerableUnderlyingType
)
); );
if (!isCompatible) if (!isCompatible)
@@ -59,4 +62,4 @@ public class ParameterMustHaveValidConverterAnalyzer : AnalyzerBase
base.Initialize(context); base.Initialize(context);
context.HandlePropertyDeclaration(Analyze); context.HandlePropertyDeclaration(Analyze);
} }
} }

View File

@@ -8,19 +8,17 @@ using Microsoft.CodeAnalysis.Diagnostics;
namespace CliFx.Analyzers; namespace CliFx.Analyzers;
[DiagnosticAnalyzer(LanguageNames.CSharp)] [DiagnosticAnalyzer(LanguageNames.CSharp)]
public class ParameterMustHaveValidValidatorsAnalyzer : AnalyzerBase public class ParameterMustHaveValidValidatorsAnalyzer()
: AnalyzerBase(
$"Parameter validators must derive from `{SymbolNames.CliFxBindingValidatorClass}`",
$"Each validator specified for this parameter must derive from a compatible `{SymbolNames.CliFxBindingValidatorClass}`."
)
{ {
public ParameterMustHaveValidValidatorsAnalyzer()
: base(
$"Parameter validators must derive from `{SymbolNames.CliFxBindingValidatorClass}`",
$"Each validator specified for this parameter must derive from a compatible `{SymbolNames.CliFxBindingValidatorClass}`.")
{
}
private void Analyze( private void Analyze(
SyntaxNodeAnalysisContext context, SyntaxNodeAnalysisContext context,
PropertyDeclarationSyntax propertyDeclaration, PropertyDeclarationSyntax propertyDeclaration,
IPropertySymbol property) IPropertySymbol property
)
{ {
var parameter = CommandParameterSymbol.TryResolve(property); var parameter = CommandParameterSymbol.TryResolve(property);
if (parameter is null) if (parameter is null)
@@ -30,14 +28,15 @@ public class ParameterMustHaveValidValidatorsAnalyzer : AnalyzerBase
{ {
var validatorValueType = validatorType var validatorValueType = validatorType
.GetBaseTypes() .GetBaseTypes()
.FirstOrDefault(t => t.ConstructedFrom.DisplayNameMatches(SymbolNames.CliFxBindingValidatorClass))? .FirstOrDefault(t =>
.TypeArguments t.ConstructedFrom.DisplayNameMatches(SymbolNames.CliFxBindingValidatorClass)
.FirstOrDefault(); )
?.TypeArguments.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
var isCompatible = var isCompatible =
validatorValueType is not null && validatorValueType is not null
context.Compilation.IsAssignable(property.Type, validatorValueType); && context.Compilation.IsAssignable(property.Type, validatorValueType);
if (!isCompatible) if (!isCompatible)
{ {
@@ -56,4 +55,4 @@ public class ParameterMustHaveValidValidatorsAnalyzer : AnalyzerBase
base.Initialize(context); base.Initialize(context);
context.HandlePropertyDeclaration(Analyze); context.HandlePropertyDeclaration(Analyze);
} }
} }

View File

@@ -9,19 +9,17 @@ using Microsoft.CodeAnalysis.Diagnostics;
namespace CliFx.Analyzers; namespace CliFx.Analyzers;
[DiagnosticAnalyzer(LanguageNames.CSharp)] [DiagnosticAnalyzer(LanguageNames.CSharp)]
public class SystemConsoleShouldBeAvoidedAnalyzer : AnalyzerBase public class SystemConsoleShouldBeAvoidedAnalyzer()
: AnalyzerBase(
$"Avoid calling `System.Console` where `{SymbolNames.CliFxConsoleInterface}` is available",
$"Use the provided `{SymbolNames.CliFxConsoleInterface}` abstraction instead of `System.Console` to ensure that the command can be tested in isolation.",
DiagnosticSeverity.Warning
)
{ {
public SystemConsoleShouldBeAvoidedAnalyzer()
: base(
$"Avoid calling `System.Console` where `{SymbolNames.CliFxConsoleInterface}` is available",
$"Use the provided `{SymbolNames.CliFxConsoleInterface}` abstraction instead of `System.Console` to ensure that the command can be tested in isolation.",
DiagnosticSeverity.Warning)
{
}
private MemberAccessExpressionSyntax? TryGetSystemConsoleMemberAccess( private MemberAccessExpressionSyntax? TryGetSystemConsoleMemberAccess(
SyntaxNodeAnalysisContext context, SyntaxNodeAnalysisContext context,
SyntaxNode node) SyntaxNode node
)
{ {
var currentNode = node; var currentNode = node;
@@ -54,8 +52,7 @@ public class SystemConsoleShouldBeAvoidedAnalyzer : AnalyzerBase
// Check if IConsole is available in scope as an alternative to System.Console // Check if IConsole is available in scope as an alternative to System.Console
var isConsoleInterfaceAvailable = context var isConsoleInterfaceAvailable = context
.Node .Node.Ancestors()
.Ancestors()
.OfType<MethodDeclarationSyntax>() .OfType<MethodDeclarationSyntax>()
.SelectMany(m => m.ParameterList.Parameters) .SelectMany(m => m.ParameterList.Parameters)
.Select(p => p.Type) .Select(p => p.Type)
@@ -65,9 +62,7 @@ public class SystemConsoleShouldBeAvoidedAnalyzer : AnalyzerBase
if (isConsoleInterfaceAvailable) if (isConsoleInterfaceAvailable)
{ {
context.ReportDiagnostic( context.ReportDiagnostic(CreateDiagnostic(systemConsoleMemberAccess.GetLocation()));
CreateDiagnostic(systemConsoleMemberAccess.GetLocation())
);
} }
} }
@@ -76,4 +71,4 @@ public class SystemConsoleShouldBeAvoidedAnalyzer : AnalyzerBase
base.Initialize(context); base.Initialize(context);
context.RegisterSyntaxNodeAction(Analyze, SyntaxKind.SimpleMemberAccessExpression); context.RegisterSyntaxNodeAction(Analyze, SyntaxKind.SimpleMemberAccessExpression);
} }
} }

View File

@@ -29,45 +29,70 @@ internal static class RoslynExtensions
} }
} }
public static ITypeSymbol? TryGetEnumerableUnderlyingType(this ITypeSymbol type) => type public static ITypeSymbol? TryGetEnumerableUnderlyingType(this ITypeSymbol type) =>
.AllInterfaces type
.FirstOrDefault(i => i.ConstructedFrom.SpecialType == SpecialType.System_Collections_Generic_IEnumerable_T)? .AllInterfaces.FirstOrDefault(i =>
.TypeArguments[0]; i.ConstructedFrom.SpecialType
== SpecialType.System_Collections_Generic_IEnumerable_T
)
?.TypeArguments[0];
public static bool IsAssignable(this Compilation compilation, ITypeSymbol source, ITypeSymbol destination) => // Detect if the property is required through roundabout means so as to not have to take dependency
compilation.ClassifyConversion(source, destination).Exists; // on higher versions of the C# compiler.
public static bool IsRequired(this IPropertySymbol property) =>
property
// Can't rely on the RequiredMemberAttribute because it's generated by the compiler, not added by the user,
// so we have to check for the presence of the `required` modifier in the syntax tree instead.
.DeclaringSyntaxReferences.Select(r => r.GetSyntax())
.OfType<PropertyDeclarationSyntax>()
.SelectMany(p => p.Modifiers)
.Any(m => m.IsKind((SyntaxKind)8447));
public static bool IsAssignable(
this Compilation compilation,
ITypeSymbol source,
ITypeSymbol destination
) => compilation.ClassifyConversion(source, destination).Exists;
public static void HandleClassDeclaration( public static void HandleClassDeclaration(
this AnalysisContext analysisContext, this AnalysisContext analysisContext,
Action<SyntaxNodeAnalysisContext, ClassDeclarationSyntax, ITypeSymbol> analyze) Action<SyntaxNodeAnalysisContext, ClassDeclarationSyntax, ITypeSymbol> analyze
)
{ {
analysisContext.RegisterSyntaxNodeAction(ctx => analysisContext.RegisterSyntaxNodeAction(
{ ctx =>
if (ctx.Node is not ClassDeclarationSyntax classDeclaration) {
return; if (ctx.Node is not ClassDeclarationSyntax classDeclaration)
return;
var type = ctx.SemanticModel.GetDeclaredSymbol(classDeclaration); var type = ctx.SemanticModel.GetDeclaredSymbol(classDeclaration);
if (type is null) if (type is null)
return; return;
analyze(ctx, classDeclaration, type); analyze(ctx, classDeclaration, type);
}, SyntaxKind.ClassDeclaration); },
SyntaxKind.ClassDeclaration
);
} }
public static void HandlePropertyDeclaration( public static void HandlePropertyDeclaration(
this AnalysisContext analysisContext, this AnalysisContext analysisContext,
Action<SyntaxNodeAnalysisContext, PropertyDeclarationSyntax, IPropertySymbol> analyze) Action<SyntaxNodeAnalysisContext, PropertyDeclarationSyntax, IPropertySymbol> analyze
)
{ {
analysisContext.RegisterSyntaxNodeAction(ctx => analysisContext.RegisterSyntaxNodeAction(
{ ctx =>
if (ctx.Node is not PropertyDeclarationSyntax propertyDeclaration) {
return; if (ctx.Node is not PropertyDeclarationSyntax propertyDeclaration)
return;
var property = ctx.SemanticModel.GetDeclaredSymbol(propertyDeclaration); var property = ctx.SemanticModel.GetDeclaredSymbol(propertyDeclaration);
if (property is null) if (property is null)
return; return;
analyze(ctx, propertyDeclaration, property); analyze(ctx, propertyDeclaration, property);
}, SyntaxKind.PropertyDeclaration); },
SyntaxKind.PropertyDeclaration
);
} }
} }

View File

@@ -7,11 +7,12 @@ internal static class StringExtensions
public static string TrimEnd( public static string TrimEnd(
this string str, this string str,
string sub, string sub,
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

@@ -29,4 +29,4 @@ public partial class Benchmarks
.AddCommand<CliFxCommand>() .AddCommand<CliFxCommand>()
.Build() .Build()
.RunAsync(Arguments, new Dictionary<string, string>()); .RunAsync(Arguments, new Dictionary<string, string>());
} }

View File

@@ -16,11 +16,9 @@ public partial class Benchmarks
[NamedArgument('b', "bool", Constraint = NumArgsConstraint.Optional, Const = true)] [NamedArgument('b', "bool", Constraint = NumArgsConstraint.Optional, Const = true)]
public bool BoolOption { get; set; } public bool BoolOption { get; set; }
public void Execute() public void Execute() { }
{
}
} }
[Benchmark(Description = "Clipr")] [Benchmark(Description = "Clipr")]
public void ExecuteWithClipr() => CliParser.Parse<CliprCommand>(Arguments).Execute(); public void ExecuteWithClipr() => CliParser.Parse<CliprCommand>(Arguments).Execute();
} }

View File

@@ -8,16 +8,12 @@ public partial class Benchmarks
public class CoconaCommand public class CoconaCommand
{ {
public void Execute( public void Execute(
[Option("str", new []{'s'})] [Option("str", ['s'])] string? strOption,
string? strOption, [Option("int", ['i'])] int intOption,
[Option("int", new []{'i'})] [Option("bool", ['b'])] bool boolOption
int intOption, ) { }
[Option("bool", new []{'b'})]
bool boolOption)
{
}
} }
[Benchmark(Description = "Cocona")] [Benchmark(Description = "Cocona")]
public void ExecuteWithCocona() => CoconaApp.Run<CoconaCommand>(Arguments); public void ExecuteWithCocona() => CoconaApp.Run<CoconaCommand>(Arguments);
} }

View File

@@ -16,9 +16,7 @@ public partial class Benchmarks
[Option('b', "bool")] [Option('b', "bool")]
public bool BoolOption { get; set; } public bool BoolOption { get; set; }
public void Execute() public void Execute() { }
{
}
} }
[Benchmark(Description = "CommandLineParser")] [Benchmark(Description = "CommandLineParser")]
@@ -26,4 +24,4 @@ public partial class Benchmarks
new Parser() new Parser()
.ParseArguments(Arguments, typeof(CommandLineParserCommand)) .ParseArguments(Arguments, typeof(CommandLineParserCommand))
.WithParsed<CommandLineParserCommand>(c => c.Execute()); .WithParsed<CommandLineParserCommand>(c => c.Execute());
} }

View File

@@ -21,4 +21,4 @@ public partial class Benchmarks
[Benchmark(Description = "McMaster.Extensions.CommandLineUtils")] [Benchmark(Description = "McMaster.Extensions.CommandLineUtils")]
public int ExecuteWithMcMaster() => CommandLineApplication.Execute<McMasterCommand>(Arguments); public int ExecuteWithMcMaster() => CommandLineApplication.Execute<McMasterCommand>(Arguments);
} }

View File

@@ -16,11 +16,9 @@ public partial class Benchmarks
[ArgShortcut("--bool"), ArgShortcut("-b")] [ArgShortcut("--bool"), ArgShortcut("-b")]
public bool BoolOption { get; set; } public bool BoolOption { get; set; }
public void Main() public void Main() { }
{
}
} }
[Benchmark(Description = "PowerArgs")] [Benchmark(Description = "PowerArgs")]
public void ExecuteWithPowerArgs() => Args.InvokeMain<PowerArgsCommand>(Arguments); public void ExecuteWithPowerArgs() => Args.InvokeMain<PowerArgsCommand>(Arguments);
} }

View File

@@ -1,5 +1,4 @@
using System.CommandLine; using System.CommandLine;
using System.CommandLine.Invocation;
using System.Threading.Tasks; using System.Threading.Tasks;
using BenchmarkDotNet.Attributes; using BenchmarkDotNet.Attributes;
@@ -9,29 +8,20 @@ public partial class Benchmarks
{ {
public class SystemCommandLineCommand public class SystemCommandLineCommand
{ {
public static int ExecuteHandler(string s, int i, bool b) => 0; public static void ExecuteHandler(string s, int i, bool b) { }
public Task<int> ExecuteAsync(string[] args) public Task<int> ExecuteAsync(string[] args)
{ {
var command = new RootCommand var stringOption = new Option<string>(["--str", "-s"]);
{ var intOption = new Option<int>(["--int", "-i"]);
new Option(new[] {"--str", "-s"}) var boolOption = new Option<bool>(["--bool", "-b"]);
{
Argument = new Argument<string?>()
},
new Option(new[] {"--int", "-i"})
{
Argument = new Argument<int>()
},
new Option(new[] {"--bool", "-b"})
{
Argument = new Argument<bool>()
}
};
command.Handler = CommandHandler.Create( var command = new RootCommand();
typeof(SystemCommandLineCommand).GetMethod(nameof(ExecuteHandler))! command.AddOption(stringOption);
); command.AddOption(intOption);
command.AddOption(boolOption);
command.SetHandler(ExecuteHandler, stringOption, intOption, boolOption);
return command.InvokeAsync(args); return command.InvokeAsync(args);
} }
@@ -40,4 +30,4 @@ public partial class Benchmarks
[Benchmark(Description = "System.CommandLine")] [Benchmark(Description = "System.CommandLine")]
public async Task<int> ExecuteWithSystemCommandLine() => public async Task<int> ExecuteWithSystemCommandLine() =>
await new SystemCommandLineCommand().ExecuteAsync(Arguments); await new SystemCommandLineCommand().ExecuteAsync(Arguments);
} }

View File

@@ -9,11 +9,10 @@ namespace CliFx.Benchmarks;
[Orderer(SummaryOrderPolicy.FastestToSlowest)] [Orderer(SummaryOrderPolicy.FastestToSlowest)]
public partial class Benchmarks public partial class Benchmarks
{ {
private static readonly string[] Arguments = {"--str", "hello world", "-i", "13", "-b"}; private static readonly string[] Arguments = ["--str", "hello world", "-i", "13", "-b"];
public static void Main() => BenchmarkRunner.Run<Benchmarks>( public static void Main() =>
DefaultConfig BenchmarkRunner.Run<Benchmarks>(
.Instance DefaultConfig.Instance.WithOptions(ConfigOptions.DisableOptimizationsValidator)
.WithOptions(ConfigOptions.DisableOptimizationsValidator) );
); }
}

View File

@@ -1,18 +1,20 @@
<Project Sdk="Microsoft.NET.Sdk"> <Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup> <PropertyGroup>
<OutputType>Exe</OutputType> <OutputType>Exe</OutputType>
<TargetFramework>net6.0</TargetFramework> <TargetFramework>net9.0</TargetFramework>
<NuGetAudit>false</NuGetAudit>
</PropertyGroup> </PropertyGroup>
<ItemGroup> <ItemGroup>
<PackageReference Include="BenchmarkDotNet" Version="0.13.1" /> <PackageReference Include="BenchmarkDotNet" Version="0.15.4" />
<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="CSharpier.MsBuild" Version="0.30.6" PrivateAssets="all" />
<PackageReference Include="PowerArgs" Version="3.6.0" /> <PackageReference Include="McMaster.Extensions.CommandLineUtils" Version="4.1.1" />
<PackageReference Include="System.CommandLine" Version="2.0.0-beta1.20574.7" /> <PackageReference Include="PowerArgs" Version="4.0.3" />
<PackageReference Include="System.CommandLine" Version="2.0.0-rc.1.25451.107" />
</ItemGroup> </ItemGroup>
<ItemGroup> <ItemGroup>

View File

@@ -1,13 +1,14 @@
<Project Sdk="Microsoft.NET.Sdk"> <Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup> <PropertyGroup>
<OutputType>Exe</OutputType> <OutputType>Exe</OutputType>
<TargetFramework>net6.0</TargetFramework> <TargetFramework>net9.0</TargetFramework>
<ApplicationIcon>../favicon.ico</ApplicationIcon>
</PropertyGroup> </PropertyGroup>
<ItemGroup> <ItemGroup>
<PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="6.0.0" /> <PackageReference Include="CSharpier.MsBuild" Version="0.30.6" PrivateAssets="all" />
<PackageReference Include="Newtonsoft.Json" Version="13.0.1" /> <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="9.0.9" />
</ItemGroup> </ItemGroup>
<ItemGroup> <ItemGroup>

View File

@@ -8,62 +8,48 @@ using CliFx.Infrastructure;
namespace CliFx.Demo.Commands; namespace CliFx.Demo.Commands;
[Command("book add", Description = "Add a book to the library.")] [Command("book add", Description = "Adds a book to the library.")]
public partial class BookAddCommand : ICommand public class BookAddCommand(LibraryProvider libraryProvider) : ICommand
{ {
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', 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; } =
new(
Random.Shared.Next(1800, 2020),
Random.Shared.Next(1, 12),
Random.Shared.Next(1, 28),
Random.Shared.Next(1, 23),
Random.Shared.Next(1, 59),
Random.Shared.Next(1, 59),
TimeSpan.Zero
);
[CommandOption("isbn", 'n', Description = "Book ISBN.")] [CommandOption("isbn", 'n', Description = "Book ISBN.")]
public Isbn Isbn { get; init; } = CreateRandomIsbn(); public Isbn Isbn { get; init; } =
new(
public BookAddCommand(LibraryProvider libraryProvider) Random.Shared.Next(0, 999),
{ Random.Shared.Next(0, 99),
_libraryProvider = libraryProvider; Random.Shared.Next(0, 99999),
} Random.Shared.Next(0, 99),
Random.Shared.Next(0, 9)
);
public ValueTask ExecuteAsync(IConsole console) public ValueTask ExecuteAsync(IConsole console)
{ {
if (_libraryProvider.TryGetBook(Title) is not null) if (libraryProvider.TryGetBook(Title) is not null)
throw new CommandException("Book already exists.", 10); throw new CommandException($"Book '{Title}' already exists.", 10);
var book = new Book(Title, Author, Published, Isbn); var book = new Book(Title, Author, Published, Isbn);
_libraryProvider.AddBook(book); libraryProvider.AddBook(book);
console.Output.WriteLine("Book added."); console.WriteLine($"Book '{Title}' added.");
console.Output.WriteBook(book); console.WriteBook(book);
return default; return default;
} }
} }
public partial class BookAddCommand
{
private static readonly Random Random = new();
private static DateTimeOffset CreateRandomDate() => new(
Random.Next(1800, 2020),
Random.Next(1, 12),
Random.Next(1, 28),
Random.Next(1, 23),
Random.Next(1, 59),
Random.Next(1, 59),
TimeSpan.Zero
);
private static Isbn CreateRandomIsbn() => new(
Random.Next(0, 999),
Random.Next(0, 99),
Random.Next(0, 99999),
Random.Next(0, 99),
Random.Next(0, 9)
);
}

View File

@@ -7,28 +7,21 @@ using CliFx.Infrastructure;
namespace CliFx.Demo.Commands; namespace CliFx.Demo.Commands;
[Command("book", Description = "Retrieve a book from the library.")] [Command("book", Description = "Retrieves a book from the library.")]
public class BookCommand : ICommand public class BookCommand(LibraryProvider libraryProvider) : ICommand
{ {
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)
{
_libraryProvider = libraryProvider;
}
public ValueTask ExecuteAsync(IConsole console) public ValueTask ExecuteAsync(IConsole console)
{ {
var book = _libraryProvider.TryGetBook(Title); var book = libraryProvider.TryGetBook(Title);
if (book is null) if (book is null)
throw new CommandException("Book not found.", 10); throw new CommandException($"Book '{Title}' not found.", 10);
console.Output.WriteBook(book); console.WriteBook(book);
return default; return default;
} }
} }

View File

@@ -6,31 +6,24 @@ using CliFx.Infrastructure;
namespace CliFx.Demo.Commands; namespace CliFx.Demo.Commands;
[Command("book list", Description = "List all books in the library.")] [Command("book list", Description = "Lists all books in the library.")]
public class BookListCommand : ICommand public class BookListCommand(LibraryProvider libraryProvider) : ICommand
{ {
private readonly LibraryProvider _libraryProvider;
public BookListCommand(LibraryProvider libraryProvider)
{
_libraryProvider = libraryProvider;
}
public ValueTask ExecuteAsync(IConsole console) public ValueTask ExecuteAsync(IConsole console)
{ {
var library = _libraryProvider.GetLibrary(); var library = libraryProvider.GetLibrary();
for (var i = 0; i < library.Books.Count; i++) for (var i = 0; i < library.Books.Count; i++)
{ {
// Add margin // Add margin
if (i != 0) if (i != 0)
console.Output.WriteLine(); console.WriteLine();
// Render book // Render book
var book = library.Books[i]; var book = library.Books[i];
console.Output.WriteBook(book); console.WriteBook(book);
} }
return default; return default;
} }
} }

View File

@@ -6,30 +6,23 @@ using CliFx.Infrastructure;
namespace CliFx.Demo.Commands; namespace CliFx.Demo.Commands;
[Command("book remove", Description = "Remove a book from the library.")] [Command("book remove", Description = "Removes a book from the library.")]
public class BookRemoveCommand : ICommand public class BookRemoveCommand(LibraryProvider libraryProvider) : ICommand
{ {
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)
{
_libraryProvider = libraryProvider;
}
public ValueTask ExecuteAsync(IConsole console) public ValueTask ExecuteAsync(IConsole console)
{ {
var book = _libraryProvider.TryGetBook(Title); var book = libraryProvider.TryGetBook(Title);
if (book is null) if (book is null)
throw new CommandException("Book not found.", 10); throw new CommandException($"Book '{Title}' not found.", 10);
_libraryProvider.RemoveBook(book); libraryProvider.RemoveBook(book);
console.Output.WriteLine($"Book {Title} removed."); console.WriteLine($"Book '{Title}' removed.");
return default; return default;
} }
} }

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,19 @@
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)
{ {
@@ -41,4 +28,4 @@ public partial class Isbn
int.Parse(components[4], formatProvider) int.Parse(components[4], 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,16 +1,17 @@
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;
public class LibraryProvider public class LibraryProvider
{ {
private static string StorageFilePath { get; } = Path.Combine(Directory.GetCurrentDirectory(), "Library.json"); private static string StorageFilePath { get; } =
Path.Combine(Directory.GetCurrentDirectory(), "Library.json");
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,10 +22,11 @@ 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);
public void AddBook(Book book) public void AddBook(Book book)
{ {
@@ -37,4 +39,4 @@ public class LibraryProvider
var updatedLibrary = GetLibrary().WithoutBook(book); var updatedLibrary = GetLibrary().WithoutBook(book);
StoreLibrary(updatedLibrary); StoreLibrary(updatedLibrary);
} }
} }

View File

@@ -1,25 +1,21 @@
using CliFx; using CliFx;
using CliFx.Demo.Commands;
using CliFx.Demo.Domain; using CliFx.Demo.Domain;
using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.DependencyInjection;
// We use Microsoft.Extensions.DependencyInjection for injecting dependencies in commands
var services = new ServiceCollection();
// Register services
services.AddSingleton<LibraryProvider>();
// Register commands
services.AddTransient<BookCommand>();
services.AddTransient<BookAddCommand>();
services.AddTransient<BookRemoveCommand>();
services.AddTransient<BookListCommand>();
var serviceProvider = services.BuildServiceProvider();
return await new CliApplicationBuilder() return await new CliApplicationBuilder()
.SetDescription("Demo application showcasing CliFx features.") .SetDescription("Demo application showcasing CliFx features.")
.AddCommandsFromThisAssembly() .AddCommandsFromThisAssembly()
.UseTypeActivator(serviceProvider.GetRequiredService) .UseTypeActivator(commandTypes =>
{
// We use Microsoft.Extensions.DependencyInjection for injecting dependencies in commands
var services = new ServiceCollection();
services.AddSingleton<LibraryProvider>();
// Register all commands as transient services
foreach (var commandType in commandTypes)
services.AddTransient(commandType);
return services.BuildServiceProvider();
})
.Build() .Build()
.RunAsync(); .RunAsync();

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

@@ -33,4 +33,7 @@ internal static class ConsoleExtensions
using (writer.Console.WithForegroundColor(ConsoleColor.White)) using (writer.Console.WithForegroundColor(ConsoleColor.White))
writer.WriteLine(book.Isbn); writer.WriteLine(book.Isbn);
} }
}
public static void WriteBook(this IConsole console, Book book) =>
console.Output.WriteBook(book);
}

View File

@@ -2,9 +2,14 @@
<PropertyGroup> <PropertyGroup>
<OutputType>Exe</OutputType> <OutputType>Exe</OutputType>
<TargetFramework>net6.0</TargetFramework> <TargetFramework>net9.0</TargetFramework>
<ApplicationIcon>../favicon.ico</ApplicationIcon>
</PropertyGroup> </PropertyGroup>
<ItemGroup>
<PackageReference Include="CSharpier.MsBuild" Version="0.30.6" PrivateAssets="all" />
</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" />

View File

@@ -0,0 +1,27 @@
using System;
using System.Threading.Tasks;
using CliFx.Attributes;
using CliFx.Infrastructure;
namespace CliFx.Tests.Dummy.Commands;
[Command("cancel-test")]
public class CancellationTestCommand : ICommand
{
public async ValueTask ExecuteAsync(IConsole console)
{
try
{
console.WriteLine("Started.");
await Task.Delay(TimeSpan.FromSeconds(3), console.RegisterCancellationHandler());
console.WriteLine("Completed.");
}
catch (OperationCanceledException)
{
console.WriteLine("Cancelled.");
throw;
}
}
}

View File

@@ -20,4 +20,4 @@ public class ConsoleTestCommand : ICommand
return default; return default;
} }
} }

View File

@@ -8,12 +8,11 @@ namespace CliFx.Tests.Dummy.Commands;
public class EnvironmentTestCommand : ICommand public class EnvironmentTestCommand : ICommand
{ {
[CommandOption("target", EnvironmentVariable = "ENV_TARGET")] [CommandOption("target", EnvironmentVariable = "ENV_TARGET")]
public string GreetingTarget { get; set; } = "World"; public string GreetingTarget { get; init; } = "World";
public ValueTask ExecuteAsync(IConsole console) public ValueTask ExecuteAsync(IConsole console)
{ {
console.Output.WriteLine($"Hello {GreetingTarget}!"); console.WriteLine($"Hello {GreetingTarget}!");
return default; return default;
} }
} }

View File

@@ -1,20 +1,21 @@
using System; using System;
using System.IO;
using System.Reflection; using System.Reflection;
using System.Runtime.InteropServices;
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
// that require an external process to properly verify.
public static partial class Program // This dummy application is used in tests for scenarios that require an external process to properly verify
public static class Program
{ {
public static Assembly Assembly { get; } = typeof(Program).Assembly; // Path to the apphost
public static string FilePath { get; } =
Path.ChangeExtension(
Assembly.GetExecutingAssembly().Location,
RuntimeInformation.IsOSPlatform(OSPlatform.Windows) ? "exe" : null
);
public static string Location { get; } = Assembly.Location;
}
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 // Make sure color codes are not produced because we rely on the output in tests
@@ -23,9 +24,6 @@ public static partial class Program
"false" "false"
); );
await new CliApplicationBuilder() await new CliApplicationBuilder().AddCommandsFromThisAssembly().Build().RunAsync();
.AddCommandsFromThisAssembly()
.Build()
.RunAsync();
} }
} }

View File

@@ -8,15 +8,10 @@ using Xunit.Abstractions;
namespace CliFx.Tests; namespace CliFx.Tests;
public class ApplicationSpecs : SpecsBase public class ApplicationSpecs(ITestOutputHelper testOutput) : SpecsBase(testOutput)
{ {
public ApplicationSpecs(ITestOutputHelper testOutput)
: base(testOutput)
{
}
[Fact] [Fact]
public async Task Application_can_be_created_with_minimal_configuration() public async Task I_can_create_an_application_with_the_default_configuration()
{ {
// Act // Act
var app = new CliApplicationBuilder() var app = new CliApplicationBuilder()
@@ -24,24 +19,21 @@ public class ApplicationSpecs : SpecsBase
.UseConsole(FakeConsole) .UseConsole(FakeConsole)
.Build(); .Build();
var exitCode = await app.RunAsync( var exitCode = await app.RunAsync(Array.Empty<string>(), new Dictionary<string, string>());
Array.Empty<string>(),
new Dictionary<string, string>()
);
// Assert // Assert
exitCode.Should().Be(0); exitCode.Should().Be(0);
} }
[Fact] [Fact]
public async Task Application_can_be_created_with_a_fully_customized_configuration() public async Task I_can_create_an_application_with_a_custom_configuration()
{ {
// Act // Act
var app = new CliApplicationBuilder() var app = new CliApplicationBuilder()
.AddCommand<NoOpCommand>() .AddCommand<NoOpCommand>()
.AddCommandsFrom(typeof(NoOpCommand).Assembly) .AddCommandsFrom(typeof(NoOpCommand).Assembly)
.AddCommands(new[] {typeof(NoOpCommand)}) .AddCommands([typeof(NoOpCommand)])
.AddCommandsFrom(new[] {typeof(NoOpCommand).Assembly}) .AddCommandsFrom([typeof(NoOpCommand).Assembly])
.AddCommandsFromThisAssembly() .AddCommandsFromThisAssembly()
.AllowDebugMode() .AllowDebugMode()
.AllowPreviewMode() .AllowPreviewMode()
@@ -53,17 +45,14 @@ public class ApplicationSpecs : SpecsBase
.UseTypeActivator(Activator.CreateInstance!) .UseTypeActivator(Activator.CreateInstance!)
.Build(); .Build();
var exitCode = await app.RunAsync( var exitCode = await app.RunAsync(Array.Empty<string>(), new Dictionary<string, string>());
Array.Empty<string>(),
new Dictionary<string, string>()
);
// Assert // Assert
exitCode.Should().Be(0); exitCode.Should().Be(0);
} }
[Fact] [Fact]
public async Task Application_configuration_fails_if_an_invalid_command_is_registered() public async Task I_can_try_to_create_an_application_and_get_an_error_if_it_has_invalid_commands()
{ {
// Act // Act
var app = new CliApplicationBuilder() var app = new CliApplicationBuilder()
@@ -71,15 +60,12 @@ public class ApplicationSpecs : SpecsBase
.UseConsole(FakeConsole) .UseConsole(FakeConsole)
.Build(); .Build();
var exitCode = await app.RunAsync( var exitCode = await app.RunAsync(Array.Empty<string>(), new Dictionary<string, string>());
Array.Empty<string>(),
new Dictionary<string, string>()
);
var stdErr = FakeConsole.ReadErrorString();
// Assert // Assert
exitCode.Should().NotBe(0); exitCode.Should().NotBe(0);
var stdErr = FakeConsole.ReadErrorString();
stdErr.Should().Contain("not a valid command"); stdErr.Should().Contain("not a valid command");
} }
} }

View File

@@ -1,66 +1,107 @@
using System; using System;
using System.Collections.Generic; using System.Collections.Generic;
using System.Text;
using System.Threading;
using System.Threading.Tasks; using System.Threading.Tasks;
using CliFx.Tests.Utils; using CliFx.Tests.Utils;
using CliFx.Tests.Utils.Extensions;
using CliWrap;
using FluentAssertions; using FluentAssertions;
using Xunit; using Xunit;
using Xunit.Abstractions; using Xunit.Abstractions;
namespace CliFx.Tests; namespace CliFx.Tests;
public class CancellationSpecs : SpecsBase public class CancellationSpecs(ITestOutputHelper testOutput) : SpecsBase(testOutput)
{ {
public CancellationSpecs(ITestOutputHelper testOutput) [Fact(Timeout = 15000)]
: base(testOutput) public async Task I_can_configure_the_command_to_listen_to_the_interrupt_signal()
{ {
// Arrange
using var cts = new CancellationTokenSource();
// We need to send the cancellation request right after the process has registered
// a handler for the interrupt signal, otherwise the default handler will trigger
// and just kill the process.
void HandleStdOut(string line)
{
if (string.Equals(line, "Started.", StringComparison.OrdinalIgnoreCase))
cts.CancelAfter(TimeSpan.FromSeconds(0.2));
}
var stdOutBuffer = new StringBuilder();
var pipeTarget = PipeTarget.Merge(
PipeTarget.ToDelegate(HandleStdOut),
PipeTarget.ToStringBuilder(stdOutBuffer)
);
var command = Cli.Wrap(Dummy.Program.FilePath).WithArguments("cancel-test") | pipeTarget;
// Act & assert
await Assert.ThrowsAnyAsync<OperationCanceledException>(
async () =>
await command.ExecuteAsync(
// Forceful cancellation (not required because we have a timeout)
CancellationToken.None,
// Graceful cancellation
cts.Token
)
);
stdOutBuffer.ToString().Trim().Should().ConsistOfLines("Started.", "Cancelled.");
} }
[Fact] [Fact]
public async Task Command_can_register_to_receive_a_cancellation_signal_from_the_console() public async Task I_can_configure_the_command_to_listen_to_the_interrupt_signal_when_running_in_isolation()
{ {
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // lang=csharp
@" """
[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( console.WriteLine("Started.");
TimeSpan.FromSeconds(3),
console.RegisterCancellationHandler()
);
console.Output.WriteLine(""Completed successfully""); await Task.Delay(
} TimeSpan.FromSeconds(3),
catch (OperationCanceledException) console.RegisterCancellationHandler()
{ );
console.Output.WriteLine(""Cancelled"");
throw; console.WriteLine("Completed.");
} }
} catch (OperationCanceledException)
}"); {
console.WriteLine("Cancelled.");
throw;
}
}
}
"""
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
.UseConsole(FakeConsole) .UseConsole(FakeConsole)
.Build(); .Build();
// Act
FakeConsole.RequestCancellation(TimeSpan.FromSeconds(0.2)); FakeConsole.RequestCancellation(TimeSpan.FromSeconds(0.2));
// Act
var exitCode = await application.RunAsync( var exitCode = await application.RunAsync(
Array.Empty<string>(), Array.Empty<string>(),
new Dictionary<string, string>() new Dictionary<string, string>()
); );
var stdOut = FakeConsole.ReadOutputString();
// Assert // Assert
exitCode.Should().NotBe(0); exitCode.Should().NotBe(0);
stdOut.Trim().Should().Be("Cancelled");
var stdOut = FakeConsole.ReadOutputString();
stdOut.Trim().Should().ConsistOfLines("Started.", "Cancelled.");
} }
} }

View File

@@ -1,7 +1,7 @@
<Project Sdk="Microsoft.NET.Sdk"> <Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup> <PropertyGroup>
<TargetFramework>net6.0</TargetFramework> <TargetFramework>net9.0</TargetFramework>
</PropertyGroup> </PropertyGroup>
<ItemGroup> <ItemGroup>
@@ -9,15 +9,18 @@
</ItemGroup> </ItemGroup>
<ItemGroup> <ItemGroup>
<PackageReference Include="Basic.Reference.Assemblies" Version="1.2.4" /> <PackageReference Include="Basic.Reference.Assemblies.Net80" Version="1.8.3" />
<PackageReference Include="CliWrap" Version="3.4.4" /> <PackageReference Include="CliWrap" Version="3.9.0" />
<PackageReference Include="FluentAssertions" Version="6.6.0" /> <PackageReference Include="coverlet.collector" Version="6.0.4" PrivateAssets="all" />
<PackageReference Include="GitHubActionsTestLogger" Version="1.4.1" PrivateAssets="all" /> <PackageReference Include="CSharpier.MsBuild" Version="0.30.6" PrivateAssets="all" />
<PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.1.0" /> <PackageReference Include="FluentAssertions" Version="8.7.0" />
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.1.0" /> <PackageReference Include="GitHubActionsTestLogger" Version="2.4.1" PrivateAssets="all" />
<PackageReference Include="xunit" Version="2.4.1" /> <PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.11.0" />
<PackageReference Include="xunit.runner.visualstudio" Version="2.4.5" PrivateAssets="all" /> <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="9.0.9" />
<PackageReference Include="coverlet.collector" Version="3.1.2" PrivateAssets="all" /> <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.14.1" />
<PackageReference Include="PolyShim" Version="1.15.0" PrivateAssets="all" />
<PackageReference Include="xunit" Version="2.9.3" />
<PackageReference Include="xunit.runner.visualstudio" Version="3.1.5" PrivateAssets="all" />
</ItemGroup> </ItemGroup>
<ItemGroup> <ItemGroup>
@@ -25,12 +28,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

@@ -14,25 +14,16 @@ using Xunit.Abstractions;
namespace CliFx.Tests; namespace CliFx.Tests;
public class ConsoleSpecs : SpecsBase public class ConsoleSpecs(ITestOutputHelper testOutput) : SpecsBase(testOutput)
{ {
public ConsoleSpecs(ITestOutputHelper testOutput) [Fact(Timeout = 15000)]
: base(testOutput) public async Task I_can_run_the_application_with_the_default_console_implementation_to_interact_with_the_system_console()
{ {
} // Can't verify our own console output, so using an external process for this test
[Fact]
public async Task Real_console_maps_directly_to_system_console()
{
// Can't verify our own console output, so using an
// external process for this test.
// Arrange // Arrange
var command = "Hello world" | Cli.Wrap("dotnet") var command =
.WithArguments(a => a "Hello world" | Cli.Wrap(Dummy.Program.FilePath).WithArguments("console-test");
.Add(Dummy.Program.Location)
.Add("console-test")
);
// Act // Act
var result = await command.ExecuteBufferedAsync(); var result = await command.ExecuteBufferedAsync();
@@ -43,30 +34,52 @@ public class ConsoleSpecs : SpecsBase
} }
[Fact] [Fact]
public async Task Fake_console_does_not_leak_to_system_console() public void I_can_run_the_application_on_a_system_with_a_custom_console_encoding_and_not_get_corrupted_output()
{
// Arrange
using var buffer = new MemoryStream();
using var consoleWriter = new ConsoleWriter(FakeConsole, buffer, Encoding.UTF8);
// Act
consoleWriter.Write("Hello world");
consoleWriter.Flush();
// Assert
var outputBytes = buffer.ToArray();
outputBytes.Should().NotContain(Encoding.UTF8.GetPreamble());
var output = consoleWriter.Encoding.GetString(outputBytes);
output.Should().Be("Hello world");
}
[Fact]
public async Task I_can_run_the_application_with_the_fake_console_implementation_to_isolate_console_interactions()
{ {
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // lang=csharp
@" """
[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)
@@ -90,6 +103,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);
@@ -99,25 +114,26 @@ public class Command : ICommand
} }
[Fact] [Fact]
public async Task Fake_console_can_be_used_with_an_in_memory_backing_store() public async Task I_can_run_the_application_with_the_fake_console_implementation_and_simulate_stream_interactions()
{ {
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // lang=csharp
@" """
[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)
@@ -132,35 +148,37 @@ public class Command : ICommand
new Dictionary<string, string>() new Dictionary<string, string>()
); );
var stdOut = FakeConsole.ReadOutputString();
var stdErr = FakeConsole.ReadErrorString();
// Assert // Assert
exitCode.Should().Be(0); exitCode.Should().Be(0);
var stdOut = FakeConsole.ReadOutputString();
stdOut.Trim().Should().Be("Hello world"); stdOut.Trim().Should().Be("Hello world");
var stdErr = FakeConsole.ReadErrorString();
stdErr.Trim().Should().Be("Hello world"); stdErr.Trim().Should().Be("Hello world");
} }
[Fact] [Fact]
public async Task Fake_console_can_read_key_presses() public async Task I_can_run_the_application_with_the_fake_console_implementation_and_simulate_key_presses()
{ {
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // lang=csharp
@" """
[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.WriteLine(console.ReadKey().Key);
console.Output.WriteLine(console.ReadKey().Key); console.WriteLine(console.ReadKey().Key);
console.Output.WriteLine(console.ReadKey().Key); console.WriteLine(console.ReadKey().Key);
return default; return default;
} }
} }
"); """
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -177,31 +195,10 @@ public class Command : ICommand
new Dictionary<string, string>() new Dictionary<string, string>()
); );
var stdOut = FakeConsole.ReadOutputString();
// Assert // Assert
exitCode.Should().Be(0); exitCode.Should().Be(0);
stdOut.Trim().Should().ConsistOfLines(
"D0", var stdOut = FakeConsole.ReadOutputString();
"A", stdOut.Trim().Should().ConsistOfLines("D0", "A", "Backspace");
"Backspace"
);
} }
}
[Fact]
public void Console_does_not_emit_preamble_when_used_with_encoding_that_has_it()
{
// Arrange
using var buffer = new MemoryStream();
using var consoleWriter = new ConsoleWriter(FakeConsole, buffer, Encoding.UTF8);
// Act
consoleWriter.Write("Hello world");
consoleWriter.Flush();
var output = consoleWriter.Encoding.GetString(buffer.ToArray());
// Assert
output.Should().Be("Hello world");
}
}

File diff suppressed because it is too large Load Diff

View File

@@ -1,6 +1,5 @@
using System; using System;
using System.Collections.Generic; using System.Collections.Generic;
using System.Text;
using System.Threading; using System.Threading;
using System.Threading.Tasks; using System.Threading.Tasks;
using CliFx.Tests.Utils; using CliFx.Tests.Utils;
@@ -12,76 +11,49 @@ using Xunit.Abstractions;
namespace CliFx.Tests; namespace CliFx.Tests;
public class DirectivesSpecs : SpecsBase public class DirectivesSpecs(ITestOutputHelper testOutput) : SpecsBase(testOutput)
{ {
public DirectivesSpecs(ITestOutputHelper testOutput) [Fact(Timeout = 15000)]
: base(testOutput) public async Task I_can_use_the_debug_directive_to_make_the_application_wait_for_the_debugger_to_attach()
{
}
[Fact]
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();
var command = Cli.Wrap("dotnet") // We can't actually attach a debugger, but we can ensure that the process is waiting for one
.WithArguments(a => a void HandleStdOut(string line)
.Add(Dummy.Program.Location) {
.Add("[debug]") // Kill the process once it writes the output we expect
) | stdOutBuffer; if (line.Contains("Attach the debugger to", StringComparison.OrdinalIgnoreCase))
cts.Cancel();
}
// Act var command = Cli.Wrap(Dummy.Program.FilePath).WithArguments("[debug]") | HandleStdOut;
// 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)
{ {
// This is expected // This means that the process was killed after it wrote the expected output
} }
var stdOut = stdOutBuffer.ToString();
// Assert
stdOut.Should().Contain("Attach debugger to");
TestOutput.WriteLine(stdOut);
} }
[Fact] [Fact]
public async Task Preview_directive_can_be_specified_to_print_command_input() public async Task I_can_use_the_preview_directive_to_make_the_application_print_the_parsed_command_input()
{ {
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // lang=csharp
@" """
[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)
@@ -91,22 +63,29 @@ public class Command : ICommand
// Act // Act
var exitCode = await application.RunAsync( var exitCode = await application.RunAsync(
new[] {"[preview]", "cmd", "param", "-abc", "--option", "foo"}, ["[preview]", "cmd", "param", "-abc", "--option", "foo"],
new Dictionary<string, string> new Dictionary<string, string> { ["ENV_QOP"] = "hello", ["ENV_KIL"] = "world" }
{
["ENV_QOP"] = "hello",
["ENV_KIL"] = "world"
}
); );
var stdOut = FakeConsole.ReadOutputString();
// Assert // Assert
exitCode.Should().Be(0); exitCode.Should().Be(0);
stdOut.Should().ContainAllInOrder(
"cmd", "<param>", "[-a]", "[-b]", "[-c]", "[--option \"foo\"]", var stdOut = FakeConsole.ReadOutputString();
"ENV_QOP", "=", "\"hello\"", stdOut
"ENV_KIL", "=", "\"world\"" .Should()
); .ContainAllInOrder(
"cmd",
"<param>",
"[-a]",
"[-b]",
"[-c]",
"[--option \"foo\"]",
"ENV_QOP",
"=",
"\"hello\"",
"ENV_KIL",
"=",
"\"world\""
);
} }
} }

View File

@@ -12,33 +12,76 @@ using Xunit.Abstractions;
namespace CliFx.Tests; namespace CliFx.Tests;
public class EnvironmentSpecs : SpecsBase public class EnvironmentSpecs(ITestOutputHelper testOutput) : SpecsBase(testOutput)
{ {
public EnvironmentSpecs(ITestOutputHelper testOutput)
: base(testOutput)
{
}
[Fact] [Fact]
public async Task Option_can_fall_back_to_an_environment_variable() public async Task I_can_configure_an_option_to_fall_back_to_an_environment_variable_if_the_user_does_not_provide_the_corresponding_argument()
{ {
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // lang=csharp
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandOption(""foo"", IsRequired = true, EnvironmentVariable = ""ENV_FOO"")] [CommandOption("foo", EnvironmentVariable = "ENV_FOO")]
public string Foo { get; set; } public string? Foo { get; init; }
public ValueTask ExecuteAsync(IConsole console) [CommandOption("bar", EnvironmentVariable = "ENV_BAR")]
{ public string? Bar { get; init; }
console.Output.WriteLine(Foo);
return default; public ValueTask ExecuteAsync(IConsole console)
{
console.WriteLine(Foo);
console.WriteLine(Bar);
return default;
}
}
"""
);
var application = new CliApplicationBuilder()
.AddCommand(commandType)
.UseConsole(FakeConsole)
.Build();
// Act
var exitCode = await application.RunAsync(
["--foo", "42"],
new Dictionary<string, string> { ["ENV_FOO"] = "100", ["ENV_BAR"] = "200" }
);
// Assert
exitCode.Should().Be(0);
var stdOut = FakeConsole.ReadOutputString();
stdOut.Trim().Should().ConsistOfLines("42", "200");
} }
}
"); [Fact]
public async Task I_can_configure_an_option_bound_to_a_non_scalar_property_to_fall_back_to_an_environment_variable_if_the_user_does_not_provide_the_corresponding_argument()
{
// Arrange
var commandType = DynamicCommandBuilder.Compile(
// lang=csharp
"""
[Command]
public class Command : ICommand
{
[CommandOption("foo", EnvironmentVariable = "ENV_FOO")]
public IReadOnlyList<string>? Foo { get; init; }
public ValueTask ExecuteAsync(IConsole console)
{
foreach (var i in Foo)
console.WriteLine(i);
return default;
}
}
"""
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -48,83 +91,37 @@ public class Command : ICommand
// Act // Act
var exitCode = await application.RunAsync( var exitCode = await application.RunAsync(
Array.Empty<string>(), Array.Empty<string>(),
new Dictionary<string, string> new Dictionary<string, string> { ["ENV_FOO"] = $"bar{Path.PathSeparator}baz" }
{
["ENV_FOO"] = "bar"
}
); );
var stdOut = FakeConsole.ReadOutputString();
// Assert // Assert
exitCode.Should().Be(0); exitCode.Should().Be(0);
stdOut.Trim().Should().Be("bar");
}
[Fact]
public async Task Option_does_not_fall_back_to_an_environment_variable_if_a_value_is_provided_through_arguments()
{
// Arrange
var commandType = DynamicCommandBuilder.Compile(
// language=cs
@"
[Command]
public class Command : ICommand
{
[CommandOption(""foo"", EnvironmentVariable = ""ENV_FOO"")]
public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console)
{
console.Output.WriteLine(Foo);
return default;
}
}
");
var application = new CliApplicationBuilder()
.AddCommand(commandType)
.UseConsole(FakeConsole)
.Build();
// Act
var exitCode = await application.RunAsync(
new[] {"--foo", "baz"},
new Dictionary<string, string>
{
["ENV_FOO"] = "bar"
}
);
var stdOut = FakeConsole.ReadOutputString(); var stdOut = FakeConsole.ReadOutputString();
stdOut.Should().ConsistOfLines("bar", "baz");
// Assert
exitCode.Should().Be(0);
stdOut.Trim().Should().Be("baz");
} }
[Fact] [Fact]
public async Task Option_of_non_scalar_type_can_receive_multiple_values_from_an_environment_variable() public async Task I_can_configure_an_option_bound_to_a_scalar_property_to_fall_back_to_an_environment_variable_while_ignoring_path_separators()
{ {
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // lang=csharp
@" """
[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 string? Foo { get; init; }
public ValueTask ExecuteAsync(IConsole console) public ValueTask ExecuteAsync(IConsole console)
{ {
foreach (var i in Foo) console.WriteLine(Foo);
console.Output.WriteLine(i); return default;
}
return default; }
} """
} );
");
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -134,123 +131,26 @@ public class Command : ICommand
// Act // Act
var exitCode = await application.RunAsync( var exitCode = await application.RunAsync(
Array.Empty<string>(), Array.Empty<string>(),
new Dictionary<string, string> new Dictionary<string, string> { ["ENV_FOO"] = $"bar{Path.PathSeparator}baz" }
{
["ENV_FOO"] = $"bar{Path.PathSeparator}baz"
}
); );
var stdOut = FakeConsole.ReadOutputString();
// Assert // Assert
exitCode.Should().Be(0); exitCode.Should().Be(0);
stdOut.Should().ConsistOfLines(
"bar",
"baz"
);
}
[Fact]
public async Task Option_of_scalar_type_always_receives_a_single_value_from_an_environment_variable()
{
// Arrange
var commandType = DynamicCommandBuilder.Compile(
// language=cs
@"
[Command]
public class Command : ICommand
{
[CommandOption(""foo"", EnvironmentVariable = ""ENV_FOO"")]
public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console)
{
console.Output.WriteLine(Foo);
return default;
}
}
");
var application = new CliApplicationBuilder()
.AddCommand(commandType)
.UseConsole(FakeConsole)
.Build();
// Act
var exitCode = await application.RunAsync(
Array.Empty<string>(),
new Dictionary<string, string>
{
["ENV_FOO"] = $"bar{Path.PathSeparator}baz"
}
);
var stdOut = FakeConsole.ReadOutputString(); var stdOut = FakeConsole.ReadOutputString();
// Assert
exitCode.Should().Be(0);
stdOut.Trim().Should().Be($"bar{Path.PathSeparator}baz"); stdOut.Trim().Should().Be($"bar{Path.PathSeparator}baz");
} }
[Fact] [Fact(Timeout = 15000)]
public async Task Environment_variables_are_matched_case_sensitively() public async Task I_can_run_the_application_and_it_will_resolve_all_required_environment_variables_automatically()
{
// Arrange
var commandType = DynamicCommandBuilder.Compile(
// language=cs
@"
[Command]
public class Command : ICommand
{
[CommandOption(""foo"", EnvironmentVariable = ""ENV_FOO"")]
public string Foo { get; set; }
public ValueTask ExecuteAsync(IConsole console)
{
console.Output.WriteLine(Foo);
return default;
}
}
");
var application = new CliApplicationBuilder()
.AddCommand(commandType)
.UseConsole(FakeConsole)
.Build();
// Act
var exitCode = await application.RunAsync(
Array.Empty<string>(),
new Dictionary<string, string>
{
["ENV_foo"] = "baz",
["ENV_FOO"] = "bar",
["env_FOO"] = "qop"
}
);
var stdOut = FakeConsole.ReadOutputString();
// Assert
exitCode.Should().Be(0);
stdOut.Trim().Should().Be("bar");
}
[Fact]
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
// System.Environment when they are not provided explicitly to CliApplication. // System.Environment when they are not provided explicitly to CliApplication.
// Arrange // Arrange
var command = Cli.Wrap("dotnet") var command = Cli.Wrap(Dummy.Program.FilePath)
.WithArguments(a => a .WithArguments("env-test")
.Add(Dummy.Program.Location) .WithEnvironmentVariables(e => e.Set("ENV_TARGET", "Mars"));
.Add("env-test")
)
.WithEnvironmentVariables(e => e
.Set("ENV_TARGET", "Mars")
);
// Act // Act
var result = await command.ExecuteBufferedAsync(); var result = await command.ExecuteBufferedAsync();
@@ -258,4 +158,4 @@ public class Command : ICommand
// Assert // Assert
result.StandardOutput.Trim().Should().Be("Hello Mars!"); result.StandardOutput.Trim().Should().Be("Hello Mars!");
} }
} }

View File

@@ -9,27 +9,23 @@ using Xunit.Abstractions;
namespace CliFx.Tests; namespace CliFx.Tests;
public class ErrorReportingSpecs : SpecsBase public class ErrorReportingSpecs(ITestOutputHelper testOutput) : SpecsBase(testOutput)
{ {
public ErrorReportingSpecs(ITestOutputHelper testOutput)
: base(testOutput)
{
}
[Fact] [Fact]
public async Task Command_can_throw_an_exception_which_exits_with_a_stacktrace() public async Task I_can_throw_an_exception_in_a_command_to_report_an_error_with_a_stacktrace()
{ {
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // lang=csharp
@" """
[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)
@@ -42,32 +38,33 @@ public class Command : ICommand
new Dictionary<string, string>() new Dictionary<string, string>()
); );
var stdOut = FakeConsole.ReadOutputString();
var stdErr = FakeConsole.ReadErrorString();
// Assert // Assert
exitCode.Should().NotBe(0); exitCode.Should().NotBe(0);
var stdOut = FakeConsole.ReadOutputString();
stdOut.Should().BeEmpty(); stdOut.Should().BeEmpty();
stdErr.Should().ContainAllInOrder(
"System.Exception", "Something went wrong", var stdErr = FakeConsole.ReadErrorString();
"at", "CliFx." stdErr
); .Should()
.ContainAllInOrder("System.Exception", "Something went wrong", "at", "CliFx.");
} }
[Fact] [Fact]
public async Task Command_can_throw_an_exception_with_an_inner_exception_which_exits_with_a_stacktrace() public async Task I_can_throw_an_exception_with_an_inner_exception_in_a_command_to_report_an_error_with_a_stacktrace()
{ {
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // lang=csharp
@" """
[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)
@@ -80,33 +77,40 @@ public class Command : ICommand
new Dictionary<string, string>() new Dictionary<string, string>()
); );
var stdOut = FakeConsole.ReadOutputString();
var stdErr = FakeConsole.ReadErrorString();
// Assert // Assert
exitCode.Should().NotBe(0); exitCode.Should().NotBe(0);
var stdOut = FakeConsole.ReadOutputString();
stdOut.Should().BeEmpty(); stdOut.Should().BeEmpty();
stdErr.Should().ContainAllInOrder(
"System.Exception", "Something went wrong", var stdErr = FakeConsole.ReadErrorString();
"System.Exception", "Another exception", stdErr
"at", "CliFx." .Should()
); .ContainAllInOrder(
"System.Exception",
"Something went wrong",
"System.Exception",
"Another exception",
"at",
"CliFx."
);
} }
[Fact] [Fact]
public async Task Command_can_throw_a_special_exception_which_exits_with_specified_code_and_message() public async Task I_can_throw_an_exception_in_a_command_to_report_an_error_and_exit_with_the_specified_code()
{ {
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // lang=csharp
@" """
[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)
@@ -119,29 +123,31 @@ public class Command : ICommand
new Dictionary<string, string>() new Dictionary<string, string>()
); );
var stdOut = FakeConsole.ReadOutputString();
var stdErr = FakeConsole.ReadErrorString();
// Assert // Assert
exitCode.Should().Be(69); exitCode.Should().Be(69);
var stdOut = FakeConsole.ReadOutputString();
stdOut.Should().BeEmpty(); stdOut.Should().BeEmpty();
var stdErr = FakeConsole.ReadErrorString();
stdErr.Trim().Should().Be("Something went wrong"); stdErr.Trim().Should().Be("Something went wrong");
} }
[Fact] [Fact]
public async Task Command_can_throw_a_special_exception_without_message_which_exits_with_a_stacktrace() public async Task I_can_throw_an_exception_without_a_message_in_a_command_to_report_an_error_with_a_stacktrace()
{ {
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // lang=csharp
@" """
[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)
@@ -154,32 +160,31 @@ public class Command : ICommand
new Dictionary<string, string>() new Dictionary<string, string>()
); );
var stdOut = FakeConsole.ReadOutputString();
var stdErr = FakeConsole.ReadErrorString();
// Assert // Assert
exitCode.Should().Be(69); exitCode.Should().Be(69);
var stdOut = FakeConsole.ReadOutputString();
stdOut.Should().BeEmpty(); stdOut.Should().BeEmpty();
stdErr.Should().ContainAllInOrder(
"CliFx.Exceptions.CommandException", var stdErr = FakeConsole.ReadErrorString();
"at", "CliFx." stdErr.Should().ContainAllInOrder("CliFx.Exceptions.CommandException", "at", "CliFx.");
);
} }
[Fact] [Fact]
public async Task Command_can_throw_a_special_exception_which_prints_help_text_before_exiting() public async Task I_can_throw_an_exception_in_a_command_to_report_an_error_and_print_the_help_text()
{ {
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // lang=csharp
@" """
[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)
@@ -193,12 +198,13 @@ public class Command : ICommand
new Dictionary<string, string>() new Dictionary<string, string>()
); );
var stdOut = FakeConsole.ReadOutputString();
var stdErr = FakeConsole.ReadErrorString();
// Assert // Assert
exitCode.Should().Be(69); exitCode.Should().Be(69);
var stdOut = FakeConsole.ReadOutputString();
stdOut.Should().Contain("This will be in help text"); stdOut.Should().Contain("This will be in help text");
var stdErr = FakeConsole.ReadErrorString();
stdErr.Trim().Should().Be("Something went wrong"); stdErr.Trim().Should().Be("Something went wrong");
} }
} }

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@@ -8,37 +8,34 @@ using Xunit.Abstractions;
namespace CliFx.Tests; namespace CliFx.Tests;
public class ParameterBindingSpecs : SpecsBase public class ParameterBindingSpecs(ITestOutputHelper testOutput) : SpecsBase(testOutput)
{ {
public ParameterBindingSpecs(ITestOutputHelper testOutput)
: base(testOutput)
{
}
[Fact] [Fact]
public async Task Parameter_is_bound_from_an_argument_matching_its_order() public async Task I_can_bind_a_parameter_to_a_property_and_get_the_value_from_the_corresponding_argument()
{ {
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // lang=csharp
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandParameter(0)] [CommandParameter(0)]
public string Foo { get; set; } public required string Foo { get; init; }
[CommandParameter(1)] [CommandParameter(1)]
public string Bar { get; set; } public required string Bar { get; init; }
public ValueTask ExecuteAsync(IConsole console) public ValueTask ExecuteAsync(IConsole console)
{ {
console.Output.WriteLine(""Foo = "" + Foo); console.WriteLine("Foo = " + Foo);
console.Output.WriteLine(""Bar = "" + Bar); console.WriteLine("Bar = " + Bar);
return default; return default;
} }
}"); }
"""
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -46,54 +43,50 @@ public class Command : ICommand
.Build(); .Build();
// Act // Act
var exitCode = await application.RunAsync( var exitCode = await application.RunAsync(["one", "two"], new Dictionary<string, string>());
new[] {"one", "two"},
new Dictionary<string, string>()
);
var stdOut = FakeConsole.ReadOutputString();
// Assert // Assert
exitCode.Should().Be(0); exitCode.Should().Be(0);
stdOut.Should().ConsistOfLines(
"Foo = one", var stdOut = FakeConsole.ReadOutputString();
"Bar = two" stdOut.Should().ConsistOfLines("Foo = one", "Bar = two");
);
} }
[Fact] [Fact]
public async Task Parameter_of_non_scalar_type_is_bound_from_remaining_non_option_arguments() public async Task I_can_bind_a_parameter_to_a_non_scalar_property_and_get_values_from_the_remaining_non_option_arguments()
{ {
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // lang=csharp
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandParameter(0)] [CommandParameter(0)]
public string Foo { get; set; } public required string Foo { get; init; }
[CommandParameter(1)] [CommandParameter(1)]
public string Bar { get; set; } public required string Bar { get; init; }
[CommandParameter(2)] [CommandParameter(2)]
public IReadOnlyList<string> Baz { get; set; } public required IReadOnlyList<string> Baz { get; init; }
[CommandOption(""boo"")] [CommandOption("boo")]
public string Boo { get; set; } public string? Boo { get; init; }
public ValueTask ExecuteAsync(IConsole console) public ValueTask ExecuteAsync(IConsole console)
{ {
console.Output.WriteLine(""Foo = "" + Foo); console.WriteLine("Foo = " + Foo);
console.Output.WriteLine(""Bar = "" + Bar); console.WriteLine("Bar = " + Bar);
foreach (var i in Baz) foreach (var i in Baz)
console.Output.WriteLine(""Baz = "" + i); console.WriteLine("Baz = " + i);
return default; return default;
} }
}"); }
"""
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -102,87 +95,39 @@ public class Command : ICommand
// Act // Act
var exitCode = await application.RunAsync( var exitCode = await application.RunAsync(
new[] {"one", "two", "three", "four", "five", "--boo", "xxx"}, ["one", "two", "three", "four", "five", "--boo", "xxx"],
new Dictionary<string, string>() new Dictionary<string, string>()
); );
var stdOut = FakeConsole.ReadOutputString();
// Assert // Assert
exitCode.Should().Be(0); exitCode.Should().Be(0);
stdOut.Should().ConsistOfLines(
"Foo = one",
"Bar = two",
"Baz = three",
"Baz = four",
"Baz = five"
);
}
[Fact]
public async Task Parameter_is_not_bound_if_there_are_no_arguments_matching_its_order()
{
// Arrange
var commandType = DynamicCommandBuilder.Compile(
// language=cs
@"
[Command]
public class Command : ICommand
{
[CommandParameter(0)]
public string Foo { get; set; }
[CommandParameter(1, IsRequired = false)]
public string Bar { get; set; } = ""xyz"";
public ValueTask ExecuteAsync(IConsole console)
{
console.Output.WriteLine(""Foo = "" + Foo);
console.Output.WriteLine(""Bar = "" + Bar);
return default;
}
}");
var application = new CliApplicationBuilder()
.AddCommand(commandType)
.UseConsole(FakeConsole)
.Build();
// Act
var exitCode = await application.RunAsync(
new[] {"abc"},
new Dictionary<string, string>()
);
var stdOut = FakeConsole.ReadOutputString(); var stdOut = FakeConsole.ReadOutputString();
stdOut
// Assert .Should()
exitCode.Should().Be(0); .ConsistOfLines("Foo = one", "Bar = two", "Baz = three", "Baz = four", "Baz = five");
stdOut.Should().ConsistOfLines(
"Foo = abc",
"Bar = xyz"
);
} }
[Fact] [Fact]
public async Task Parameter_binding_fails_if_a_required_parameter_has_not_been_provided() public async Task I_can_try_to_bind_a_parameter_to_a_property_and_get_an_error_if_the_user_does_not_provide_the_corresponding_argument()
{ {
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // lang=csharp
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandParameter(0)] [CommandParameter(0)]
public string Foo { get; set; } public required string Foo { get; init; }
[CommandParameter(1)] [CommandParameter(1)]
public string Bar { get; set; } public required string Bar { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"); }
"""
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -190,36 +135,35 @@ public class Command : ICommand
.Build(); .Build();
// Act // Act
var exitCode = await application.RunAsync( var exitCode = await application.RunAsync(["one"], new Dictionary<string, string>());
new[] {"one"},
new Dictionary<string, string>()
);
var stdErr = FakeConsole.ReadErrorString();
// Assert // Assert
exitCode.Should().NotBe(0); exitCode.Should().NotBe(0);
var stdErr = FakeConsole.ReadErrorString();
stdErr.Should().Contain("Missing required parameter(s)"); stdErr.Should().Contain("Missing required parameter(s)");
} }
[Fact] [Fact]
public async Task Parameter_binding_fails_if_a_parameter_of_non_scalar_type_has_not_been_provided_with_at_least_one_value() public async Task I_can_try_to_bind_a_parameter_to_a_non_scalar_property_and_get_an_error_if_the_user_does_not_provide_at_least_one_corresponding_argument()
{ {
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // lang=csharp
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandParameter(0)] [CommandParameter(0)]
public string Foo { get; set; } public required string Foo { get; init; }
[CommandParameter(1)] [CommandParameter(1)]
public IReadOnlyList<string> Bar { get; set; } public required IReadOnlyList<string> Bar { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console) => default;
}"); }
"""
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -227,36 +171,77 @@ public class Command : ICommand
.Build(); .Build();
// Act // Act
var exitCode = await application.RunAsync( var exitCode = await application.RunAsync(["one"], new Dictionary<string, string>());
new[] {"one"},
new Dictionary<string, string>()
);
var stdErr = FakeConsole.ReadErrorString();
// Assert // Assert
exitCode.Should().NotBe(0); exitCode.Should().NotBe(0);
var stdErr = FakeConsole.ReadErrorString();
stdErr.Should().Contain("Missing required parameter(s)"); stdErr.Should().Contain("Missing required parameter(s)");
} }
[Fact] [Fact]
public async Task Parameter_binding_fails_if_one_of_the_provided_parameters_is_unexpected() public async Task I_can_bind_a_non_required_parameter_to_a_property_and_get_no_value_if_the_user_does_not_provide_the_corresponding_argument()
{ {
// Arrange // Arrange
var commandType = DynamicCommandBuilder.Compile( var commandType = DynamicCommandBuilder.Compile(
// language=cs // lang=csharp
@" """
[Command] [Command]
public class Command : ICommand public class Command : ICommand
{ {
[CommandParameter(0)] [CommandParameter(0)]
public string Foo { get; set; } public required string Foo { get; init; }
[CommandParameter(1)] [CommandParameter(1, IsRequired = false)]
public string Bar { get; set; } public string? Bar { get; init; } = "xyz";
public ValueTask ExecuteAsync(IConsole console) => default; public ValueTask ExecuteAsync(IConsole console)
}"); {
console.WriteLine("Foo = " + Foo);
console.WriteLine("Bar = " + Bar);
return default;
}
}
"""
);
var application = new CliApplicationBuilder()
.AddCommand(commandType)
.UseConsole(FakeConsole)
.Build();
// Act
var exitCode = await application.RunAsync(["abc"], new Dictionary<string, string>());
// Assert
exitCode.Should().Be(0);
var stdOut = FakeConsole.ReadOutputString();
stdOut.Should().ConsistOfLines("Foo = abc", "Bar = xyz");
}
[Fact]
public async Task I_can_try_to_bind_parameters_and_get_an_error_if_the_user_provides_too_many_arguments()
{
// Arrange
var commandType = DynamicCommandBuilder.Compile(
// lang=csharp
"""
[Command]
public class Command : ICommand
{
[CommandParameter(0)]
public required string Foo { get; init; }
[CommandParameter(1)]
public required string Bar { get; init; }
public ValueTask ExecuteAsync(IConsole console) => default;
}
"""
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommand(commandType) .AddCommand(commandType)
@@ -265,14 +250,14 @@ public class Command : ICommand
// Act // Act
var exitCode = await application.RunAsync( var exitCode = await application.RunAsync(
new[] {"one", "two", "three"}, ["one", "two", "three"],
new Dictionary<string, string>() new Dictionary<string, string>()
); );
var stdErr = FakeConsole.ReadErrorString();
// Assert // Assert
exitCode.Should().NotBe(0); exitCode.Should().NotBe(0);
var stdErr = FakeConsole.ReadErrorString();
stdErr.Should().Contain("Unexpected parameter(s)"); stdErr.Should().Contain("Unexpected parameter(s)");
} }
} }

View File

@@ -8,50 +8,46 @@ using Xunit.Abstractions;
namespace CliFx.Tests; namespace CliFx.Tests;
public class RoutingSpecs : SpecsBase public class RoutingSpecs(ITestOutputHelper testOutput) : SpecsBase(testOutput)
{ {
public RoutingSpecs(ITestOutputHelper testOutput)
: base(testOutput)
{
}
[Fact] [Fact]
public async Task Default_command_is_executed_if_provided_arguments_do_not_match_any_named_command() public async Task I_can_configure_a_command_to_be_executed_by_default_when_the_user_does_not_specify_a_command_name()
{ {
// Arrange // Arrange
var commandTypes = DynamicCommandBuilder.CompileMany( var commandTypes = DynamicCommandBuilder.CompileMany(
// language=cs // lang=csharp
@" """
[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.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.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.WriteLine("cmd child");
return default; return default;
} }
} }
"); """
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommands(commandTypes) .AddCommands(commandTypes)
@@ -64,50 +60,51 @@ public class NamedChildCommand : ICommand
new Dictionary<string, string>() new Dictionary<string, string>()
); );
var stdOut = FakeConsole.ReadOutputString();
// Assert // Assert
exitCode.Should().Be(0); exitCode.Should().Be(0);
var stdOut = FakeConsole.ReadOutputString();
stdOut.Trim().Should().Be("default"); stdOut.Trim().Should().Be("default");
} }
[Fact] [Fact]
public async Task Specific_named_command_is_executed_if_provided_arguments_match_its_name() public async Task I_can_configure_a_command_to_be_executed_when_the_user_specifies_its_name()
{ {
// Arrange // Arrange
var commandTypes = DynamicCommandBuilder.CompileMany( var commandTypes = DynamicCommandBuilder.CompileMany(
// language=cs // lang=csharp
@" """
[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.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.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.WriteLine("cmd child");
return default; return default;
} }
} }
"); """
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommands(commandTypes) .AddCommands(commandTypes)
@@ -115,55 +112,53 @@ public class NamedChildCommand : ICommand
.Build(); .Build();
// Act // Act
var exitCode = await application.RunAsync( var exitCode = await application.RunAsync(["cmd"], new Dictionary<string, string>());
new[] {"cmd"},
new Dictionary<string, string>()
);
var stdOut = FakeConsole.ReadOutputString();
// Assert // Assert
exitCode.Should().Be(0); exitCode.Should().Be(0);
var stdOut = FakeConsole.ReadOutputString();
stdOut.Trim().Should().Be("cmd"); stdOut.Trim().Should().Be("cmd");
} }
[Fact] [Fact]
public async Task Specific_named_child_command_is_executed_if_provided_arguments_match_its_name() public async Task I_can_configure_a_nested_command_to_be_executed_when_the_user_specifies_its_name()
{ {
// Arrange // Arrange
var commandTypes = DynamicCommandBuilder.CompileMany( var commandTypes = DynamicCommandBuilder.CompileMany(
// language=cs // lang=csharp
@" """
[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.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.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.WriteLine("cmd child");
return default; return default;
} }
} }
"); """
);
var application = new CliApplicationBuilder() var application = new CliApplicationBuilder()
.AddCommands(commandTypes) .AddCommands(commandTypes)
@@ -172,14 +167,14 @@ public class NamedChildCommand : ICommand
// Act // Act
var exitCode = await application.RunAsync( var exitCode = await application.RunAsync(
new[] {"cmd", "child"}, ["cmd", "child"],
new Dictionary<string, string>() new Dictionary<string, string>()
); );
var stdOut = FakeConsole.ReadOutputString();
// Assert // Assert
exitCode.Should().Be(0); exitCode.Should().Be(0);
var stdOut = FakeConsole.ReadOutputString();
stdOut.Trim().Should().Be("cmd child"); stdOut.Trim().Should().Be("cmd child");
} }
} }

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