mirror of
https://github.com/Tyrrrz/CliFx.git
synced 2025-10-25 15:19:17 +00:00
Compare commits
334 Commits
1.4
...
25083eff44
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
25083eff44 | ||
|
|
7f2c00fe3a | ||
|
|
7638b997ff | ||
|
|
d80d012938 | ||
|
|
2a02d39dba | ||
|
|
c40b4f3501 | ||
|
|
3fb2a2319b | ||
|
|
1a5a0374c7 | ||
|
|
432c8a66af | ||
|
|
078ddeaf07 | ||
|
|
0fa2ebc636 | ||
|
|
c79a8c6502 | ||
|
|
cfbd8f9e76 | ||
|
|
e329f0fc78 | ||
|
|
357426c536 | ||
|
|
bc2164499b | ||
|
|
20481d4e24 | ||
|
|
2cb9335e25 | ||
|
|
f5ff6193e8 | ||
|
|
36b2b07a1d | ||
|
|
73bf19d766 | ||
|
|
093b6767c4 | ||
|
|
e4671e50bb | ||
|
|
40beb283d5 | ||
|
|
71fe231f28 | ||
|
|
8546c54c23 | ||
|
|
0fc88a42ba | ||
|
|
cb8f4b122e | ||
|
|
540f307f42 | ||
|
|
a62ce71424 | ||
|
|
ab48098e06 | ||
|
|
0532d724a1 | ||
|
|
545c7c3fbd | ||
|
|
a813436577 | ||
|
|
fcc93603a7 | ||
|
|
2d3c221b48 | ||
|
|
651146c97b | ||
|
|
82b0c6fd98 | ||
|
|
a4376c955b | ||
|
|
f7645afbdb | ||
|
|
e20672328b | ||
|
|
e99a95ef7c | ||
|
|
3e7eb08eca | ||
|
|
cfd28c133e | ||
|
|
034d3cec66 | ||
|
|
3fc7054f80 | ||
|
|
2323a57c39 | ||
|
|
bcb34055ac | ||
|
|
24fd87b1e1 | ||
|
|
fe935b5775 | ||
|
|
7dcd523bfe | ||
|
|
cad1c14474 | ||
|
|
57db910489 | ||
|
|
ae9c4e6d1e | ||
|
|
30bc1d3330 | ||
|
|
a5a4ad05a0 | ||
|
|
0b77895ca5 | ||
|
|
54994755b1 | ||
|
|
aee63cb9f2 | ||
|
|
4bdd3ccc6c | ||
|
|
6aa72e45e8 | ||
|
|
76e8d47e03 | ||
|
|
6304b8ab9c | ||
|
|
98b50d0e8e | ||
|
|
5aea869c2a | ||
|
|
425c8f4022 | ||
|
|
490398f773 | ||
|
|
5854f36756 | ||
|
|
ec6c72e6a3 | ||
|
|
41bc64be4a | ||
|
|
7df0e77e4d | ||
|
|
914e8e17cd | ||
|
|
40f106d0b0 | ||
|
|
566dd4a9a7 | ||
|
|
9beb439323 | ||
|
|
029257a915 | ||
|
|
d330fbbb63 | ||
|
|
236867f547 | ||
|
|
b41e9b4929 | ||
|
|
ff06b8896f | ||
|
|
0fe9c89fa0 | ||
|
|
8646c9de5e | ||
|
|
a33c42a163 | ||
|
|
55cea48cbd | ||
|
|
e67eda3515 | ||
|
|
4412c20e97 | ||
|
|
9eb84c6649 | ||
|
|
2ef37ab6d9 | ||
|
|
38a73772fc | ||
|
|
aed53eb090 | ||
|
|
21b601da66 | ||
|
|
a4726fcefd | ||
|
|
ab24ca8604 | ||
|
|
3533bff344 | ||
|
|
1b096b679e | ||
|
|
cb61b31e9d | ||
|
|
d8f183c404 | ||
|
|
c95b6c32d5 | ||
|
|
d2e390c691 | ||
|
|
66ef221586 | ||
|
|
2d3bb30125 | ||
|
|
5d72692aa5 | ||
|
|
3be17db784 | ||
|
|
4aef8ce8fb | ||
|
|
8c1cff3bb7 | ||
|
|
669d8bfe20 | ||
|
|
4dce7bddb4 | ||
|
|
a621e89e89 | ||
|
|
5ea11e3a23 | ||
|
|
7cb61182d2 | ||
|
|
99c59431c4 | ||
|
|
f376081489 | ||
|
|
00a1e12b5c | ||
|
|
81f8b17451 | ||
|
|
aa8315b68d | ||
|
|
e52781c25a | ||
|
|
01f29a5375 | ||
|
|
013cb8f66b | ||
|
|
9c715f458e | ||
|
|
90d93a57ee | ||
|
|
8da4a61eb7 | ||
|
|
f718370642 | ||
|
|
83c7af72bf | ||
|
|
eff84fd7ae | ||
|
|
f66fa97b87 | ||
|
|
9f309b5d4a | ||
|
|
456099591a | ||
|
|
bf7f607f9b | ||
|
|
a4041ab019 | ||
|
|
a0fde872ec | ||
|
|
f0c040c7b9 | ||
|
|
a09818d452 | ||
|
|
1c331df4b1 | ||
|
|
dc20fe9730 | ||
|
|
31ae0271b9 | ||
|
|
6ed6d2ced9 | ||
|
|
01a4846159 | ||
|
|
02dc7de127 | ||
|
|
a1ff1a1539 | ||
|
|
a02951f755 | ||
|
|
7cb25254e8 | ||
|
|
3d9ad16117 | ||
|
|
d0ad3bc45d | ||
|
|
6541ce568d | ||
|
|
32d3b66185 | ||
|
|
48f157a51e | ||
|
|
b1995fa4f7 | ||
|
|
74bc973f77 | ||
|
|
3420c3d039 | ||
|
|
b10577fec5 | ||
|
|
af96d0d31d | ||
|
|
bd29ad31cc | ||
|
|
15150cb3ed | ||
|
|
aac9c968eb | ||
|
|
85a9f157ad | ||
|
|
d24a79361d | ||
|
|
5785720f31 | ||
|
|
3f6f0b9f1b | ||
|
|
128bb5be8b | ||
|
|
36b3814f4e | ||
|
|
c4a975d5f1 | ||
|
|
79d86d39c1 | ||
|
|
c476700168 | ||
|
|
5e97ebe7f0 | ||
|
|
64cbdaaeab | ||
|
|
ae1f03914c | ||
|
|
ff25dccf8a | ||
|
|
6e0d881682 | ||
|
|
89fd42888a | ||
|
|
eeac82a6e7 | ||
|
|
c641c6fbe2 | ||
|
|
5ec732fe9a | ||
|
|
6d87411dbf | ||
|
|
ed3054c855 | ||
|
|
5d00de4dfe | ||
|
|
016ec8b186 | ||
|
|
9141092919 | ||
|
|
1fe97b0140 | ||
|
|
6ad5989c25 | ||
|
|
7e1db916fc | ||
|
|
1c69d5c80d | ||
|
|
ab87225f1f | ||
|
|
6d33c5cdad | ||
|
|
e4c899c6c2 | ||
|
|
35b3ad0d63 | ||
|
|
4e70557b47 | ||
|
|
0a8d58255a | ||
|
|
d3fbc9c643 | ||
|
|
1cbf8776be | ||
|
|
16e33f7b8f | ||
|
|
5c848056c5 | ||
|
|
864efd3179 | ||
|
|
7f206a0c77 | ||
|
|
22c15f8ec6 | ||
|
|
59373eadc2 | ||
|
|
ed3e4f471e | ||
|
|
41cb8647b5 | ||
|
|
c7015181e1 | ||
|
|
86742755e8 | ||
|
|
33f95d941d | ||
|
|
1328592cb5 | ||
|
|
0711b863ea | ||
|
|
a2f5cd54be | ||
|
|
7836ec610f | ||
|
|
2e489927eb | ||
|
|
02e8d19e48 | ||
|
|
eb7107fb0a | ||
|
|
a396009b62 | ||
|
|
1d9c7e942c | ||
|
|
0f3abb9db4 | ||
|
|
896482821c | ||
|
|
aa3094ee54 | ||
|
|
712580e3d7 | ||
|
|
c08102f85f | ||
|
|
5e684c8b36 | ||
|
|
300ae70564 | ||
|
|
76f0c77f1e | ||
|
|
0f7cea4ed1 | ||
|
|
32ee0b2bd6 | ||
|
|
4ff1e1d3e1 | ||
|
|
8e96d2701d | ||
|
|
8e307df231 | ||
|
|
ff38f4916a | ||
|
|
7cbbb220b4 | ||
|
|
ae2d4299f0 | ||
|
|
21bc69d116 | ||
|
|
05a70175cc | ||
|
|
33ec2eb3a0 | ||
|
|
f6ef6cd4c0 | ||
|
|
a9ef693dc1 | ||
|
|
98bbd666dc | ||
|
|
4e7ed830f8 | ||
|
|
ef87ff76fc | ||
|
|
2feeb21270 | ||
|
|
9990387cfa | ||
|
|
bc1bdca7c6 | ||
|
|
2a992d37df | ||
|
|
15c87aecbb | ||
|
|
10a46451ac | ||
|
|
e4c6a4174b | ||
|
|
4c65f7bbee | ||
|
|
5f21de0df5 | ||
|
|
9b01b67d98 | ||
|
|
4508f5e211 | ||
|
|
f0cbc46df4 | ||
|
|
6c96e9e173 | ||
|
|
51cca36d2a | ||
|
|
84672c92f6 | ||
|
|
b1d01898b6 | ||
|
|
441a47a1a8 | ||
|
|
8abd7219a1 | ||
|
|
df73a0bfe8 | ||
|
|
55d12dc721 | ||
|
|
a6ee44c1bb | ||
|
|
76816e22f1 | ||
|
|
daf25e59d6 | ||
|
|
f2b4e53615 | ||
|
|
2d519ab190 | ||
|
|
2d479c9cb6 | ||
|
|
2bb7e13e51 | ||
|
|
6e1dfdcdd4 | ||
|
|
5ba647e5c1 | ||
|
|
853492695f | ||
|
|
d5d72c7c50 | ||
|
|
d676b5832e | ||
|
|
28097afc1e | ||
|
|
fda96586f3 | ||
|
|
fc5af8dbbc | ||
|
|
4835e64388 | ||
|
|
0999c33f93 | ||
|
|
595805255a | ||
|
|
65eaa912cf | ||
|
|
038f48b78e | ||
|
|
d7460244b7 | ||
|
|
02766868fc | ||
|
|
8d7d25a144 | ||
|
|
17ded54e24 | ||
|
|
54a4c32ddf | ||
|
|
6d46e82145 | ||
|
|
fd4a2a18fe | ||
|
|
bfe99d620e | ||
|
|
c5a111207f | ||
|
|
544945c0e6 | ||
|
|
c616cdd750 | ||
|
|
d3c396956d | ||
|
|
d0cbbc6d9a | ||
|
|
49c7905150 | ||
|
|
f5a992a16e | ||
|
|
bade0a0048 | ||
|
|
7d3d79b861 | ||
|
|
58df63a7ad | ||
|
|
b938eef013 | ||
|
|
94f63631db | ||
|
|
90d1b11430 | ||
|
|
550e54b86d | ||
|
|
90a01e729b | ||
|
|
ac01c2aecb | ||
|
|
4acffe925c | ||
|
|
18f53eeeef | ||
|
|
03d6942540 | ||
|
|
9be811a89a | ||
|
|
f9f5a4696b | ||
|
|
d6da687170 | ||
|
|
eba66d0878 | ||
|
|
8c682766bd | ||
|
|
39d626c8d8 | ||
|
|
a338ac8ce2 | ||
|
|
11637127cb | ||
|
|
4e12aefafb | ||
|
|
144d3592fb | ||
|
|
6f82c2f0f9 | ||
|
|
b8c60717d5 | ||
|
|
fec6850c39 | ||
|
|
6a378ad946 | ||
|
|
11579f11b1 | ||
|
|
60a3b26fd1 | ||
|
|
3abdfb1acf | ||
|
|
9557d386e2 | ||
|
|
d0d024c427 | ||
|
|
f765af6061 | ||
|
|
7f2202e869 | ||
|
|
14ad9d5738 | ||
|
|
b120138de3 | ||
|
|
8df1d607c1 | ||
|
|
c06f2810b9 | ||
|
|
d52a205f13 | ||
|
|
0ec12e57c1 | ||
|
|
c322b7029c | ||
|
|
6a38c04c11 | ||
|
|
5e53107def | ||
|
|
36cea937de | ||
|
|
438d6b98ac | ||
|
|
8e1488c395 | ||
|
|
65d321b476 |
BIN
.assets/help-screen.png
Normal file
BIN
.assets/help-screen.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 14 KiB |
63
.gitattributes
vendored
63
.gitattributes
vendored
@@ -1,63 +0,0 @@
|
|||||||
###############################################################################
|
|
||||||
# Set default behavior to automatically normalize line endings.
|
|
||||||
###############################################################################
|
|
||||||
* text=auto
|
|
||||||
|
|
||||||
###############################################################################
|
|
||||||
# Set default behavior for command prompt diff.
|
|
||||||
#
|
|
||||||
# This is need for earlier builds of msysgit that does not have it on by
|
|
||||||
# default for csharp files.
|
|
||||||
# Note: This is only used by command line
|
|
||||||
###############################################################################
|
|
||||||
#*.cs diff=csharp
|
|
||||||
|
|
||||||
###############################################################################
|
|
||||||
# Set the merge driver for project and solution files
|
|
||||||
#
|
|
||||||
# Merging from the command prompt will add diff markers to the files if there
|
|
||||||
# are conflicts (Merging from VS is not affected by the settings below, in VS
|
|
||||||
# the diff markers are never inserted). Diff markers may cause the following
|
|
||||||
# file extensions to fail to load in VS. An alternative would be to treat
|
|
||||||
# these files as binary and thus will always conflict and require user
|
|
||||||
# intervention with every merge. To do so, just uncomment the entries below
|
|
||||||
###############################################################################
|
|
||||||
#*.sln merge=binary
|
|
||||||
#*.csproj merge=binary
|
|
||||||
#*.vbproj merge=binary
|
|
||||||
#*.vcxproj merge=binary
|
|
||||||
#*.vcproj merge=binary
|
|
||||||
#*.dbproj merge=binary
|
|
||||||
#*.fsproj merge=binary
|
|
||||||
#*.lsproj merge=binary
|
|
||||||
#*.wixproj merge=binary
|
|
||||||
#*.modelproj merge=binary
|
|
||||||
#*.sqlproj merge=binary
|
|
||||||
#*.wwaproj merge=binary
|
|
||||||
|
|
||||||
###############################################################################
|
|
||||||
# behavior for image files
|
|
||||||
#
|
|
||||||
# image files are treated as binary by default.
|
|
||||||
###############################################################################
|
|
||||||
#*.jpg binary
|
|
||||||
#*.png binary
|
|
||||||
#*.gif binary
|
|
||||||
|
|
||||||
###############################################################################
|
|
||||||
# diff behavior for common document formats
|
|
||||||
#
|
|
||||||
# Convert binary document formats to text before diffing them. This feature
|
|
||||||
# is only available from the command line. Turn it on by uncommenting the
|
|
||||||
# entries below.
|
|
||||||
###############################################################################
|
|
||||||
#*.doc diff=astextplain
|
|
||||||
#*.DOC diff=astextplain
|
|
||||||
#*.docx diff=astextplain
|
|
||||||
#*.DOCX diff=astextplain
|
|
||||||
#*.dot diff=astextplain
|
|
||||||
#*.DOT diff=astextplain
|
|
||||||
#*.pdf diff=astextplain
|
|
||||||
#*.PDF diff=astextplain
|
|
||||||
#*.rtf diff=astextplain
|
|
||||||
#*.RTF diff=astextplain
|
|
||||||
3
.github/FUNDING.yml
vendored
3
.github/FUNDING.yml
vendored
@@ -1,3 +0,0 @@
|
|||||||
github: Tyrrrz
|
|
||||||
patreon: Tyrrrz
|
|
||||||
custom: ['buymeacoffee.com/Tyrrrz', 'tyrrrz.me/donate']
|
|
||||||
77
.github/ISSUE_TEMPLATE/bug-report.yml
vendored
Normal file
77
.github/ISSUE_TEMPLATE/bug-report.yml
vendored
Normal file
@@ -0,0 +1,77 @@
|
|||||||
|
name: 🐛 Bug report
|
||||||
|
description: Report broken functionality.
|
||||||
|
labels: [bug]
|
||||||
|
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
- 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**.
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
- type: input
|
||||||
|
attributes:
|
||||||
|
label: Version
|
||||||
|
description: Which version of the package does this bug affect? Make sure you're not using an outdated version.
|
||||||
|
placeholder: v1.0.0
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: input
|
||||||
|
attributes:
|
||||||
|
label: Platform
|
||||||
|
description: Which platform do you experience this bug on?
|
||||||
|
placeholder: .NET 7.0 / Windows 11
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Steps to reproduce
|
||||||
|
description: >
|
||||||
|
Minimum steps required to reproduce the bug, including prerequisites, code snippets, or other relevant items.
|
||||||
|
The information provided in this field must be readily actionable, meaning that anyone should be able to reproduce the bug by following these steps.
|
||||||
|
If the reproduction steps are too complex to fit in this field, please provide a link to a repository instead.
|
||||||
|
placeholder: |
|
||||||
|
- Step 1
|
||||||
|
- 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.
|
||||||
11
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
11
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
blank_issues_enabled: false
|
||||||
|
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
|
||||||
|
url: https://discord.gg/2SUWKFnHSm
|
||||||
|
about: Chat with the project community.
|
||||||
22
.github/dependabot.yml
vendored
Normal file
22
.github/dependabot.yml
vendored
Normal 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:
|
||||||
|
- "*"
|
||||||
25
.github/workflows/CD.yml
vendored
25
.github/workflows/CD.yml
vendored
@@ -1,25 +0,0 @@
|
|||||||
name: CD
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
tags:
|
|
||||||
- '*'
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
build:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- name: Checkout
|
|
||||||
uses: actions/checkout@v2
|
|
||||||
|
|
||||||
- name: Install .NET Core
|
|
||||||
uses: actions/setup-dotnet@v1.4.0
|
|
||||||
with:
|
|
||||||
dotnet-version: 3.1.100
|
|
||||||
|
|
||||||
- name: Pack
|
|
||||||
run: dotnet pack CliFx --configuration Release
|
|
||||||
|
|
||||||
- name: Deploy
|
|
||||||
run: dotnet nuget push CliFx/bin/Release/*.nupkg -s nuget.org -k ${{ secrets.NUGET_TOKEN }}
|
|
||||||
35
.github/workflows/CI.yml
vendored
35
.github/workflows/CI.yml
vendored
@@ -1,35 +0,0 @@
|
|||||||
name: CI
|
|
||||||
|
|
||||||
on: [push, pull_request]
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
build:
|
|
||||||
runs-on: ${{ matrix.os }}
|
|
||||||
|
|
||||||
strategy:
|
|
||||||
matrix:
|
|
||||||
os: [ubuntu-latest, windows-latest, macos-latest]
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- name: Checkout
|
|
||||||
uses: actions/checkout@v2
|
|
||||||
|
|
||||||
- name: Install .NET Core
|
|
||||||
uses: actions/setup-dotnet@v1.4.0
|
|
||||||
with:
|
|
||||||
dotnet-version: 3.1.100
|
|
||||||
|
|
||||||
- name: Build & test
|
|
||||||
run: dotnet test --configuration Release --logger GitHubActions
|
|
||||||
|
|
||||||
- name: Upload coverage
|
|
||||||
uses: codecov/codecov-action@v1.0.5
|
|
||||||
with:
|
|
||||||
token: ${{ secrets.CODECOV_TOKEN }}
|
|
||||||
file: CliFx.Tests/bin/Release/Coverage.xml
|
|
||||||
|
|
||||||
- name: Upload coverage (analyzers)
|
|
||||||
uses: codecov/codecov-action@v1.0.5
|
|
||||||
with:
|
|
||||||
token: ${{ secrets.CODECOV_TOKEN }}
|
|
||||||
file: CliFx.Analyzers.Tests/bin/Release/Coverage.xml
|
|
||||||
34
.github/workflows/main.yml
vendored
Normal file
34
.github/workflows/main.yml
vendored
Normal file
@@ -0,0 +1,34 @@
|
|||||||
|
name: main
|
||||||
|
|
||||||
|
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:
|
||||||
|
main:
|
||||||
|
uses: Tyrrrz/.github/.github/workflows/nuget.yml@master
|
||||||
|
with:
|
||||||
|
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:
|
||||||
|
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
|
||||||
|
NUGET_TOKEN: ${{ secrets.NUGET_TOKEN }}
|
||||||
|
DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
|
||||||
341
.gitignore
vendored
341
.gitignore
vendored
@@ -1,341 +1,12 @@
|
|||||||
## Ignore Visual Studio temporary files, build results, and
|
|
||||||
## files generated by popular Visual Studio add-ons.
|
|
||||||
##
|
|
||||||
## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore
|
|
||||||
|
|
||||||
# User-specific files
|
# User-specific files
|
||||||
*.rsuser
|
.vs/
|
||||||
|
.idea/
|
||||||
*.suo
|
*.suo
|
||||||
*.user
|
*.user
|
||||||
*.userosscache
|
|
||||||
*.sln.docstates
|
|
||||||
|
|
||||||
# User-specific files (MonoDevelop/Xamarin Studio)
|
|
||||||
*.userprefs
|
|
||||||
|
|
||||||
# Build results
|
# Build results
|
||||||
[Dd]ebug/
|
bin/
|
||||||
[Dd]ebugPublic/
|
obj/
|
||||||
[Rr]elease/
|
|
||||||
[Rr]eleases/
|
|
||||||
x64/
|
|
||||||
x86/
|
|
||||||
[Aa][Rr][Mm]/
|
|
||||||
[Aa][Rr][Mm]64/
|
|
||||||
bld/
|
|
||||||
[Bb]in/
|
|
||||||
[Oo]bj/
|
|
||||||
[Ll]og/
|
|
||||||
|
|
||||||
# Visual Studio 2015/2017 cache/options directory
|
# Test results
|
||||||
.vs/
|
TestResults/
|
||||||
# Uncomment if you have tasks that create the project's static files in wwwroot
|
|
||||||
#wwwroot/
|
|
||||||
|
|
||||||
# Visual Studio 2017 auto generated files
|
|
||||||
Generated\ Files/
|
|
||||||
|
|
||||||
# MSTest test Results
|
|
||||||
[Tt]est[Rr]esult*/
|
|
||||||
[Bb]uild[Ll]og.*
|
|
||||||
|
|
||||||
# NUNIT
|
|
||||||
*.VisualState.xml
|
|
||||||
TestResult.xml
|
|
||||||
|
|
||||||
# Build Results of an ATL Project
|
|
||||||
[Dd]ebugPS/
|
|
||||||
[Rr]eleasePS/
|
|
||||||
dlldata.c
|
|
||||||
|
|
||||||
# Benchmark Results
|
|
||||||
BenchmarkDotNet.Artifacts/
|
|
||||||
|
|
||||||
# .NET Core
|
|
||||||
project.lock.json
|
|
||||||
project.fragment.lock.json
|
|
||||||
artifacts/
|
|
||||||
|
|
||||||
# StyleCop
|
|
||||||
StyleCopReport.xml
|
|
||||||
|
|
||||||
# Files built by Visual Studio
|
|
||||||
*_i.c
|
|
||||||
*_p.c
|
|
||||||
*_h.h
|
|
||||||
*.ilk
|
|
||||||
*.meta
|
|
||||||
*.obj
|
|
||||||
*.iobj
|
|
||||||
*.pch
|
|
||||||
*.pdb
|
|
||||||
*.ipdb
|
|
||||||
*.pgc
|
|
||||||
*.pgd
|
|
||||||
*.rsp
|
|
||||||
*.sbr
|
|
||||||
*.tlb
|
|
||||||
*.tli
|
|
||||||
*.tlh
|
|
||||||
*.tmp
|
|
||||||
*.tmp_proj
|
|
||||||
*_wpftmp.csproj
|
|
||||||
*.log
|
|
||||||
*.vspscc
|
|
||||||
*.vssscc
|
|
||||||
.builds
|
|
||||||
*.pidb
|
|
||||||
*.svclog
|
|
||||||
*.scc
|
|
||||||
|
|
||||||
# Chutzpah Test files
|
|
||||||
_Chutzpah*
|
|
||||||
|
|
||||||
# Visual C++ cache files
|
|
||||||
ipch/
|
|
||||||
*.aps
|
|
||||||
*.ncb
|
|
||||||
*.opendb
|
|
||||||
*.opensdf
|
|
||||||
*.sdf
|
|
||||||
*.cachefile
|
|
||||||
*.VC.db
|
|
||||||
*.VC.VC.opendb
|
|
||||||
|
|
||||||
# Visual Studio profiler
|
|
||||||
*.psess
|
|
||||||
*.vsp
|
|
||||||
*.vspx
|
|
||||||
*.sap
|
|
||||||
|
|
||||||
# Visual Studio Trace Files
|
|
||||||
*.e2e
|
|
||||||
|
|
||||||
# TFS 2012 Local Workspace
|
|
||||||
$tf/
|
|
||||||
|
|
||||||
# Guidance Automation Toolkit
|
|
||||||
*.gpState
|
|
||||||
|
|
||||||
# ReSharper is a .NET coding add-in
|
|
||||||
_ReSharper*/
|
|
||||||
*.[Rr]e[Ss]harper
|
|
||||||
*.DotSettings.user
|
|
||||||
|
|
||||||
# JustCode is a .NET coding add-in
|
|
||||||
.JustCode
|
|
||||||
|
|
||||||
# TeamCity is a build add-in
|
|
||||||
_TeamCity*
|
|
||||||
|
|
||||||
# DotCover is a Code Coverage Tool
|
|
||||||
*.dotCover
|
|
||||||
|
|
||||||
# AxoCover is a Code Coverage Tool
|
|
||||||
.axoCover/*
|
|
||||||
!.axoCover/settings.json
|
|
||||||
|
|
||||||
# Visual Studio code coverage results
|
|
||||||
*.coverage
|
|
||||||
*.coveragexml
|
|
||||||
|
|
||||||
# NCrunch
|
|
||||||
_NCrunch_*
|
|
||||||
.*crunch*.local.xml
|
|
||||||
nCrunchTemp_*
|
|
||||||
.ncrunchsolution
|
|
||||||
|
|
||||||
# MightyMoose
|
|
||||||
*.mm.*
|
|
||||||
AutoTest.Net/
|
|
||||||
|
|
||||||
# Web workbench (sass)
|
|
||||||
.sass-cache/
|
|
||||||
|
|
||||||
# Installshield output folder
|
|
||||||
[Ee]xpress/
|
|
||||||
|
|
||||||
# DocProject is a documentation generator add-in
|
|
||||||
DocProject/buildhelp/
|
|
||||||
DocProject/Help/*.HxT
|
|
||||||
DocProject/Help/*.HxC
|
|
||||||
DocProject/Help/*.hhc
|
|
||||||
DocProject/Help/*.hhk
|
|
||||||
DocProject/Help/*.hhp
|
|
||||||
DocProject/Help/Html2
|
|
||||||
DocProject/Help/html
|
|
||||||
|
|
||||||
# Click-Once directory
|
|
||||||
publish/
|
|
||||||
|
|
||||||
# Publish Web Output
|
|
||||||
*.[Pp]ublish.xml
|
|
||||||
*.azurePubxml
|
|
||||||
# Note: Comment the next line if you want to checkin your web deploy settings,
|
|
||||||
# but database connection strings (with potential passwords) will be unencrypted
|
|
||||||
*.pubxml
|
|
||||||
*.publishproj
|
|
||||||
|
|
||||||
# Microsoft Azure Web App publish settings. Comment the next line if you want to
|
|
||||||
# checkin your Azure Web App publish settings, but sensitive information contained
|
|
||||||
# in these scripts will be unencrypted
|
|
||||||
PublishScripts/
|
|
||||||
|
|
||||||
# NuGet Packages
|
|
||||||
*.nupkg
|
|
||||||
# The packages folder can be ignored because of Package Restore
|
|
||||||
**/[Pp]ackages/*
|
|
||||||
# except build/, which is used as an MSBuild target.
|
|
||||||
!**/[Pp]ackages/build/
|
|
||||||
# Uncomment if necessary however generally it will be regenerated when needed
|
|
||||||
#!**/[Pp]ackages/repositories.config
|
|
||||||
# NuGet v3's project.json files produces more ignorable files
|
|
||||||
*.nuget.props
|
|
||||||
*.nuget.targets
|
|
||||||
|
|
||||||
# Microsoft Azure Build Output
|
|
||||||
csx/
|
|
||||||
*.build.csdef
|
|
||||||
|
|
||||||
# Microsoft Azure Emulator
|
|
||||||
ecf/
|
|
||||||
rcf/
|
|
||||||
|
|
||||||
# Windows Store app package directories and files
|
|
||||||
AppPackages/
|
|
||||||
BundleArtifacts/
|
|
||||||
Package.StoreAssociation.xml
|
|
||||||
_pkginfo.txt
|
|
||||||
*.appx
|
|
||||||
|
|
||||||
# Visual Studio cache files
|
|
||||||
# files ending in .cache can be ignored
|
|
||||||
*.[Cc]ache
|
|
||||||
# but keep track of directories ending in .cache
|
|
||||||
!?*.[Cc]ache/
|
|
||||||
|
|
||||||
# Others
|
|
||||||
ClientBin/
|
|
||||||
~$*
|
|
||||||
*~
|
|
||||||
*.dbmdl
|
|
||||||
*.dbproj.schemaview
|
|
||||||
*.jfm
|
|
||||||
*.pfx
|
|
||||||
*.publishsettings
|
|
||||||
orleans.codegen.cs
|
|
||||||
|
|
||||||
# Including strong name files can present a security risk
|
|
||||||
# (https://github.com/github/gitignore/pull/2483#issue-259490424)
|
|
||||||
#*.snk
|
|
||||||
|
|
||||||
# Since there are multiple workflows, uncomment next line to ignore bower_components
|
|
||||||
# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622)
|
|
||||||
#bower_components/
|
|
||||||
|
|
||||||
# RIA/Silverlight projects
|
|
||||||
Generated_Code/
|
|
||||||
|
|
||||||
# Backup & report files from converting an old project file
|
|
||||||
# to a newer Visual Studio version. Backup files are not needed,
|
|
||||||
# because we have git ;-)
|
|
||||||
_UpgradeReport_Files/
|
|
||||||
Backup*/
|
|
||||||
UpgradeLog*.XML
|
|
||||||
UpgradeLog*.htm
|
|
||||||
ServiceFabricBackup/
|
|
||||||
*.rptproj.bak
|
|
||||||
|
|
||||||
# SQL Server files
|
|
||||||
*.mdf
|
|
||||||
*.ldf
|
|
||||||
*.ndf
|
|
||||||
|
|
||||||
# Business Intelligence projects
|
|
||||||
*.rdl.data
|
|
||||||
*.bim.layout
|
|
||||||
*.bim_*.settings
|
|
||||||
*.rptproj.rsuser
|
|
||||||
*- Backup*.rdl
|
|
||||||
|
|
||||||
# Microsoft Fakes
|
|
||||||
FakesAssemblies/
|
|
||||||
|
|
||||||
# GhostDoc plugin setting file
|
|
||||||
*.GhostDoc.xml
|
|
||||||
|
|
||||||
# Node.js Tools for Visual Studio
|
|
||||||
.ntvs_analysis.dat
|
|
||||||
node_modules/
|
|
||||||
|
|
||||||
# Visual Studio 6 build log
|
|
||||||
*.plg
|
|
||||||
|
|
||||||
# Visual Studio 6 workspace options file
|
|
||||||
*.opt
|
|
||||||
|
|
||||||
# Visual Studio 6 auto-generated workspace file (contains which files were open etc.)
|
|
||||||
*.vbw
|
|
||||||
|
|
||||||
# Visual Studio LightSwitch build output
|
|
||||||
**/*.HTMLClient/GeneratedArtifacts
|
|
||||||
**/*.DesktopClient/GeneratedArtifacts
|
|
||||||
**/*.DesktopClient/ModelManifest.xml
|
|
||||||
**/*.Server/GeneratedArtifacts
|
|
||||||
**/*.Server/ModelManifest.xml
|
|
||||||
_Pvt_Extensions
|
|
||||||
|
|
||||||
# Paket dependency manager
|
|
||||||
.paket/paket.exe
|
|
||||||
paket-files/
|
|
||||||
|
|
||||||
# FAKE - F# Make
|
|
||||||
.fake/
|
|
||||||
|
|
||||||
# JetBrains Rider
|
|
||||||
.idea/
|
|
||||||
*.sln.iml
|
|
||||||
|
|
||||||
# CodeRush personal settings
|
|
||||||
.cr/personal
|
|
||||||
|
|
||||||
# Python Tools for Visual Studio (PTVS)
|
|
||||||
__pycache__/
|
|
||||||
*.pyc
|
|
||||||
|
|
||||||
# Cake - Uncomment if you are using it
|
|
||||||
# tools/**
|
|
||||||
# !tools/packages.config
|
|
||||||
|
|
||||||
# Tabs Studio
|
|
||||||
*.tss
|
|
||||||
|
|
||||||
# Telerik's JustMock configuration file
|
|
||||||
*.jmconfig
|
|
||||||
|
|
||||||
# BizTalk build output
|
|
||||||
*.btp.cs
|
|
||||||
*.btm.cs
|
|
||||||
*.odx.cs
|
|
||||||
*.xsd.cs
|
|
||||||
|
|
||||||
# OpenCover UI analysis results
|
|
||||||
OpenCover/
|
|
||||||
|
|
||||||
# Azure Stream Analytics local run output
|
|
||||||
ASALocalRun/
|
|
||||||
|
|
||||||
# MSBuild Binary and Structured Log
|
|
||||||
*.binlog
|
|
||||||
|
|
||||||
# NVidia Nsight GPU debugger configuration file
|
|
||||||
*.nvuser
|
|
||||||
|
|
||||||
# MFractors (Xamarin productivity tool) working folder
|
|
||||||
.mfractor/
|
|
||||||
|
|
||||||
# Local History for Visual Studio
|
|
||||||
.localhistory/
|
|
||||||
|
|
||||||
# BeatPulse healthcheck temp database
|
|
||||||
healthchecksdb
|
|
||||||
Binary file not shown.
|
Before Width: | Height: | Size: 24 KiB |
39
Changelog.md
39
Changelog.md
@@ -1,39 +0,0 @@
|
|||||||
### 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.
|
|
||||||
@@ -1,43 +0,0 @@
|
|||||||
using System.Collections.Generic;
|
|
||||||
using System.Linq;
|
|
||||||
using Microsoft.CodeAnalysis;
|
|
||||||
|
|
||||||
namespace CliFx.Analyzers.Tests
|
|
||||||
{
|
|
||||||
public class AnalyzerTestCase
|
|
||||||
{
|
|
||||||
public string Name { get; }
|
|
||||||
|
|
||||||
public IReadOnlyList<DiagnosticDescriptor> TestedDiagnostics { get; }
|
|
||||||
|
|
||||||
public IReadOnlyList<string> SourceCodes { get; }
|
|
||||||
|
|
||||||
public AnalyzerTestCase(
|
|
||||||
string name,
|
|
||||||
IReadOnlyList<DiagnosticDescriptor> testedDiagnostics,
|
|
||||||
IReadOnlyList<string> sourceCodes)
|
|
||||||
{
|
|
||||||
Name = name;
|
|
||||||
TestedDiagnostics = testedDiagnostics;
|
|
||||||
SourceCodes = sourceCodes;
|
|
||||||
}
|
|
||||||
|
|
||||||
public AnalyzerTestCase(
|
|
||||||
string name,
|
|
||||||
IReadOnlyList<DiagnosticDescriptor> testedDiagnostics,
|
|
||||||
string sourceCode)
|
|
||||||
: this(name, testedDiagnostics, new[] {sourceCode})
|
|
||||||
{
|
|
||||||
}
|
|
||||||
|
|
||||||
public AnalyzerTestCase(
|
|
||||||
string name,
|
|
||||||
DiagnosticDescriptor testedDiagnostic,
|
|
||||||
string sourceCode)
|
|
||||||
: this(name, new[] {testedDiagnostic}, sourceCode)
|
|
||||||
{
|
|
||||||
}
|
|
||||||
|
|
||||||
public override string ToString() => $"{Name} [{string.Join(", ", TestedDiagnostics.Select(d => d.Id))}]";
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,29 +0,0 @@
|
|||||||
<Project Sdk="Microsoft.NET.Sdk">
|
|
||||||
<Import Project="../CliFx.props" />
|
|
||||||
|
|
||||||
<PropertyGroup>
|
|
||||||
<TargetFramework>netcoreapp3.1</TargetFramework>
|
|
||||||
<IsPackable>false</IsPackable>
|
|
||||||
<IsTestProject>true</IsTestProject>
|
|
||||||
<CollectCoverage>true</CollectCoverage>
|
|
||||||
<CoverletOutputFormat>opencover</CoverletOutputFormat>
|
|
||||||
<CoverletOutput>bin/$(Configuration)/Coverage.xml</CoverletOutput>
|
|
||||||
</PropertyGroup>
|
|
||||||
|
|
||||||
<ItemGroup>
|
|
||||||
<PackageReference Include="Gu.Roslyn.Asserts" Version="3.3.0" />
|
|
||||||
<PackageReference Include="GitHubActionsTestLogger" Version="1.0.0" />
|
|
||||||
<PackageReference Include="FluentAssertions" Version="5.10.2" />
|
|
||||||
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.2.0" />
|
|
||||||
<PackageReference Include="xunit" Version="2.4.0" />
|
|
||||||
<PackageReference Include="xunit.runner.visualstudio" Version="2.4.0" />
|
|
||||||
<PackageReference Include="Microsoft.CodeAnalysis.CSharp.Workspaces" Version="3.4.0" />
|
|
||||||
<PackageReference Include="coverlet.msbuild" Version="2.8.0" PrivateAssets="all" />
|
|
||||||
</ItemGroup>
|
|
||||||
|
|
||||||
<ItemGroup>
|
|
||||||
<ProjectReference Include="..\CliFx.Analyzers\CliFx.Analyzers.csproj" />
|
|
||||||
<ProjectReference Include="..\CliFx\CliFx.csproj" />
|
|
||||||
</ItemGroup>
|
|
||||||
|
|
||||||
</Project>
|
|
||||||
@@ -1,489 +0,0 @@
|
|||||||
using System.Collections.Generic;
|
|
||||||
using CliFx.Analyzers.Tests.Internal;
|
|
||||||
using Microsoft.CodeAnalysis.Diagnostics;
|
|
||||||
using Xunit;
|
|
||||||
|
|
||||||
namespace CliFx.Analyzers.Tests
|
|
||||||
{
|
|
||||||
public class CommandSchemaAnalyzerTests
|
|
||||||
{
|
|
||||||
private static DiagnosticAnalyzer Analyzer { get; } = new CommandSchemaAnalyzer();
|
|
||||||
|
|
||||||
public static IEnumerable<object[]> GetValidCases()
|
|
||||||
{
|
|
||||||
yield return new object[]
|
|
||||||
{
|
|
||||||
new AnalyzerTestCase(
|
|
||||||
"Non-command type",
|
|
||||||
Analyzer.SupportedDiagnostics,
|
|
||||||
|
|
||||||
// language=cs
|
|
||||||
@"
|
|
||||||
public class Foo
|
|
||||||
{
|
|
||||||
public int Bar { get; set; } = 5;
|
|
||||||
}"
|
|
||||||
)
|
|
||||||
};
|
|
||||||
|
|
||||||
yield return new object[]
|
|
||||||
{
|
|
||||||
new AnalyzerTestCase(
|
|
||||||
"Command implements interface and has attribute",
|
|
||||||
Analyzer.SupportedDiagnostics,
|
|
||||||
|
|
||||||
// language=cs
|
|
||||||
@"
|
|
||||||
[Command]
|
|
||||||
public class MyCommand : ICommand
|
|
||||||
{
|
|
||||||
public ValueTask ExecuteAsync(IConsole console) => default;
|
|
||||||
}"
|
|
||||||
)
|
|
||||||
};
|
|
||||||
|
|
||||||
yield return new object[]
|
|
||||||
{
|
|
||||||
new AnalyzerTestCase(
|
|
||||||
"Command doesn't have an attribute but is an abstract type",
|
|
||||||
Analyzer.SupportedDiagnostics,
|
|
||||||
|
|
||||||
// language=cs
|
|
||||||
@"
|
|
||||||
public abstract class MyCommand : ICommand
|
|
||||||
{
|
|
||||||
public ValueTask ExecuteAsync(IConsole console) => default;
|
|
||||||
}"
|
|
||||||
)
|
|
||||||
};
|
|
||||||
|
|
||||||
yield return new object[]
|
|
||||||
{
|
|
||||||
new AnalyzerTestCase(
|
|
||||||
"Parameters with unique order",
|
|
||||||
Analyzer.SupportedDiagnostics,
|
|
||||||
|
|
||||||
// language=cs
|
|
||||||
@"
|
|
||||||
[Command]
|
|
||||||
public class MyCommand : ICommand
|
|
||||||
{
|
|
||||||
[CommandParameter(13)]
|
|
||||||
public string ParamA { get; set; }
|
|
||||||
|
|
||||||
[CommandParameter(15)]
|
|
||||||
public string ParamB { get; set; }
|
|
||||||
|
|
||||||
public ValueTask ExecuteAsync(IConsole console) => default;
|
|
||||||
}"
|
|
||||||
)
|
|
||||||
};
|
|
||||||
|
|
||||||
yield return new object[]
|
|
||||||
{
|
|
||||||
new AnalyzerTestCase(
|
|
||||||
"Parameters with unique names",
|
|
||||||
Analyzer.SupportedDiagnostics,
|
|
||||||
|
|
||||||
// language=cs
|
|
||||||
@"
|
|
||||||
[Command]
|
|
||||||
public class MyCommand : ICommand
|
|
||||||
{
|
|
||||||
[CommandParameter(13, Name = ""foo"")]
|
|
||||||
public string ParamA { get; set; }
|
|
||||||
|
|
||||||
[CommandParameter(15, Name = ""bar"")]
|
|
||||||
public string ParamB { get; set; }
|
|
||||||
|
|
||||||
public ValueTask ExecuteAsync(IConsole console) => default;
|
|
||||||
}"
|
|
||||||
)
|
|
||||||
};
|
|
||||||
|
|
||||||
yield return new object[]
|
|
||||||
{
|
|
||||||
new AnalyzerTestCase(
|
|
||||||
"Single non-scalar parameter",
|
|
||||||
Analyzer.SupportedDiagnostics,
|
|
||||||
|
|
||||||
// language=cs
|
|
||||||
@"
|
|
||||||
[Command]
|
|
||||||
public class MyCommand : ICommand
|
|
||||||
{
|
|
||||||
[CommandParameter(1)]
|
|
||||||
public string ParamA { get; set; }
|
|
||||||
|
|
||||||
[CommandParameter(2)]
|
|
||||||
public HashSet<string> ParamB { get; set; }
|
|
||||||
|
|
||||||
public ValueTask ExecuteAsync(IConsole console) => default;
|
|
||||||
}"
|
|
||||||
)
|
|
||||||
};
|
|
||||||
|
|
||||||
yield return new object[]
|
|
||||||
{
|
|
||||||
new AnalyzerTestCase(
|
|
||||||
"Non-scalar parameter is last in order",
|
|
||||||
Analyzer.SupportedDiagnostics,
|
|
||||||
|
|
||||||
// language=cs
|
|
||||||
@"
|
|
||||||
[Command]
|
|
||||||
public class MyCommand : ICommand
|
|
||||||
{
|
|
||||||
[CommandParameter(1)]
|
|
||||||
public string ParamA { get; set; }
|
|
||||||
|
|
||||||
[CommandParameter(2)]
|
|
||||||
public IReadOnlyList<string> ParamB { get; set; }
|
|
||||||
|
|
||||||
public ValueTask ExecuteAsync(IConsole console) => default;
|
|
||||||
}"
|
|
||||||
)
|
|
||||||
};
|
|
||||||
|
|
||||||
yield return new object[]
|
|
||||||
{
|
|
||||||
new AnalyzerTestCase(
|
|
||||||
"Option with a proper name",
|
|
||||||
Analyzer.SupportedDiagnostics,
|
|
||||||
|
|
||||||
// language=cs
|
|
||||||
@"
|
|
||||||
[Command]
|
|
||||||
public class MyCommand : ICommand
|
|
||||||
{
|
|
||||||
[CommandOption(""foo"")]
|
|
||||||
public string Param { get; set; }
|
|
||||||
|
|
||||||
public ValueTask ExecuteAsync(IConsole console) => default;
|
|
||||||
}"
|
|
||||||
)
|
|
||||||
};
|
|
||||||
|
|
||||||
yield return new object[]
|
|
||||||
{
|
|
||||||
new AnalyzerTestCase(
|
|
||||||
"Option with a proper name and short name",
|
|
||||||
Analyzer.SupportedDiagnostics,
|
|
||||||
|
|
||||||
// language=cs
|
|
||||||
@"
|
|
||||||
[Command]
|
|
||||||
public class MyCommand : ICommand
|
|
||||||
{
|
|
||||||
[CommandOption(""foo"", 'f')]
|
|
||||||
public string Param { get; set; }
|
|
||||||
|
|
||||||
public ValueTask ExecuteAsync(IConsole console) => default;
|
|
||||||
}"
|
|
||||||
)
|
|
||||||
};
|
|
||||||
|
|
||||||
yield return new object[]
|
|
||||||
{
|
|
||||||
new AnalyzerTestCase(
|
|
||||||
"Options with unique names",
|
|
||||||
Analyzer.SupportedDiagnostics,
|
|
||||||
|
|
||||||
// language=cs
|
|
||||||
@"
|
|
||||||
[Command]
|
|
||||||
public class MyCommand : ICommand
|
|
||||||
{
|
|
||||||
[CommandOption(""foo"")]
|
|
||||||
public string ParamA { get; set; }
|
|
||||||
|
|
||||||
[CommandOption(""bar"")]
|
|
||||||
public string ParamB { get; set; }
|
|
||||||
|
|
||||||
public ValueTask ExecuteAsync(IConsole console) => default;
|
|
||||||
}"
|
|
||||||
)
|
|
||||||
};
|
|
||||||
|
|
||||||
yield return new object[]
|
|
||||||
{
|
|
||||||
new AnalyzerTestCase(
|
|
||||||
"Options with unique short names",
|
|
||||||
Analyzer.SupportedDiagnostics,
|
|
||||||
|
|
||||||
// language=cs
|
|
||||||
@"
|
|
||||||
[Command]
|
|
||||||
public class MyCommand : ICommand
|
|
||||||
{
|
|
||||||
[CommandOption('f')]
|
|
||||||
public string ParamA { get; set; }
|
|
||||||
|
|
||||||
[CommandOption('x')]
|
|
||||||
public string ParamB { get; set; }
|
|
||||||
|
|
||||||
public ValueTask ExecuteAsync(IConsole console) => default;
|
|
||||||
}"
|
|
||||||
)
|
|
||||||
};
|
|
||||||
|
|
||||||
yield return new object[]
|
|
||||||
{
|
|
||||||
new AnalyzerTestCase(
|
|
||||||
"Options with unique environment variable names",
|
|
||||||
Analyzer.SupportedDiagnostics,
|
|
||||||
|
|
||||||
// language=cs
|
|
||||||
@"
|
|
||||||
[Command]
|
|
||||||
public class MyCommand : ICommand
|
|
||||||
{
|
|
||||||
[CommandOption('a', EnvironmentVariableName = ""env_var_a"")]
|
|
||||||
public string ParamA { get; set; }
|
|
||||||
|
|
||||||
[CommandOption('b', EnvironmentVariableName = ""env_var_b"")]
|
|
||||||
public string ParamB { get; set; }
|
|
||||||
|
|
||||||
public ValueTask ExecuteAsync(IConsole console) => default;
|
|
||||||
}"
|
|
||||||
)
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
public static IEnumerable<object[]> GetInvalidCases()
|
|
||||||
{
|
|
||||||
yield return new object[]
|
|
||||||
{
|
|
||||||
new AnalyzerTestCase(
|
|
||||||
"Command is missing the attribute",
|
|
||||||
DiagnosticDescriptors.CliFx0002,
|
|
||||||
|
|
||||||
// language=cs
|
|
||||||
@"
|
|
||||||
public class MyCommand : ICommand
|
|
||||||
{
|
|
||||||
public ValueTask ExecuteAsync(IConsole console) => default;
|
|
||||||
}"
|
|
||||||
)
|
|
||||||
};
|
|
||||||
|
|
||||||
yield return new object[]
|
|
||||||
{
|
|
||||||
new AnalyzerTestCase(
|
|
||||||
"Command doesn't implement the interface",
|
|
||||||
DiagnosticDescriptors.CliFx0001,
|
|
||||||
|
|
||||||
// language=cs
|
|
||||||
@"
|
|
||||||
[Command]
|
|
||||||
public class MyCommand
|
|
||||||
{
|
|
||||||
public ValueTask ExecuteAsync(IConsole console) => default;
|
|
||||||
}"
|
|
||||||
)
|
|
||||||
};
|
|
||||||
|
|
||||||
yield return new object[]
|
|
||||||
{
|
|
||||||
new AnalyzerTestCase(
|
|
||||||
"Parameters with duplicate order",
|
|
||||||
DiagnosticDescriptors.CliFx0021,
|
|
||||||
|
|
||||||
// language=cs
|
|
||||||
@"
|
|
||||||
[Command]
|
|
||||||
public class MyCommand : ICommand
|
|
||||||
{
|
|
||||||
[CommandParameter(13)]
|
|
||||||
public string ParamA { get; set; }
|
|
||||||
|
|
||||||
[CommandParameter(13)]
|
|
||||||
public string ParamB { get; set; }
|
|
||||||
|
|
||||||
public ValueTask ExecuteAsync(IConsole console) => default;
|
|
||||||
}"
|
|
||||||
)
|
|
||||||
};
|
|
||||||
|
|
||||||
yield return new object[]
|
|
||||||
{
|
|
||||||
new AnalyzerTestCase(
|
|
||||||
"Parameters with duplicate names",
|
|
||||||
DiagnosticDescriptors.CliFx0022,
|
|
||||||
|
|
||||||
// language=cs
|
|
||||||
@"
|
|
||||||
[Command]
|
|
||||||
public class MyCommand : ICommand
|
|
||||||
{
|
|
||||||
[CommandParameter(13, Name = ""foo"")]
|
|
||||||
public string ParamA { get; set; }
|
|
||||||
|
|
||||||
[CommandParameter(15, Name = ""foo"")]
|
|
||||||
public string ParamB { get; set; }
|
|
||||||
|
|
||||||
public ValueTask ExecuteAsync(IConsole console) => default;
|
|
||||||
}"
|
|
||||||
)
|
|
||||||
};
|
|
||||||
|
|
||||||
yield return new object[]
|
|
||||||
{
|
|
||||||
new AnalyzerTestCase(
|
|
||||||
"Multiple non-scalar parameters",
|
|
||||||
DiagnosticDescriptors.CliFx0023,
|
|
||||||
|
|
||||||
// language=cs
|
|
||||||
@"
|
|
||||||
[Command]
|
|
||||||
public class MyCommand : ICommand
|
|
||||||
{
|
|
||||||
[CommandParameter(1)]
|
|
||||||
public IReadOnlyList<string> ParamA { get; set; }
|
|
||||||
|
|
||||||
[CommandParameter(2)]
|
|
||||||
public HashSet<string> ParamB { get; set; }
|
|
||||||
|
|
||||||
public ValueTask ExecuteAsync(IConsole console) => default;
|
|
||||||
}"
|
|
||||||
)
|
|
||||||
};
|
|
||||||
|
|
||||||
yield return new object[]
|
|
||||||
{
|
|
||||||
new AnalyzerTestCase(
|
|
||||||
"Non-last non-scalar parameter",
|
|
||||||
DiagnosticDescriptors.CliFx0024,
|
|
||||||
|
|
||||||
// language=cs
|
|
||||||
@"
|
|
||||||
[Command]
|
|
||||||
public class MyCommand : ICommand
|
|
||||||
{
|
|
||||||
[CommandParameter(1)]
|
|
||||||
public IReadOnlyList<string> ParamA { get; set; }
|
|
||||||
|
|
||||||
[CommandParameter(2)]
|
|
||||||
public string ParamB { get; set; }
|
|
||||||
|
|
||||||
public ValueTask ExecuteAsync(IConsole console) => default;
|
|
||||||
}"
|
|
||||||
)
|
|
||||||
};
|
|
||||||
|
|
||||||
yield return new object[]
|
|
||||||
{
|
|
||||||
new AnalyzerTestCase(
|
|
||||||
"Option with an empty name",
|
|
||||||
DiagnosticDescriptors.CliFx0041,
|
|
||||||
|
|
||||||
// language=cs
|
|
||||||
@"
|
|
||||||
[Command]
|
|
||||||
public class MyCommand : ICommand
|
|
||||||
{
|
|
||||||
[CommandOption("""")]
|
|
||||||
public string Param { get; set; }
|
|
||||||
|
|
||||||
public ValueTask ExecuteAsync(IConsole console) => default;
|
|
||||||
}"
|
|
||||||
)
|
|
||||||
};
|
|
||||||
|
|
||||||
yield return new object[]
|
|
||||||
{
|
|
||||||
new AnalyzerTestCase(
|
|
||||||
"Option with a name which is too short",
|
|
||||||
DiagnosticDescriptors.CliFx0042,
|
|
||||||
|
|
||||||
// language=cs
|
|
||||||
@"
|
|
||||||
[Command]
|
|
||||||
public class MyCommand : ICommand
|
|
||||||
{
|
|
||||||
[CommandOption(""a"")]
|
|
||||||
public string Param { get; set; }
|
|
||||||
|
|
||||||
public ValueTask ExecuteAsync(IConsole console) => default;
|
|
||||||
}"
|
|
||||||
)
|
|
||||||
};
|
|
||||||
|
|
||||||
yield return new object[]
|
|
||||||
{
|
|
||||||
new AnalyzerTestCase(
|
|
||||||
"Options with duplicate names",
|
|
||||||
DiagnosticDescriptors.CliFx0043,
|
|
||||||
|
|
||||||
// language=cs
|
|
||||||
@"
|
|
||||||
[Command]
|
|
||||||
public class MyCommand : ICommand
|
|
||||||
{
|
|
||||||
[CommandOption(""foo"")]
|
|
||||||
public string ParamA { get; set; }
|
|
||||||
|
|
||||||
[CommandOption(""foo"")]
|
|
||||||
public string ParamB { get; set; }
|
|
||||||
|
|
||||||
public ValueTask ExecuteAsync(IConsole console) => default;
|
|
||||||
}"
|
|
||||||
)
|
|
||||||
};
|
|
||||||
|
|
||||||
yield return new object[]
|
|
||||||
{
|
|
||||||
new AnalyzerTestCase(
|
|
||||||
"Options with duplicate short names",
|
|
||||||
DiagnosticDescriptors.CliFx0044,
|
|
||||||
|
|
||||||
// language=cs
|
|
||||||
@"
|
|
||||||
[Command]
|
|
||||||
public class MyCommand : ICommand
|
|
||||||
{
|
|
||||||
[CommandOption('f')]
|
|
||||||
public string ParamA { get; set; }
|
|
||||||
|
|
||||||
[CommandOption('f')]
|
|
||||||
public string ParamB { get; set; }
|
|
||||||
|
|
||||||
public ValueTask ExecuteAsync(IConsole console) => default;
|
|
||||||
}"
|
|
||||||
)
|
|
||||||
};
|
|
||||||
|
|
||||||
yield return new object[]
|
|
||||||
{
|
|
||||||
new AnalyzerTestCase(
|
|
||||||
"Options with duplicate environment variable names",
|
|
||||||
DiagnosticDescriptors.CliFx0045,
|
|
||||||
|
|
||||||
// language=cs
|
|
||||||
@"
|
|
||||||
[Command]
|
|
||||||
public class MyCommand : ICommand
|
|
||||||
{
|
|
||||||
[CommandOption('a', EnvironmentVariableName = ""env_var"")]
|
|
||||||
public string ParamA { get; set; }
|
|
||||||
|
|
||||||
[CommandOption('b', EnvironmentVariableName = ""env_var"")]
|
|
||||||
public string ParamB { get; set; }
|
|
||||||
|
|
||||||
public ValueTask ExecuteAsync(IConsole console) => default;
|
|
||||||
}"
|
|
||||||
)
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
[Theory]
|
|
||||||
[MemberData(nameof(GetValidCases))]
|
|
||||||
public void Valid(AnalyzerTestCase testCase) =>
|
|
||||||
Analyzer.Should().NotProduceDiagnostics(testCase);
|
|
||||||
|
|
||||||
[Theory]
|
|
||||||
[MemberData(nameof(GetInvalidCases))]
|
|
||||||
public void Invalid(AnalyzerTestCase testCase) =>
|
|
||||||
Analyzer.Should().ProduceDiagnostics(testCase);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,144 +0,0 @@
|
|||||||
using System.Collections.Generic;
|
|
||||||
using CliFx.Analyzers.Tests.Internal;
|
|
||||||
using Microsoft.CodeAnalysis.Diagnostics;
|
|
||||||
using Xunit;
|
|
||||||
|
|
||||||
namespace CliFx.Analyzers.Tests
|
|
||||||
{
|
|
||||||
public class ConsoleUsageAnalyzerTests
|
|
||||||
{
|
|
||||||
private static DiagnosticAnalyzer Analyzer { get; } = new ConsoleUsageAnalyzer();
|
|
||||||
|
|
||||||
public static IEnumerable<object[]> GetValidCases()
|
|
||||||
{
|
|
||||||
yield return new object[]
|
|
||||||
{
|
|
||||||
new AnalyzerTestCase(
|
|
||||||
"Using console abstraction",
|
|
||||||
Analyzer.SupportedDiagnostics,
|
|
||||||
|
|
||||||
// language=cs
|
|
||||||
@"
|
|
||||||
[Command]
|
|
||||||
public class MyCommand : ICommand
|
|
||||||
{
|
|
||||||
public ValueTask ExecuteAsync(IConsole console)
|
|
||||||
{
|
|
||||||
console.Output.WriteLine(""Hello world"");
|
|
||||||
return default;
|
|
||||||
}
|
|
||||||
}"
|
|
||||||
)
|
|
||||||
};
|
|
||||||
|
|
||||||
yield return new object[]
|
|
||||||
{
|
|
||||||
new AnalyzerTestCase(
|
|
||||||
"Console abstraction is not available in scope",
|
|
||||||
Analyzer.SupportedDiagnostics,
|
|
||||||
|
|
||||||
// language=cs
|
|
||||||
@"
|
|
||||||
[Command]
|
|
||||||
public class MyCommand : ICommand
|
|
||||||
{
|
|
||||||
public void SomeOtherMethod() => Console.WriteLine(""Test"");
|
|
||||||
|
|
||||||
public ValueTask ExecuteAsync(IConsole console) => default;
|
|
||||||
}"
|
|
||||||
)
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
public static IEnumerable<object[]> GetInvalidCases()
|
|
||||||
{
|
|
||||||
yield return new object[]
|
|
||||||
{
|
|
||||||
new AnalyzerTestCase(
|
|
||||||
"Not using available console abstraction in the ExecuteAsync method",
|
|
||||||
Analyzer.SupportedDiagnostics,
|
|
||||||
|
|
||||||
// language=cs
|
|
||||||
@"
|
|
||||||
[Command]
|
|
||||||
public class MyCommand : ICommand
|
|
||||||
{
|
|
||||||
public ValueTask ExecuteAsync(IConsole console)
|
|
||||||
{
|
|
||||||
Console.WriteLine(""Hello world"");
|
|
||||||
return default;
|
|
||||||
}
|
|
||||||
}"
|
|
||||||
)
|
|
||||||
};
|
|
||||||
|
|
||||||
yield return new object[]
|
|
||||||
{
|
|
||||||
new AnalyzerTestCase(
|
|
||||||
"Not using available console abstraction in the ExecuteAsync method when writing stderr",
|
|
||||||
Analyzer.SupportedDiagnostics,
|
|
||||||
|
|
||||||
// language=cs
|
|
||||||
@"
|
|
||||||
[Command]
|
|
||||||
public class MyCommand : ICommand
|
|
||||||
{
|
|
||||||
public ValueTask ExecuteAsync(IConsole console)
|
|
||||||
{
|
|
||||||
Console.Error.WriteLine(""Hello world"");
|
|
||||||
return default;
|
|
||||||
}
|
|
||||||
}"
|
|
||||||
)
|
|
||||||
};
|
|
||||||
|
|
||||||
yield return new object[]
|
|
||||||
{
|
|
||||||
new AnalyzerTestCase(
|
|
||||||
"Not using available console abstraction while referencing System.Console by full name",
|
|
||||||
Analyzer.SupportedDiagnostics,
|
|
||||||
|
|
||||||
// language=cs
|
|
||||||
@"
|
|
||||||
[Command]
|
|
||||||
public class MyCommand : ICommand
|
|
||||||
{
|
|
||||||
public ValueTask ExecuteAsync(IConsole console)
|
|
||||||
{
|
|
||||||
System.Console.Error.WriteLine(""Hello world"");
|
|
||||||
return default;
|
|
||||||
}
|
|
||||||
}"
|
|
||||||
)
|
|
||||||
};
|
|
||||||
|
|
||||||
yield return new object[]
|
|
||||||
{
|
|
||||||
new AnalyzerTestCase(
|
|
||||||
"Not using available console abstraction in another method",
|
|
||||||
DiagnosticDescriptors.CliFx0100,
|
|
||||||
|
|
||||||
// language=cs
|
|
||||||
@"
|
|
||||||
[Command]
|
|
||||||
public class MyCommand : ICommand
|
|
||||||
{
|
|
||||||
public void SomeOtherMethod(IConsole console) => Console.WriteLine(""Test"");
|
|
||||||
|
|
||||||
public ValueTask ExecuteAsync(IConsole console) => default;
|
|
||||||
}"
|
|
||||||
)
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
[Theory]
|
|
||||||
[MemberData(nameof(GetValidCases))]
|
|
||||||
public void Valid(AnalyzerTestCase testCase) =>
|
|
||||||
Analyzer.Should().NotProduceDiagnostics(testCase);
|
|
||||||
|
|
||||||
[Theory]
|
|
||||||
[MemberData(nameof(GetInvalidCases))]
|
|
||||||
public void Invalid(AnalyzerTestCase testCase) =>
|
|
||||||
Analyzer.Should().ProduceDiagnostics(testCase);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,107 +0,0 @@
|
|||||||
using System;
|
|
||||||
using System.Collections.Generic;
|
|
||||||
using System.Linq;
|
|
||||||
using FluentAssertions.Execution;
|
|
||||||
using FluentAssertions.Primitives;
|
|
||||||
using Gu.Roslyn.Asserts;
|
|
||||||
using Microsoft.CodeAnalysis;
|
|
||||||
using Microsoft.CodeAnalysis.CSharp;
|
|
||||||
using Microsoft.CodeAnalysis.Diagnostics;
|
|
||||||
|
|
||||||
namespace CliFx.Analyzers.Tests.Internal
|
|
||||||
{
|
|
||||||
internal partial class AnalyzerAssertions : ReferenceTypeAssertions<DiagnosticAnalyzer, AnalyzerAssertions>
|
|
||||||
{
|
|
||||||
protected override string Identifier { get; } = "analyzer";
|
|
||||||
|
|
||||||
public AnalyzerAssertions(DiagnosticAnalyzer analyzer)
|
|
||||||
: base(analyzer)
|
|
||||||
{
|
|
||||||
}
|
|
||||||
|
|
||||||
public void ProduceDiagnostics(
|
|
||||||
IReadOnlyList<DiagnosticDescriptor> diagnostics,
|
|
||||||
IReadOnlyList<string> sourceCodes)
|
|
||||||
{
|
|
||||||
var producedDiagnostics = GetProducedDiagnostics(Subject, sourceCodes);
|
|
||||||
|
|
||||||
var expectedIds = diagnostics.Select(d => d.Id).Distinct().OrderBy(d => d).ToArray();
|
|
||||||
var producedIds = producedDiagnostics.Select(d => d.Id).Distinct().OrderBy(d => d).ToArray();
|
|
||||||
|
|
||||||
var result = expectedIds.Intersect(producedIds).Count() == expectedIds.Length;
|
|
||||||
|
|
||||||
Execute.Assertion.ForCondition(result).FailWith($@"
|
|
||||||
Expected and produced diagnostics do not match.
|
|
||||||
|
|
||||||
Expected: {string.Join(", ", expectedIds)}
|
|
||||||
Produced: {(producedIds.Any() ? string.Join(", ", producedIds) : "<none>")}
|
|
||||||
".Trim());
|
|
||||||
}
|
|
||||||
|
|
||||||
public void ProduceDiagnostics(AnalyzerTestCase testCase) =>
|
|
||||||
ProduceDiagnostics(testCase.TestedDiagnostics, testCase.SourceCodes);
|
|
||||||
|
|
||||||
public void NotProduceDiagnostics(
|
|
||||||
IReadOnlyList<DiagnosticDescriptor> diagnostics,
|
|
||||||
IReadOnlyList<string> sourceCodes)
|
|
||||||
{
|
|
||||||
var producedDiagnostics = GetProducedDiagnostics(Subject, sourceCodes);
|
|
||||||
|
|
||||||
var expectedIds = diagnostics.Select(d => d.Id).Distinct().OrderBy(d => d).ToArray();
|
|
||||||
var producedIds = producedDiagnostics.Select(d => d.Id).Distinct().OrderBy(d => d).ToArray();
|
|
||||||
|
|
||||||
var result = !expectedIds.Intersect(producedIds).Any();
|
|
||||||
|
|
||||||
Execute.Assertion.ForCondition(result).FailWith($@"
|
|
||||||
Expected no produced diagnostics.
|
|
||||||
|
|
||||||
Produced: {string.Join(", ", producedIds)}
|
|
||||||
".Trim());
|
|
||||||
}
|
|
||||||
|
|
||||||
public void NotProduceDiagnostics(AnalyzerTestCase testCase) =>
|
|
||||||
NotProduceDiagnostics(testCase.TestedDiagnostics, testCase.SourceCodes);
|
|
||||||
}
|
|
||||||
|
|
||||||
internal partial class AnalyzerAssertions
|
|
||||||
{
|
|
||||||
private static IReadOnlyList<MetadataReference> DefaultMetadataReferences { get; } =
|
|
||||||
MetadataReferences.Transitive(typeof(CliApplication).Assembly).ToArray();
|
|
||||||
|
|
||||||
private static string WrapCodeWithUsingDirectives(string code)
|
|
||||||
{
|
|
||||||
var usingDirectives = new[]
|
|
||||||
{
|
|
||||||
"using System;",
|
|
||||||
"using System.Collections.Generic;",
|
|
||||||
"using System.Threading.Tasks;",
|
|
||||||
"using CliFx;",
|
|
||||||
"using CliFx.Attributes;",
|
|
||||||
"using CliFx.Exceptions;",
|
|
||||||
"using CliFx.Utilities;"
|
|
||||||
};
|
|
||||||
|
|
||||||
return
|
|
||||||
string.Join(Environment.NewLine, usingDirectives) +
|
|
||||||
Environment.NewLine +
|
|
||||||
code;
|
|
||||||
}
|
|
||||||
|
|
||||||
private static IReadOnlyList<Diagnostic> GetProducedDiagnostics(
|
|
||||||
DiagnosticAnalyzer analyzer,
|
|
||||||
IReadOnlyList<string> sourceCodes)
|
|
||||||
{
|
|
||||||
var compilationOptions = new CSharpCompilationOptions(OutputKind.ConsoleApplication);
|
|
||||||
var wrappedSourceCodes = sourceCodes.Select(WrapCodeWithUsingDirectives).ToArray();
|
|
||||||
|
|
||||||
return Analyze.GetDiagnostics(analyzer, wrappedSourceCodes, compilationOptions, DefaultMetadataReferences)
|
|
||||||
.SelectMany(d => d)
|
|
||||||
.ToArray();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
internal static class AnalyzerAssertionsExtensions
|
|
||||||
{
|
|
||||||
public static AnalyzerAssertions Should(this DiagnosticAnalyzer analyzer) => new AnalyzerAssertions(analyzer);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,13 +0,0 @@
|
|||||||
<Project Sdk="Microsoft.NET.Sdk">
|
|
||||||
<Import Project="../CliFx.props" />
|
|
||||||
|
|
||||||
<PropertyGroup>
|
|
||||||
<TargetFramework>netstandard2.0</TargetFramework>
|
|
||||||
<Nullable>annotations</Nullable>
|
|
||||||
</PropertyGroup>
|
|
||||||
|
|
||||||
<ItemGroup>
|
|
||||||
<PackageReference Include="Microsoft.CodeAnalysis.CSharp.Workspaces" Version="3.4.0" PrivateAssets="all" />
|
|
||||||
</ItemGroup>
|
|
||||||
|
|
||||||
</Project>
|
|
||||||
@@ -1,297 +0,0 @@
|
|||||||
using System;
|
|
||||||
using System.Collections.Generic;
|
|
||||||
using System.Collections.Immutable;
|
|
||||||
using System.Linq;
|
|
||||||
using Microsoft.CodeAnalysis;
|
|
||||||
using Microsoft.CodeAnalysis.Diagnostics;
|
|
||||||
|
|
||||||
namespace CliFx.Analyzers
|
|
||||||
{
|
|
||||||
[DiagnosticAnalyzer(LanguageNames.CSharp)]
|
|
||||||
public class CommandSchemaAnalyzer : DiagnosticAnalyzer
|
|
||||||
{
|
|
||||||
public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics { get; } = ImmutableArray.Create(
|
|
||||||
DiagnosticDescriptors.CliFx0001,
|
|
||||||
DiagnosticDescriptors.CliFx0002,
|
|
||||||
DiagnosticDescriptors.CliFx0021,
|
|
||||||
DiagnosticDescriptors.CliFx0022,
|
|
||||||
DiagnosticDescriptors.CliFx0023,
|
|
||||||
DiagnosticDescriptors.CliFx0024,
|
|
||||||
DiagnosticDescriptors.CliFx0041,
|
|
||||||
DiagnosticDescriptors.CliFx0042,
|
|
||||||
DiagnosticDescriptors.CliFx0043,
|
|
||||||
DiagnosticDescriptors.CliFx0044,
|
|
||||||
DiagnosticDescriptors.CliFx0045
|
|
||||||
);
|
|
||||||
|
|
||||||
private static bool IsScalarType(ITypeSymbol typeSymbol) =>
|
|
||||||
KnownSymbols.IsSystemString(typeSymbol) ||
|
|
||||||
!typeSymbol.AllInterfaces.Select(i => i.ConstructedFrom).Any(KnownSymbols.IsSystemCollectionsGenericIEnumerable);
|
|
||||||
|
|
||||||
private static void CheckCommandParameterProperties(
|
|
||||||
SymbolAnalysisContext context,
|
|
||||||
IReadOnlyList<IPropertySymbol> properties)
|
|
||||||
{
|
|
||||||
var parameters = properties
|
|
||||||
.Select(p =>
|
|
||||||
{
|
|
||||||
var attribute = p
|
|
||||||
.GetAttributes()
|
|
||||||
.First(a => KnownSymbols.IsCommandParameterAttribute(a.AttributeClass));
|
|
||||||
|
|
||||||
var order = attribute
|
|
||||||
.ConstructorArguments
|
|
||||||
.Select(a => a.Value)
|
|
||||||
.FirstOrDefault() as int?;
|
|
||||||
|
|
||||||
var name = attribute
|
|
||||||
.NamedArguments
|
|
||||||
.Where(a => a.Key == "Name")
|
|
||||||
.Select(a => a.Value.Value)
|
|
||||||
.FirstOrDefault() as string;
|
|
||||||
|
|
||||||
return new
|
|
||||||
{
|
|
||||||
Property = p,
|
|
||||||
Order = order,
|
|
||||||
Name = name
|
|
||||||
};
|
|
||||||
})
|
|
||||||
.ToArray();
|
|
||||||
|
|
||||||
// Duplicate order
|
|
||||||
var duplicateOrderParameters = parameters
|
|
||||||
.Where(p => p.Order != null)
|
|
||||||
.GroupBy(p => p.Order)
|
|
||||||
.Where(g => g.Count() > 1)
|
|
||||||
.SelectMany(g => g.AsEnumerable())
|
|
||||||
.ToArray();
|
|
||||||
|
|
||||||
foreach (var parameter in duplicateOrderParameters)
|
|
||||||
{
|
|
||||||
context.ReportDiagnostic(
|
|
||||||
Diagnostic.Create(DiagnosticDescriptors.CliFx0021, parameter.Property.Locations.First()));
|
|
||||||
}
|
|
||||||
|
|
||||||
// Duplicate name
|
|
||||||
var duplicateNameParameters = parameters
|
|
||||||
.Where(p => !string.IsNullOrWhiteSpace(p.Name))
|
|
||||||
.GroupBy(p => p.Name, StringComparer.OrdinalIgnoreCase)
|
|
||||||
.Where(g => g.Count() > 1)
|
|
||||||
.SelectMany(g => g.AsEnumerable())
|
|
||||||
.ToArray();
|
|
||||||
|
|
||||||
foreach (var parameter in duplicateNameParameters)
|
|
||||||
{
|
|
||||||
context.ReportDiagnostic(
|
|
||||||
Diagnostic.Create(DiagnosticDescriptors.CliFx0022, parameter.Property.Locations.First()));
|
|
||||||
}
|
|
||||||
|
|
||||||
// Multiple non-scalar
|
|
||||||
var nonScalarParameters = parameters
|
|
||||||
.Where(p => !IsScalarType(p.Property.Type))
|
|
||||||
.ToArray();
|
|
||||||
|
|
||||||
if (nonScalarParameters.Length > 1)
|
|
||||||
{
|
|
||||||
foreach (var parameter in nonScalarParameters)
|
|
||||||
{
|
|
||||||
context.ReportDiagnostic(
|
|
||||||
Diagnostic.Create(DiagnosticDescriptors.CliFx0023, parameter.Property.Locations.First()));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Non-last non-scalar
|
|
||||||
var nonLastNonScalarParameter = parameters
|
|
||||||
.OrderByDescending(a => a.Order)
|
|
||||||
.Skip(1)
|
|
||||||
.LastOrDefault(p => !IsScalarType(p.Property.Type));
|
|
||||||
|
|
||||||
if (nonLastNonScalarParameter != null)
|
|
||||||
{
|
|
||||||
context.ReportDiagnostic(
|
|
||||||
Diagnostic.Create(DiagnosticDescriptors.CliFx0024, nonLastNonScalarParameter.Property.Locations.First()));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
private static void CheckCommandOptionProperties(
|
|
||||||
SymbolAnalysisContext context,
|
|
||||||
IReadOnlyList<IPropertySymbol> properties)
|
|
||||||
{
|
|
||||||
var options = properties
|
|
||||||
.Select(p =>
|
|
||||||
{
|
|
||||||
var attribute = p
|
|
||||||
.GetAttributes()
|
|
||||||
.First(a => KnownSymbols.IsCommandOptionAttribute(a.AttributeClass));
|
|
||||||
|
|
||||||
var name = attribute
|
|
||||||
.ConstructorArguments
|
|
||||||
.Where(a => KnownSymbols.IsSystemString(a.Type))
|
|
||||||
.Select(a => a.Value)
|
|
||||||
.FirstOrDefault() as string;
|
|
||||||
|
|
||||||
var shortName = attribute
|
|
||||||
.ConstructorArguments
|
|
||||||
.Where(a => KnownSymbols.IsSystemChar(a.Type))
|
|
||||||
.Select(a => a.Value)
|
|
||||||
.FirstOrDefault() as char?;
|
|
||||||
|
|
||||||
var envVarName = attribute
|
|
||||||
.NamedArguments
|
|
||||||
.Where(a => a.Key == "EnvironmentVariableName")
|
|
||||||
.Select(a => a.Value.Value)
|
|
||||||
.FirstOrDefault() as string;
|
|
||||||
|
|
||||||
return new
|
|
||||||
{
|
|
||||||
Property = p,
|
|
||||||
Name = name,
|
|
||||||
ShortName = shortName,
|
|
||||||
EnvironmentVariableName = envVarName
|
|
||||||
};
|
|
||||||
})
|
|
||||||
.ToArray();
|
|
||||||
|
|
||||||
// No name
|
|
||||||
var noNameOptions = options
|
|
||||||
.Where(o => string.IsNullOrWhiteSpace(o.Name) && o.ShortName == null)
|
|
||||||
.ToArray();
|
|
||||||
|
|
||||||
foreach (var option in noNameOptions)
|
|
||||||
{
|
|
||||||
context.ReportDiagnostic(
|
|
||||||
Diagnostic.Create(DiagnosticDescriptors.CliFx0041, option.Property.Locations.First()));
|
|
||||||
}
|
|
||||||
|
|
||||||
// Too short name
|
|
||||||
var invalidNameLengthOptions = options
|
|
||||||
.Where(o => !string.IsNullOrWhiteSpace(o.Name) && o.Name.Length <= 1)
|
|
||||||
.ToArray();
|
|
||||||
|
|
||||||
foreach (var option in invalidNameLengthOptions)
|
|
||||||
{
|
|
||||||
context.ReportDiagnostic(
|
|
||||||
Diagnostic.Create(DiagnosticDescriptors.CliFx0042, option.Property.Locations.First()));
|
|
||||||
}
|
|
||||||
|
|
||||||
// Duplicate name
|
|
||||||
var duplicateNameOptions = options
|
|
||||||
.Where(p => !string.IsNullOrWhiteSpace(p.Name))
|
|
||||||
.GroupBy(p => p.Name, StringComparer.OrdinalIgnoreCase)
|
|
||||||
.Where(g => g.Count() > 1)
|
|
||||||
.SelectMany(g => g.AsEnumerable())
|
|
||||||
.ToArray();
|
|
||||||
|
|
||||||
foreach (var option in duplicateNameOptions)
|
|
||||||
{
|
|
||||||
context.ReportDiagnostic(
|
|
||||||
Diagnostic.Create(DiagnosticDescriptors.CliFx0043, option.Property.Locations.First()));
|
|
||||||
}
|
|
||||||
|
|
||||||
// Duplicate name
|
|
||||||
var duplicateShortNameOptions = options
|
|
||||||
.Where(p => p.ShortName != null)
|
|
||||||
.GroupBy(p => p.ShortName)
|
|
||||||
.Where(g => g.Count() > 1)
|
|
||||||
.SelectMany(g => g.AsEnumerable())
|
|
||||||
.ToArray();
|
|
||||||
|
|
||||||
foreach (var option in duplicateShortNameOptions)
|
|
||||||
{
|
|
||||||
context.ReportDiagnostic(
|
|
||||||
Diagnostic.Create(DiagnosticDescriptors.CliFx0044, option.Property.Locations.First()));
|
|
||||||
}
|
|
||||||
|
|
||||||
// Duplicate environment variable name
|
|
||||||
var duplicateEnvironmentVariableNameOptions = options
|
|
||||||
.Where(p => !string.IsNullOrWhiteSpace(p.EnvironmentVariableName))
|
|
||||||
.GroupBy(p => p.EnvironmentVariableName, StringComparer.Ordinal)
|
|
||||||
.Where(g => g.Count() > 1)
|
|
||||||
.SelectMany(g => g.AsEnumerable())
|
|
||||||
.ToArray();
|
|
||||||
|
|
||||||
foreach (var option in duplicateEnvironmentVariableNameOptions)
|
|
||||||
{
|
|
||||||
context.ReportDiagnostic(
|
|
||||||
Diagnostic.Create(DiagnosticDescriptors.CliFx0045, option.Property.Locations.First()));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
private static void CheckCommandType(SymbolAnalysisContext context)
|
|
||||||
{
|
|
||||||
// Named type: MyCommand
|
|
||||||
if (!(context.Symbol is INamedTypeSymbol namedTypeSymbol))
|
|
||||||
return;
|
|
||||||
|
|
||||||
// Only classes
|
|
||||||
if (namedTypeSymbol.TypeKind != TypeKind.Class)
|
|
||||||
return;
|
|
||||||
|
|
||||||
// Implements ICommand?
|
|
||||||
var implementsCommandInterface = namedTypeSymbol
|
|
||||||
.AllInterfaces
|
|
||||||
.Any(KnownSymbols.IsCommandInterface);
|
|
||||||
|
|
||||||
// Has CommandAttribute?
|
|
||||||
var hasCommandAttribute = namedTypeSymbol
|
|
||||||
.GetAttributes()
|
|
||||||
.Select(a => a.AttributeClass)
|
|
||||||
.Any(KnownSymbols.IsCommandAttribute);
|
|
||||||
|
|
||||||
var isValidCommandType =
|
|
||||||
// implements interface
|
|
||||||
implementsCommandInterface && (
|
|
||||||
// and either abstract class or has attribute
|
|
||||||
namedTypeSymbol.IsAbstract || hasCommandAttribute
|
|
||||||
);
|
|
||||||
|
|
||||||
if (!isValidCommandType)
|
|
||||||
{
|
|
||||||
// See if this was meant to be a command type (either interface or attribute present)
|
|
||||||
var isAlmostValidCommandType = implementsCommandInterface ^ hasCommandAttribute;
|
|
||||||
|
|
||||||
if (isAlmostValidCommandType && !implementsCommandInterface)
|
|
||||||
context.ReportDiagnostic(Diagnostic.Create(DiagnosticDescriptors.CliFx0001, namedTypeSymbol.Locations.First()));
|
|
||||||
|
|
||||||
if (isAlmostValidCommandType && !hasCommandAttribute)
|
|
||||||
context.ReportDiagnostic(Diagnostic.Create(DiagnosticDescriptors.CliFx0002, namedTypeSymbol.Locations.First()));
|
|
||||||
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
var properties = namedTypeSymbol
|
|
||||||
.GetMembers()
|
|
||||||
.Where(m => m.Kind == SymbolKind.Property)
|
|
||||||
.OfType<IPropertySymbol>().ToArray();
|
|
||||||
|
|
||||||
// Check parameters
|
|
||||||
var parameterProperties = properties
|
|
||||||
.Where(p => p
|
|
||||||
.GetAttributes()
|
|
||||||
.Select(a => a.AttributeClass)
|
|
||||||
.Any(KnownSymbols.IsCommandParameterAttribute))
|
|
||||||
.ToArray();
|
|
||||||
|
|
||||||
CheckCommandParameterProperties(context, parameterProperties);
|
|
||||||
|
|
||||||
// Check options
|
|
||||||
var optionsProperties = properties
|
|
||||||
.Where(p => p
|
|
||||||
.GetAttributes()
|
|
||||||
.Select(a => a.AttributeClass)
|
|
||||||
.Any(KnownSymbols.IsCommandOptionAttribute))
|
|
||||||
.ToArray();
|
|
||||||
|
|
||||||
CheckCommandOptionProperties(context, optionsProperties);
|
|
||||||
}
|
|
||||||
|
|
||||||
public override void Initialize(AnalysisContext context)
|
|
||||||
{
|
|
||||||
context.EnableConcurrentExecution();
|
|
||||||
context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.None);
|
|
||||||
|
|
||||||
context.RegisterSymbolAction(CheckCommandType, SymbolKind.NamedType);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,80 +0,0 @@
|
|||||||
using System.Collections.Immutable;
|
|
||||||
using System.Linq;
|
|
||||||
using Microsoft.CodeAnalysis;
|
|
||||||
using Microsoft.CodeAnalysis.CSharp;
|
|
||||||
using Microsoft.CodeAnalysis.CSharp.Syntax;
|
|
||||||
using Microsoft.CodeAnalysis.Diagnostics;
|
|
||||||
|
|
||||||
namespace CliFx.Analyzers
|
|
||||||
{
|
|
||||||
[DiagnosticAnalyzer(LanguageNames.CSharp)]
|
|
||||||
public class ConsoleUsageAnalyzer : DiagnosticAnalyzer
|
|
||||||
{
|
|
||||||
public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics { get; } = ImmutableArray.Create(
|
|
||||||
DiagnosticDescriptors.CliFx0100
|
|
||||||
);
|
|
||||||
|
|
||||||
private static bool IsSystemConsoleInvocation(
|
|
||||||
SyntaxNodeAnalysisContext context,
|
|
||||||
InvocationExpressionSyntax invocationSyntax)
|
|
||||||
{
|
|
||||||
// Get the method member access (Console.WriteLine or Console.Error.WriteLine)
|
|
||||||
if (!(invocationSyntax.Expression is MemberAccessExpressionSyntax memberAccessSyntax))
|
|
||||||
return false;
|
|
||||||
|
|
||||||
// Get the semantic model for the invoked method
|
|
||||||
if (!(context.SemanticModel.GetSymbolInfo(memberAccessSyntax).Symbol is IMethodSymbol methodSymbol))
|
|
||||||
return false;
|
|
||||||
|
|
||||||
// Check if contained within System.Console
|
|
||||||
if (KnownSymbols.IsSystemConsole(methodSymbol.ContainingType))
|
|
||||||
return true;
|
|
||||||
|
|
||||||
// In case with Console.Error.WriteLine that wouldn't work, we need to check parent member access too
|
|
||||||
if (!(memberAccessSyntax.Expression is MemberAccessExpressionSyntax parentMemberAccessSyntax))
|
|
||||||
return false;
|
|
||||||
|
|
||||||
// Get the semantic model for the parent member
|
|
||||||
if (!(context.SemanticModel.GetSymbolInfo(parentMemberAccessSyntax).Symbol is IPropertySymbol propertySymbol))
|
|
||||||
return false;
|
|
||||||
|
|
||||||
// Check if contained within System.Console
|
|
||||||
if (KnownSymbols.IsSystemConsole(propertySymbol.ContainingType))
|
|
||||||
return true;
|
|
||||||
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
private static void CheckSystemConsoleUsage(SyntaxNodeAnalysisContext context)
|
|
||||||
{
|
|
||||||
if (!(context.Node is InvocationExpressionSyntax invocationSyntax))
|
|
||||||
return;
|
|
||||||
|
|
||||||
if (!IsSystemConsoleInvocation(context, invocationSyntax))
|
|
||||||
return;
|
|
||||||
|
|
||||||
// Check if IConsole is available in the scope as a viable alternative
|
|
||||||
var isConsoleInterfaceAvailable = invocationSyntax
|
|
||||||
.Ancestors()
|
|
||||||
.OfType<MethodDeclarationSyntax>()
|
|
||||||
.SelectMany(m => m.ParameterList.Parameters)
|
|
||||||
.Select(p => p.Type)
|
|
||||||
.Select(t => context.SemanticModel.GetSymbolInfo(t).Symbol)
|
|
||||||
.Where(s => s != null)
|
|
||||||
.Any(KnownSymbols.IsConsoleInterface!);
|
|
||||||
|
|
||||||
if (!isConsoleInterfaceAvailable)
|
|
||||||
return;
|
|
||||||
|
|
||||||
context.ReportDiagnostic(Diagnostic.Create(DiagnosticDescriptors.CliFx0100, invocationSyntax.GetLocation()));
|
|
||||||
}
|
|
||||||
|
|
||||||
public override void Initialize(AnalysisContext context)
|
|
||||||
{
|
|
||||||
context.EnableConcurrentExecution();
|
|
||||||
context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.None);
|
|
||||||
|
|
||||||
context.RegisterSyntaxNodeAction(CheckSystemConsoleUsage, SyntaxKind.InvocationExpression);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,79 +0,0 @@
|
|||||||
using Microsoft.CodeAnalysis;
|
|
||||||
|
|
||||||
namespace CliFx.Analyzers
|
|
||||||
{
|
|
||||||
public static class DiagnosticDescriptors
|
|
||||||
{
|
|
||||||
public static readonly DiagnosticDescriptor CliFx0001 =
|
|
||||||
new DiagnosticDescriptor(nameof(CliFx0001),
|
|
||||||
"Type must implement the 'CliFx.ICommand' interface in order to be a valid command",
|
|
||||||
"Type must implement the 'CliFx.ICommand' interface in order to be a valid command",
|
|
||||||
"Usage", DiagnosticSeverity.Error, true);
|
|
||||||
|
|
||||||
public static readonly DiagnosticDescriptor CliFx0002 =
|
|
||||||
new DiagnosticDescriptor(nameof(CliFx0002),
|
|
||||||
"Type must be annotated with the 'CliFx.Attributes.CommandAttribute' in order to be a valid command",
|
|
||||||
"Type must be annotated with the 'CliFx.Attributes.CommandAttribute' in order to be a valid command",
|
|
||||||
"Usage", DiagnosticSeverity.Error, true);
|
|
||||||
|
|
||||||
public static readonly DiagnosticDescriptor CliFx0021 =
|
|
||||||
new DiagnosticDescriptor(nameof(CliFx0021),
|
|
||||||
"Parameter order must be unique within its command",
|
|
||||||
"Parameter order must be unique within its command",
|
|
||||||
"Usage", DiagnosticSeverity.Error, true);
|
|
||||||
|
|
||||||
public static readonly DiagnosticDescriptor CliFx0022 =
|
|
||||||
new DiagnosticDescriptor(nameof(CliFx0022),
|
|
||||||
"Parameter order must have unique name within its command",
|
|
||||||
"Parameter order must have unique name within its command",
|
|
||||||
"Usage", DiagnosticSeverity.Error, true);
|
|
||||||
|
|
||||||
public static readonly DiagnosticDescriptor CliFx0023 =
|
|
||||||
new DiagnosticDescriptor(nameof(CliFx0023),
|
|
||||||
"Only one non-scalar parameter per command is allowed",
|
|
||||||
"Only one non-scalar parameter per command is allowed",
|
|
||||||
"Usage", DiagnosticSeverity.Error, true);
|
|
||||||
|
|
||||||
public static readonly DiagnosticDescriptor CliFx0024 =
|
|
||||||
new DiagnosticDescriptor(nameof(CliFx0024),
|
|
||||||
"Non-scalar parameter must be last in order",
|
|
||||||
"Non-scalar parameter must be last in order",
|
|
||||||
"Usage", DiagnosticSeverity.Error, true);
|
|
||||||
|
|
||||||
public static readonly DiagnosticDescriptor CliFx0041 =
|
|
||||||
new DiagnosticDescriptor(nameof(CliFx0041),
|
|
||||||
"Option must have a name or short name specified",
|
|
||||||
"Option must have a name or short name specified",
|
|
||||||
"Usage", DiagnosticSeverity.Error, true);
|
|
||||||
|
|
||||||
public static readonly DiagnosticDescriptor CliFx0042 =
|
|
||||||
new DiagnosticDescriptor(nameof(CliFx0042),
|
|
||||||
"Option name must be at least 2 characters long",
|
|
||||||
"Option name must be at least 2 characters long",
|
|
||||||
"Usage", DiagnosticSeverity.Error, true);
|
|
||||||
|
|
||||||
public static readonly DiagnosticDescriptor CliFx0043 =
|
|
||||||
new DiagnosticDescriptor(nameof(CliFx0043),
|
|
||||||
"Option name must be unique within its command",
|
|
||||||
"Option name must be unique within its command",
|
|
||||||
"Usage", DiagnosticSeverity.Error, true);
|
|
||||||
|
|
||||||
public static readonly DiagnosticDescriptor CliFx0044 =
|
|
||||||
new DiagnosticDescriptor(nameof(CliFx0044),
|
|
||||||
"Option short name must be unique within its command",
|
|
||||||
"Option short name must be unique within its command",
|
|
||||||
"Usage", DiagnosticSeverity.Error, true);
|
|
||||||
|
|
||||||
public static readonly DiagnosticDescriptor CliFx0045 =
|
|
||||||
new DiagnosticDescriptor(nameof(CliFx0045),
|
|
||||||
"Option environment variable name must be unique within its command",
|
|
||||||
"Option environment variable name must be unique within its command",
|
|
||||||
"Usage", DiagnosticSeverity.Error, true);
|
|
||||||
|
|
||||||
public static readonly DiagnosticDescriptor CliFx0100 =
|
|
||||||
new DiagnosticDescriptor(nameof(CliFx0100),
|
|
||||||
"Use the provided IConsole abstraction instead of System.Console to ensure that the command can be tested in isolation",
|
|
||||||
"Use the provided IConsole abstraction instead of System.Console to ensure that the command can be tested in isolation",
|
|
||||||
"Usage", DiagnosticSeverity.Warning, true);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
using System;
|
|
||||||
using Microsoft.CodeAnalysis;
|
|
||||||
|
|
||||||
namespace CliFx.Analyzers.Internal
|
|
||||||
{
|
|
||||||
internal static class RoslynExtensions
|
|
||||||
{
|
|
||||||
public static bool DisplayNameMatches(this ISymbol symbol, string name) =>
|
|
||||||
string.Equals(symbol.ToDisplayString(), name, StringComparison.Ordinal);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,37 +0,0 @@
|
|||||||
using CliFx.Analyzers.Internal;
|
|
||||||
using Microsoft.CodeAnalysis;
|
|
||||||
|
|
||||||
namespace CliFx.Analyzers
|
|
||||||
{
|
|
||||||
public static class KnownSymbols
|
|
||||||
{
|
|
||||||
public static bool IsSystemString(ISymbol symbol) =>
|
|
||||||
symbol.DisplayNameMatches("string") ||
|
|
||||||
symbol.DisplayNameMatches("System.String");
|
|
||||||
|
|
||||||
public static bool IsSystemChar(ISymbol symbol) =>
|
|
||||||
symbol.DisplayNameMatches("char") ||
|
|
||||||
symbol.DisplayNameMatches("System.Char");
|
|
||||||
|
|
||||||
public static bool IsSystemCollectionsGenericIEnumerable(ISymbol symbol) =>
|
|
||||||
symbol.DisplayNameMatches("System.Collections.Generic.IEnumerable<T>");
|
|
||||||
|
|
||||||
public static bool IsSystemConsole(ISymbol symbol) =>
|
|
||||||
symbol.DisplayNameMatches("System.Console");
|
|
||||||
|
|
||||||
public static bool IsConsoleInterface(ISymbol symbol) =>
|
|
||||||
symbol.DisplayNameMatches("CliFx.IConsole");
|
|
||||||
|
|
||||||
public static bool IsCommandInterface(ISymbol symbol) =>
|
|
||||||
symbol.DisplayNameMatches("CliFx.ICommand");
|
|
||||||
|
|
||||||
public static bool IsCommandAttribute(ISymbol symbol) =>
|
|
||||||
symbol.DisplayNameMatches("CliFx.Attributes.CommandAttribute");
|
|
||||||
|
|
||||||
public static bool IsCommandParameterAttribute(ISymbol symbol) =>
|
|
||||||
symbol.DisplayNameMatches("CliFx.Attributes.CommandParameterAttribute");
|
|
||||||
|
|
||||||
public static bool IsCommandOptionAttribute(ISymbol symbol) =>
|
|
||||||
symbol.DisplayNameMatches("CliFx.Attributes.CommandOptionAttribute");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
32
CliFx.Benchmarks/Benchmarks.CliFx.cs
Normal file
32
CliFx.Benchmarks/Benchmarks.CliFx.cs
Normal file
@@ -0,0 +1,32 @@
|
|||||||
|
using System.Collections.Generic;
|
||||||
|
using System.Threading.Tasks;
|
||||||
|
using BenchmarkDotNet.Attributes;
|
||||||
|
using CliFx.Attributes;
|
||||||
|
using CliFx.Infrastructure;
|
||||||
|
|
||||||
|
namespace CliFx.Benchmarks;
|
||||||
|
|
||||||
|
public partial class Benchmarks
|
||||||
|
{
|
||||||
|
[Command]
|
||||||
|
public class CliFxCommand : ICommand
|
||||||
|
{
|
||||||
|
[CommandOption("str", 's')]
|
||||||
|
public string? StrOption { get; set; }
|
||||||
|
|
||||||
|
[CommandOption("int", 'i')]
|
||||||
|
public int IntOption { get; set; }
|
||||||
|
|
||||||
|
[CommandOption("bool", 'b')]
|
||||||
|
public bool BoolOption { get; set; }
|
||||||
|
|
||||||
|
public ValueTask ExecuteAsync(IConsole console) => default;
|
||||||
|
}
|
||||||
|
|
||||||
|
[Benchmark(Description = "CliFx", Baseline = true)]
|
||||||
|
public async ValueTask<int> ExecuteWithCliFx() =>
|
||||||
|
await new CliApplicationBuilder()
|
||||||
|
.AddCommand<CliFxCommand>()
|
||||||
|
.Build()
|
||||||
|
.RunAsync(Arguments, new Dictionary<string, string>());
|
||||||
|
}
|
||||||
@@ -1,6 +1,9 @@
|
|||||||
using clipr;
|
using BenchmarkDotNet.Attributes;
|
||||||
|
using clipr;
|
||||||
|
|
||||||
namespace CliFx.Benchmarks.Commands
|
namespace CliFx.Benchmarks;
|
||||||
|
|
||||||
|
public partial class Benchmarks
|
||||||
{
|
{
|
||||||
public class CliprCommand
|
public class CliprCommand
|
||||||
{
|
{
|
||||||
@@ -13,8 +16,9 @@ namespace CliFx.Benchmarks.Commands
|
|||||||
[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")]
|
||||||
|
public void ExecuteWithClipr() => CliParser.Parse<CliprCommand>(Arguments).Execute();
|
||||||
|
}
|
||||||
19
CliFx.Benchmarks/Benchmarks.Cocona.cs
Normal file
19
CliFx.Benchmarks/Benchmarks.Cocona.cs
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
using BenchmarkDotNet.Attributes;
|
||||||
|
using Cocona;
|
||||||
|
|
||||||
|
namespace CliFx.Benchmarks;
|
||||||
|
|
||||||
|
public partial class Benchmarks
|
||||||
|
{
|
||||||
|
public class CoconaCommand
|
||||||
|
{
|
||||||
|
public void Execute(
|
||||||
|
[Option("str", ['s'])] string? strOption,
|
||||||
|
[Option("int", ['i'])] int intOption,
|
||||||
|
[Option("bool", ['b'])] bool boolOption
|
||||||
|
) { }
|
||||||
|
}
|
||||||
|
|
||||||
|
[Benchmark(Description = "Cocona")]
|
||||||
|
public void ExecuteWithCocona() => CoconaApp.Run<CoconaCommand>(Arguments);
|
||||||
|
}
|
||||||
27
CliFx.Benchmarks/Benchmarks.CommandLineParser.cs
Normal file
27
CliFx.Benchmarks/Benchmarks.CommandLineParser.cs
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
using BenchmarkDotNet.Attributes;
|
||||||
|
using CommandLine;
|
||||||
|
|
||||||
|
namespace CliFx.Benchmarks;
|
||||||
|
|
||||||
|
public partial class Benchmarks
|
||||||
|
{
|
||||||
|
public class CommandLineParserCommand
|
||||||
|
{
|
||||||
|
[Option('s', "str")]
|
||||||
|
public string? StrOption { get; set; }
|
||||||
|
|
||||||
|
[Option('i', "int")]
|
||||||
|
public int IntOption { get; set; }
|
||||||
|
|
||||||
|
[Option('b', "bool")]
|
||||||
|
public bool BoolOption { get; set; }
|
||||||
|
|
||||||
|
public void Execute() { }
|
||||||
|
}
|
||||||
|
|
||||||
|
[Benchmark(Description = "CommandLineParser")]
|
||||||
|
public void ExecuteWithCommandLineParser() =>
|
||||||
|
new Parser()
|
||||||
|
.ParseArguments(Arguments, typeof(CommandLineParserCommand))
|
||||||
|
.WithParsed<CommandLineParserCommand>(c => c.Execute());
|
||||||
|
}
|
||||||
24
CliFx.Benchmarks/Benchmarks.McMaster.cs
Normal file
24
CliFx.Benchmarks/Benchmarks.McMaster.cs
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
using BenchmarkDotNet.Attributes;
|
||||||
|
using McMaster.Extensions.CommandLineUtils;
|
||||||
|
|
||||||
|
namespace CliFx.Benchmarks;
|
||||||
|
|
||||||
|
public partial class Benchmarks
|
||||||
|
{
|
||||||
|
public class McMasterCommand
|
||||||
|
{
|
||||||
|
[Option("--str|-s")]
|
||||||
|
public string? StrOption { get; set; }
|
||||||
|
|
||||||
|
[Option("--int|-i")]
|
||||||
|
public int IntOption { get; set; }
|
||||||
|
|
||||||
|
[Option("--bool|-b")]
|
||||||
|
public bool BoolOption { get; set; }
|
||||||
|
|
||||||
|
public int OnExecute() => 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
[Benchmark(Description = "McMaster.Extensions.CommandLineUtils")]
|
||||||
|
public int ExecuteWithMcMaster() => CommandLineApplication.Execute<McMasterCommand>(Arguments);
|
||||||
|
}
|
||||||
@@ -1,6 +1,9 @@
|
|||||||
using PowerArgs;
|
using BenchmarkDotNet.Attributes;
|
||||||
|
using PowerArgs;
|
||||||
|
|
||||||
namespace CliFx.Benchmarks.Commands
|
namespace CliFx.Benchmarks;
|
||||||
|
|
||||||
|
public partial class Benchmarks
|
||||||
{
|
{
|
||||||
public class PowerArgsCommand
|
public class PowerArgsCommand
|
||||||
{
|
{
|
||||||
@@ -13,8 +16,9 @@ namespace CliFx.Benchmarks.Commands
|
|||||||
[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")]
|
||||||
|
public void ExecuteWithPowerArgs() => Args.InvokeMain<PowerArgsCommand>(Arguments);
|
||||||
|
}
|
||||||
33
CliFx.Benchmarks/Benchmarks.SystemCommandLine.cs
Normal file
33
CliFx.Benchmarks/Benchmarks.SystemCommandLine.cs
Normal file
@@ -0,0 +1,33 @@
|
|||||||
|
using System.CommandLine;
|
||||||
|
using System.Threading.Tasks;
|
||||||
|
using BenchmarkDotNet.Attributes;
|
||||||
|
|
||||||
|
namespace CliFx.Benchmarks;
|
||||||
|
|
||||||
|
public partial class Benchmarks
|
||||||
|
{
|
||||||
|
public class SystemCommandLineCommand
|
||||||
|
{
|
||||||
|
public static void ExecuteHandler(string s, int i, bool b) { }
|
||||||
|
|
||||||
|
public Task<int> ExecuteAsync(string[] args)
|
||||||
|
{
|
||||||
|
var stringOption = new Option<string>(["--str", "-s"]);
|
||||||
|
var intOption = new Option<int>(["--int", "-i"]);
|
||||||
|
var boolOption = new Option<bool>(["--bool", "-b"]);
|
||||||
|
|
||||||
|
var command = new RootCommand();
|
||||||
|
command.AddOption(stringOption);
|
||||||
|
command.AddOption(intOption);
|
||||||
|
command.AddOption(boolOption);
|
||||||
|
|
||||||
|
command.SetHandler(ExecuteHandler, stringOption, intOption, boolOption);
|
||||||
|
|
||||||
|
return command.InvokeAsync(args);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
[Benchmark(Description = "System.CommandLine")]
|
||||||
|
public async Task<int> ExecuteWithSystemCommandLine() =>
|
||||||
|
await new SystemCommandLineCommand().ExecuteAsync(Arguments);
|
||||||
|
}
|
||||||
@@ -1,52 +1,18 @@
|
|||||||
using System.Collections.Generic;
|
using BenchmarkDotNet.Attributes;
|
||||||
using System.Threading.Tasks;
|
|
||||||
using BenchmarkDotNet.Attributes;
|
|
||||||
using BenchmarkDotNet.Configs;
|
using BenchmarkDotNet.Configs;
|
||||||
using BenchmarkDotNet.Order;
|
using BenchmarkDotNet.Order;
|
||||||
using BenchmarkDotNet.Running;
|
using BenchmarkDotNet.Running;
|
||||||
using CliFx.Benchmarks.Commands;
|
|
||||||
using CommandLine;
|
|
||||||
|
|
||||||
namespace CliFx.Benchmarks
|
namespace CliFx.Benchmarks;
|
||||||
|
|
||||||
|
[RankColumn]
|
||||||
|
[Orderer(SummaryOrderPolicy.FastestToSlowest)]
|
||||||
|
public partial class Benchmarks
|
||||||
{
|
{
|
||||||
[SimpleJob]
|
private static readonly string[] Arguments = ["--str", "hello world", "-i", "13", "-b"];
|
||||||
[RankColumn]
|
|
||||||
[Orderer(SummaryOrderPolicy.FastestToSlowest)]
|
|
||||||
public class Benchmarks
|
|
||||||
{
|
|
||||||
private static readonly string[] Arguments = {"--str", "hello world", "-i", "13", "-b"};
|
|
||||||
|
|
||||||
[Benchmark(Description = "CliFx", Baseline = true)]
|
public static void Main() =>
|
||||||
public async ValueTask<int> ExecuteWithCliFx() =>
|
BenchmarkRunner.Run<Benchmarks>(
|
||||||
await new CliApplicationBuilder().AddCommand<CliFxCommand>().Build().RunAsync(Arguments, new Dictionary<string, string>());
|
DefaultConfig.Instance.WithOptions(ConfigOptions.DisableOptimizationsValidator)
|
||||||
|
);
|
||||||
[Benchmark(Description = "System.CommandLine")]
|
}
|
||||||
public async Task<int> ExecuteWithSystemCommandLine() =>
|
|
||||||
await new SystemCommandLineCommand().ExecuteAsync(Arguments);
|
|
||||||
|
|
||||||
[Benchmark(Description = "McMaster.Extensions.CommandLineUtils")]
|
|
||||||
public int ExecuteWithMcMaster() =>
|
|
||||||
McMaster.Extensions.CommandLineUtils.CommandLineApplication.Execute<McMasterCommand>(Arguments);
|
|
||||||
|
|
||||||
[Benchmark(Description = "CommandLineParser")]
|
|
||||||
public void ExecuteWithCommandLineParser() =>
|
|
||||||
new Parser()
|
|
||||||
.ParseArguments(Arguments, typeof(CommandLineParserCommand))
|
|
||||||
.WithParsed<CommandLineParserCommand>(c => c.Execute());
|
|
||||||
|
|
||||||
[Benchmark(Description = "PowerArgs")]
|
|
||||||
public void ExecuteWithPowerArgs() =>
|
|
||||||
PowerArgs.Args.InvokeMain<PowerArgsCommand>(Arguments);
|
|
||||||
|
|
||||||
[Benchmark(Description = "Clipr")]
|
|
||||||
public void ExecuteWithClipr() =>
|
|
||||||
clipr.CliParser.Parse<CliprCommand>(Arguments).Execute();
|
|
||||||
|
|
||||||
[Benchmark(Description = "Cocona")]
|
|
||||||
public void ExecuteWithCocona() =>
|
|
||||||
Cocona.CoconaApp.Run<CoconaCommand>(Arguments);
|
|
||||||
|
|
||||||
public static void Main() =>
|
|
||||||
BenchmarkRunner.Run<Benchmarks>(DefaultConfig.Instance.With(ConfigOptions.DisableOptimizationsValidator));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -1,19 +1,20 @@
|
|||||||
<Project Sdk="Microsoft.NET.Sdk">
|
<Project Sdk="Microsoft.NET.Sdk">
|
||||||
<Import Project="../CliFx.props" />
|
|
||||||
|
|
||||||
<PropertyGroup>
|
<PropertyGroup>
|
||||||
<OutputType>Exe</OutputType>
|
<OutputType>Exe</OutputType>
|
||||||
<TargetFramework>netcoreapp3.1</TargetFramework>
|
<TargetFramework>net9.0</TargetFramework>
|
||||||
|
<NuGetAudit>false</NuGetAudit>
|
||||||
</PropertyGroup>
|
</PropertyGroup>
|
||||||
|
|
||||||
<ItemGroup>
|
<ItemGroup>
|
||||||
<PackageReference Include="BenchmarkDotNet" Version="0.12.0" />
|
<PackageReference Include="BenchmarkDotNet" Version="0.15.2" />
|
||||||
<PackageReference Include="clipr" Version="1.6.1" />
|
<PackageReference Include="clipr" Version="1.6.1" />
|
||||||
<PackageReference Include="Cocona" Version="1.3.0" />
|
<PackageReference Include="Cocona" Version="2.2.0" />
|
||||||
<PackageReference Include="CommandLineParser" Version="2.7.82" />
|
<PackageReference Include="CommandLineParser" Version="2.9.1" />
|
||||||
<PackageReference Include="McMaster.Extensions.CommandLineUtils" Version="2.6.0" />
|
<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.Experimental" Version="0.3.0-alpha.19317.1" />
|
<PackageReference Include="PowerArgs" Version="4.0.3" />
|
||||||
|
<PackageReference Include="System.CommandLine" Version="2.0.0-beta5.25306.1" />
|
||||||
</ItemGroup>
|
</ItemGroup>
|
||||||
|
|
||||||
<ItemGroup>
|
<ItemGroup>
|
||||||
|
|||||||
@@ -1,20 +0,0 @@
|
|||||||
using System.Threading.Tasks;
|
|
||||||
using CliFx.Attributes;
|
|
||||||
|
|
||||||
namespace CliFx.Benchmarks.Commands
|
|
||||||
{
|
|
||||||
[Command]
|
|
||||||
public class CliFxCommand : ICommand
|
|
||||||
{
|
|
||||||
[CommandOption("str", 's')]
|
|
||||||
public string? StrOption { get; set; }
|
|
||||||
|
|
||||||
[CommandOption("int", 'i')]
|
|
||||||
public int IntOption { get; set; }
|
|
||||||
|
|
||||||
[CommandOption("bool", 'b')]
|
|
||||||
public bool BoolOption { get; set; }
|
|
||||||
|
|
||||||
public ValueTask ExecuteAsync(IConsole console) => default;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,17 +0,0 @@
|
|||||||
using Cocona;
|
|
||||||
|
|
||||||
namespace CliFx.Benchmarks.Commands
|
|
||||||
{
|
|
||||||
public class CoconaCommand
|
|
||||||
{
|
|
||||||
public void Execute(
|
|
||||||
[Option("str", new []{'s'})]
|
|
||||||
string? strOption,
|
|
||||||
[Option("int", new []{'i'})]
|
|
||||||
int intOption,
|
|
||||||
[Option("bool", new []{'b'})]
|
|
||||||
bool boolOption)
|
|
||||||
{
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,20 +0,0 @@
|
|||||||
using CommandLine;
|
|
||||||
|
|
||||||
namespace CliFx.Benchmarks.Commands
|
|
||||||
{
|
|
||||||
public class CommandLineParserCommand
|
|
||||||
{
|
|
||||||
[Option('s', "str")]
|
|
||||||
public string? StrOption { get; set; }
|
|
||||||
|
|
||||||
[Option('i', "int")]
|
|
||||||
public int IntOption { get; set; }
|
|
||||||
|
|
||||||
[Option('b', "bool")]
|
|
||||||
public bool BoolOption { get; set; }
|
|
||||||
|
|
||||||
public void Execute()
|
|
||||||
{
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
using McMaster.Extensions.CommandLineUtils;
|
|
||||||
|
|
||||||
namespace CliFx.Benchmarks.Commands
|
|
||||||
{
|
|
||||||
public class McMasterCommand
|
|
||||||
{
|
|
||||||
[Option("--str|-s")]
|
|
||||||
public string? StrOption { get; set; }
|
|
||||||
|
|
||||||
[Option("--int|-i")]
|
|
||||||
public int IntOption { get; set; }
|
|
||||||
|
|
||||||
[Option("--bool|-b")]
|
|
||||||
public bool BoolOption { get; set; }
|
|
||||||
|
|
||||||
public int OnExecute() => 0;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,34 +0,0 @@
|
|||||||
using System.CommandLine;
|
|
||||||
using System.CommandLine.Invocation;
|
|
||||||
using System.Threading.Tasks;
|
|
||||||
|
|
||||||
namespace CliFx.Benchmarks.Commands
|
|
||||||
{
|
|
||||||
public class SystemCommandLineCommand
|
|
||||||
{
|
|
||||||
public static int ExecuteHandler(string s, int i, bool b) => 0;
|
|
||||||
|
|
||||||
public Task<int> ExecuteAsync(string[] args)
|
|
||||||
{
|
|
||||||
var command = new RootCommand
|
|
||||||
{
|
|
||||||
new Option(new[] {"--str", "-s"})
|
|
||||||
{
|
|
||||||
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(typeof(SystemCommandLineCommand).GetMethod(nameof(ExecuteHandler)));
|
|
||||||
|
|
||||||
return command.InvokeAsync(args);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
22
CliFx.Benchmarks/Readme.md
Normal file
22
CliFx.Benchmarks/Readme.md
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
## CliFx.Benchmarks
|
||||||
|
|
||||||
|
All benchmarks below were ran with the following configuration:
|
||||||
|
|
||||||
|
```ini
|
||||||
|
BenchmarkDotNet=v0.12.0, OS=Windows 10.0.14393.3443 (1607/AnniversaryUpdate/Redstone1)
|
||||||
|
Intel Core i5-4460 CPU 3.20GHz (Haswell), 1 CPU, 4 logical and 4 physical cores
|
||||||
|
Frequency=3124994 Hz, Resolution=320.0006 ns, Timer=TSC
|
||||||
|
.NET Core SDK=3.1.100
|
||||||
|
[Host] : .NET Core 3.1.0 (CoreCLR 4.700.19.56402, CoreFX 4.700.19.56404), X64 RyuJIT
|
||||||
|
DefaultJob : .NET Core 3.1.0 (CoreCLR 4.700.19.56402, CoreFX 4.700.19.56404), X64 RyuJIT
|
||||||
|
```
|
||||||
|
|
||||||
|
| Method | Mean | Error | StdDev | Ratio | RatioSD | Rank |
|
||||||
|
| ------------------------------------ | ----------: | --------: | ---------: | ----: | ------: | ---: |
|
||||||
|
| CommandLineParser | 24.79 us | 0.166 us | 0.155 us | 0.49 | 0.00 | 1 |
|
||||||
|
| CliFx | 50.27 us | 0.248 us | 0.232 us | 1.00 | 0.00 | 2 |
|
||||||
|
| Clipr | 160.22 us | 0.817 us | 0.764 us | 3.19 | 0.02 | 3 |
|
||||||
|
| McMaster.Extensions.CommandLineUtils | 166.45 us | 1.111 us | 1.039 us | 3.31 | 0.03 | 4 |
|
||||||
|
| System.CommandLine | 170.27 us | 0.599 us | 0.560 us | 3.39 | 0.02 | 5 |
|
||||||
|
| PowerArgs | 306.12 us | 1.495 us | 1.398 us | 6.09 | 0.03 | 6 |
|
||||||
|
| Cocona | 1,856.07 us | 48.727 us | 141.367 us | 37.88 | 2.60 | 7 |
|
||||||
@@ -1,19 +1,20 @@
|
|||||||
<Project Sdk="Microsoft.NET.Sdk">
|
<Project Sdk="Microsoft.NET.Sdk">
|
||||||
<Import Project="../CliFx.props" />
|
|
||||||
|
|
||||||
<PropertyGroup>
|
<PropertyGroup>
|
||||||
<OutputType>Exe</OutputType>
|
<OutputType>Exe</OutputType>
|
||||||
<TargetFramework>netcoreapp3.1</TargetFramework>
|
<TargetFramework>net9.0</TargetFramework>
|
||||||
|
<ApplicationIcon>../favicon.ico</ApplicationIcon>
|
||||||
|
<PublishAot>true</PublishAot>
|
||||||
</PropertyGroup>
|
</PropertyGroup>
|
||||||
|
|
||||||
<ItemGroup>
|
<ItemGroup>
|
||||||
<PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="3.1.2" />
|
<PackageReference Include="CSharpier.MsBuild" Version="0.30.6" PrivateAssets="all" />
|
||||||
<PackageReference Include="Newtonsoft.Json" Version="12.0.3" />
|
<PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="9.0.6" />
|
||||||
</ItemGroup>
|
</ItemGroup>
|
||||||
|
|
||||||
<ItemGroup>
|
<ItemGroup>
|
||||||
<ProjectReference Include="..\CliFx\CliFx.csproj" />
|
<ProjectReference Include="..\CliFx\CliFx.csproj" />
|
||||||
<ProjectReference Include="..\CliFx.Analyzers\CliFx.Analyzers.csproj" ReferenceOutputAssembly="false" OutputItemType="Analyzer" />
|
<ProjectReference Include="..\CliFx.SourceGeneration\CliFx.SourceGeneration.csproj" ReferenceOutputAssembly="false" OutputItemType="analyzer" />
|
||||||
</ItemGroup>
|
</ItemGroup>
|
||||||
|
|
||||||
</Project>
|
</Project>
|
||||||
@@ -1,68 +1,55 @@
|
|||||||
using System;
|
using System;
|
||||||
using System.Threading.Tasks;
|
using System.Threading.Tasks;
|
||||||
using CliFx.Attributes;
|
using CliFx.Attributes;
|
||||||
using CliFx.Demo.Internal;
|
using CliFx.Demo.Domain;
|
||||||
using CliFx.Demo.Models;
|
using CliFx.Demo.Utils;
|
||||||
using CliFx.Demo.Services;
|
|
||||||
using CliFx.Exceptions;
|
using CliFx.Exceptions;
|
||||||
|
using CliFx.Infrastructure;
|
||||||
|
|
||||||
namespace CliFx.Demo.Commands
|
namespace CliFx.Demo.Commands;
|
||||||
|
|
||||||
|
[Command("book add", Description = "Adds a book to the library.")]
|
||||||
|
public class BookAddCommand(LibraryProvider libraryProvider) : ICommand
|
||||||
{
|
{
|
||||||
[Command("book add", Description = "Add a book to the library.")]
|
[CommandParameter(0, Name = "title", Description = "Book title.")]
|
||||||
public partial class BookAddCommand : ICommand
|
public required string Title { get; init; }
|
||||||
|
|
||||||
|
[CommandOption("author", 'a', Description = "Book author.")]
|
||||||
|
public required string Author { get; init; }
|
||||||
|
|
||||||
|
[CommandOption("published", 'p', Description = "Book publish date.")]
|
||||||
|
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.")]
|
||||||
|
public Isbn Isbn { get; init; } =
|
||||||
|
new(
|
||||||
|
Random.Shared.Next(0, 999),
|
||||||
|
Random.Shared.Next(0, 99),
|
||||||
|
Random.Shared.Next(0, 99999),
|
||||||
|
Random.Shared.Next(0, 99),
|
||||||
|
Random.Shared.Next(0, 9)
|
||||||
|
);
|
||||||
|
|
||||||
|
public ValueTask ExecuteAsync(IConsole console)
|
||||||
{
|
{
|
||||||
private readonly LibraryService _libraryService;
|
if (libraryProvider.TryGetBook(Title) is not null)
|
||||||
|
throw new CommandException($"Book '{Title}' already exists.", 10);
|
||||||
|
|
||||||
[CommandParameter(0, Name = "title", Description = "Book title.")]
|
var book = new Book(Title, Author, Published, Isbn);
|
||||||
public string Title { get; set; } = "";
|
libraryProvider.AddBook(book);
|
||||||
|
|
||||||
[CommandOption("author", 'a', IsRequired = true, Description = "Book author.")]
|
console.WriteLine($"Book '{Title}' added.");
|
||||||
public string Author { get; set; } = "";
|
console.WriteBook(book);
|
||||||
|
|
||||||
[CommandOption("published", 'p', Description = "Book publish date.")]
|
return default;
|
||||||
public DateTimeOffset Published { get; set; } = CreateRandomDate();
|
|
||||||
|
|
||||||
[CommandOption("isbn", 'n', Description = "Book ISBN.")]
|
|
||||||
public Isbn Isbn { get; set; } = CreateRandomIsbn();
|
|
||||||
|
|
||||||
public BookAddCommand(LibraryService libraryService)
|
|
||||||
{
|
|
||||||
_libraryService = libraryService;
|
|
||||||
}
|
|
||||||
|
|
||||||
public ValueTask ExecuteAsync(IConsole console)
|
|
||||||
{
|
|
||||||
if (_libraryService.GetBook(Title) != null)
|
|
||||||
throw new CommandException("Book already exists.", 1);
|
|
||||||
|
|
||||||
var book = new Book(Title, Author, Published, Isbn);
|
|
||||||
_libraryService.AddBook(book);
|
|
||||||
|
|
||||||
console.Output.WriteLine("Book added.");
|
|
||||||
console.RenderBook(book);
|
|
||||||
|
|
||||||
return default;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
}
|
||||||
public partial class BookAddCommand
|
|
||||||
{
|
|
||||||
private static readonly Random Random = new Random();
|
|
||||||
|
|
||||||
private static DateTimeOffset CreateRandomDate() => new DateTimeOffset(
|
|
||||||
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 Isbn(
|
|
||||||
Random.Next(0, 999),
|
|
||||||
Random.Next(0, 99),
|
|
||||||
Random.Next(0, 99999),
|
|
||||||
Random.Next(0, 99),
|
|
||||||
Random.Next(0, 9));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -1,34 +1,27 @@
|
|||||||
using System.Threading.Tasks;
|
using System.Threading.Tasks;
|
||||||
using CliFx.Attributes;
|
using CliFx.Attributes;
|
||||||
using CliFx.Demo.Internal;
|
using CliFx.Demo.Domain;
|
||||||
using CliFx.Demo.Services;
|
using CliFx.Demo.Utils;
|
||||||
using CliFx.Exceptions;
|
using CliFx.Exceptions;
|
||||||
|
using CliFx.Infrastructure;
|
||||||
|
|
||||||
namespace CliFx.Demo.Commands
|
namespace CliFx.Demo.Commands;
|
||||||
|
|
||||||
|
[Command("book", Description = "Retrieves a book from the library.")]
|
||||||
|
public class BookCommand(LibraryProvider libraryProvider) : ICommand
|
||||||
{
|
{
|
||||||
[Command("book", Description = "View, list, add or remove books.")]
|
[CommandParameter(0, Name = "title", Description = "Title of the book to retrieve.")]
|
||||||
public class BookCommand : ICommand
|
public required string Title { get; init; }
|
||||||
|
|
||||||
|
public ValueTask ExecuteAsync(IConsole console)
|
||||||
{
|
{
|
||||||
private readonly LibraryService _libraryService;
|
var book = libraryProvider.TryGetBook(Title);
|
||||||
|
|
||||||
[CommandParameter(0, Name = "title", Description = "Book title.")]
|
if (book is null)
|
||||||
public string Title { get; set; } = "";
|
throw new CommandException($"Book '{Title}' not found.", 10);
|
||||||
|
|
||||||
public BookCommand(LibraryService libraryService)
|
console.WriteBook(book);
|
||||||
{
|
|
||||||
_libraryService = libraryService;
|
|
||||||
}
|
|
||||||
|
|
||||||
public ValueTask ExecuteAsync(IConsole console)
|
return default;
|
||||||
{
|
|
||||||
var book = _libraryService.GetBook(Title);
|
|
||||||
|
|
||||||
if (book == null)
|
|
||||||
throw new CommandException("Book not found.", 1);
|
|
||||||
|
|
||||||
console.RenderBook(book);
|
|
||||||
|
|
||||||
return default;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,37 +1,29 @@
|
|||||||
using System.Threading.Tasks;
|
using System.Threading.Tasks;
|
||||||
using CliFx.Attributes;
|
using CliFx.Attributes;
|
||||||
using CliFx.Demo.Internal;
|
using CliFx.Demo.Domain;
|
||||||
using CliFx.Demo.Services;
|
using CliFx.Demo.Utils;
|
||||||
|
using CliFx.Infrastructure;
|
||||||
|
|
||||||
namespace CliFx.Demo.Commands
|
namespace CliFx.Demo.Commands;
|
||||||
|
|
||||||
|
[Command("book list", Description = "Lists all books in the library.")]
|
||||||
|
public class BookListCommand(LibraryProvider libraryProvider) : ICommand
|
||||||
{
|
{
|
||||||
[Command("book list", Description = "List all books in the library.")]
|
public ValueTask ExecuteAsync(IConsole console)
|
||||||
public class BookListCommand : ICommand
|
|
||||||
{
|
{
|
||||||
private readonly LibraryService _libraryService;
|
var library = libraryProvider.GetLibrary();
|
||||||
|
|
||||||
public BookListCommand(LibraryService libraryService)
|
for (var i = 0; i < library.Books.Count; i++)
|
||||||
{
|
{
|
||||||
_libraryService = libraryService;
|
// Add margin
|
||||||
|
if (i != 0)
|
||||||
|
console.WriteLine();
|
||||||
|
|
||||||
|
// Render book
|
||||||
|
var book = library.Books[i];
|
||||||
|
console.WriteBook(book);
|
||||||
}
|
}
|
||||||
|
|
||||||
public ValueTask ExecuteAsync(IConsole console)
|
return default;
|
||||||
{
|
|
||||||
var library = _libraryService.GetLibrary();
|
|
||||||
|
|
||||||
var isFirst = true;
|
|
||||||
foreach (var book in library.Books)
|
|
||||||
{
|
|
||||||
// Margin
|
|
||||||
if (!isFirst)
|
|
||||||
console.Output.WriteLine();
|
|
||||||
isFirst = false;
|
|
||||||
|
|
||||||
// Render book
|
|
||||||
console.RenderBook(book);
|
|
||||||
}
|
|
||||||
|
|
||||||
return default;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,35 +1,28 @@
|
|||||||
using System.Threading.Tasks;
|
using System.Threading.Tasks;
|
||||||
using CliFx.Attributes;
|
using CliFx.Attributes;
|
||||||
using CliFx.Demo.Services;
|
using CliFx.Demo.Domain;
|
||||||
using CliFx.Exceptions;
|
using CliFx.Exceptions;
|
||||||
|
using CliFx.Infrastructure;
|
||||||
|
|
||||||
namespace CliFx.Demo.Commands
|
namespace CliFx.Demo.Commands;
|
||||||
|
|
||||||
|
[Command("book remove", Description = "Removes a book from the library.")]
|
||||||
|
public class BookRemoveCommand(LibraryProvider libraryProvider) : ICommand
|
||||||
{
|
{
|
||||||
[Command("book remove", Description = "Remove a book from the library.")]
|
[CommandParameter(0, Name = "title", Description = "Title of the book to remove.")]
|
||||||
public class BookRemoveCommand : ICommand
|
public required string Title { get; init; }
|
||||||
|
|
||||||
|
public ValueTask ExecuteAsync(IConsole console)
|
||||||
{
|
{
|
||||||
private readonly LibraryService _libraryService;
|
var book = libraryProvider.TryGetBook(Title);
|
||||||
|
|
||||||
[CommandParameter(0, Name = "title", Description = "Book title.")]
|
if (book is null)
|
||||||
public string Title { get; set; } = "";
|
throw new CommandException($"Book '{Title}' not found.", 10);
|
||||||
|
|
||||||
public BookRemoveCommand(LibraryService libraryService)
|
libraryProvider.RemoveBook(book);
|
||||||
{
|
|
||||||
_libraryService = libraryService;
|
|
||||||
}
|
|
||||||
|
|
||||||
public ValueTask ExecuteAsync(IConsole console)
|
console.WriteLine($"Book '{Title}' removed.");
|
||||||
{
|
|
||||||
var book = _libraryService.GetBook(Title);
|
|
||||||
|
|
||||||
if (book == null)
|
return default;
|
||||||
throw new CommandException("Book not found.", 1);
|
|
||||||
|
|
||||||
_libraryService.RemoveBook(book);
|
|
||||||
|
|
||||||
console.Output.WriteLine($"Book {Title} removed.");
|
|
||||||
|
|
||||||
return default;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
5
CliFx.Demo/Domain/Book.cs
Normal file
5
CliFx.Demo/Domain/Book.cs
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
using System;
|
||||||
|
|
||||||
|
namespace CliFx.Demo.Domain;
|
||||||
|
|
||||||
|
public record Book(string Title, string Author, DateTimeOffset Published, Isbn Isbn);
|
||||||
31
CliFx.Demo/Domain/Isbn.cs
Normal file
31
CliFx.Demo/Domain/Isbn.cs
Normal file
@@ -0,0 +1,31 @@
|
|||||||
|
using System;
|
||||||
|
|
||||||
|
namespace CliFx.Demo.Domain;
|
||||||
|
|
||||||
|
public partial record Isbn(
|
||||||
|
int EanPrefix,
|
||||||
|
int RegistrationGroup,
|
||||||
|
int Registrant,
|
||||||
|
int Publication,
|
||||||
|
int CheckDigit
|
||||||
|
)
|
||||||
|
{
|
||||||
|
public override string ToString() =>
|
||||||
|
$"{EanPrefix:000}-{RegistrationGroup:00}-{Registrant:00000}-{Publication:00}-{CheckDigit:0}";
|
||||||
|
}
|
||||||
|
|
||||||
|
public partial record Isbn
|
||||||
|
{
|
||||||
|
public static Isbn Parse(string value, IFormatProvider formatProvider)
|
||||||
|
{
|
||||||
|
var components = value.Split('-', 5, StringSplitOptions.RemoveEmptyEntries);
|
||||||
|
|
||||||
|
return new Isbn(
|
||||||
|
int.Parse(components[0], formatProvider),
|
||||||
|
int.Parse(components[1], formatProvider),
|
||||||
|
int.Parse(components[2], formatProvider),
|
||||||
|
int.Parse(components[3], formatProvider),
|
||||||
|
int.Parse(components[4], formatProvider)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
27
CliFx.Demo/Domain/Library.cs
Normal file
27
CliFx.Demo/Domain/Library.cs
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
using System.Collections.Generic;
|
||||||
|
using System.Linq;
|
||||||
|
|
||||||
|
namespace CliFx.Demo.Domain;
|
||||||
|
|
||||||
|
public partial record Library(IReadOnlyList<Book> Books)
|
||||||
|
{
|
||||||
|
public Library WithBook(Book book)
|
||||||
|
{
|
||||||
|
var books = Books.ToList();
|
||||||
|
books.Add(book);
|
||||||
|
|
||||||
|
return new Library(books);
|
||||||
|
}
|
||||||
|
|
||||||
|
public Library WithoutBook(Book book)
|
||||||
|
{
|
||||||
|
var books = Books.Where(b => b != book).ToArray();
|
||||||
|
|
||||||
|
return new Library(books);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public partial record Library
|
||||||
|
{
|
||||||
|
public static Library Empty { get; } = new([]);
|
||||||
|
}
|
||||||
6
CliFx.Demo/Domain/LibraryJsonContext.cs
Normal file
6
CliFx.Demo/Domain/LibraryJsonContext.cs
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
using System.Text.Json.Serialization;
|
||||||
|
|
||||||
|
namespace CliFx.Demo.Domain;
|
||||||
|
|
||||||
|
[JsonSerializable(typeof(Library))]
|
||||||
|
public partial class LibraryJsonContext : JsonSerializerContext;
|
||||||
43
CliFx.Demo/Domain/LibraryProvider.cs
Normal file
43
CliFx.Demo/Domain/LibraryProvider.cs
Normal file
@@ -0,0 +1,43 @@
|
|||||||
|
using System.IO;
|
||||||
|
using System.Linq;
|
||||||
|
using System.Text.Json;
|
||||||
|
|
||||||
|
namespace CliFx.Demo.Domain;
|
||||||
|
|
||||||
|
public class LibraryProvider
|
||||||
|
{
|
||||||
|
private static string StorageFilePath { get; } =
|
||||||
|
Path.Combine(Directory.GetCurrentDirectory(), "Library.json");
|
||||||
|
|
||||||
|
private void StoreLibrary(Library library)
|
||||||
|
{
|
||||||
|
var data = JsonSerializer.Serialize(library, LibraryJsonContext.Default.Library);
|
||||||
|
File.WriteAllText(StorageFilePath, data);
|
||||||
|
}
|
||||||
|
|
||||||
|
public Library GetLibrary()
|
||||||
|
{
|
||||||
|
if (!File.Exists(StorageFilePath))
|
||||||
|
return Library.Empty;
|
||||||
|
|
||||||
|
var data = File.ReadAllText(StorageFilePath);
|
||||||
|
|
||||||
|
return JsonSerializer.Deserialize(data, LibraryJsonContext.Default.Library)
|
||||||
|
?? Library.Empty;
|
||||||
|
}
|
||||||
|
|
||||||
|
public Book? TryGetBook(string title) =>
|
||||||
|
GetLibrary().Books.FirstOrDefault(b => b.Title == title);
|
||||||
|
|
||||||
|
public void AddBook(Book book)
|
||||||
|
{
|
||||||
|
var updatedLibrary = GetLibrary().WithBook(book);
|
||||||
|
StoreLibrary(updatedLibrary);
|
||||||
|
}
|
||||||
|
|
||||||
|
public void RemoveBook(Book book)
|
||||||
|
{
|
||||||
|
var updatedLibrary = GetLibrary().WithoutBook(book);
|
||||||
|
StoreLibrary(updatedLibrary);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,29 +0,0 @@
|
|||||||
using System;
|
|
||||||
using CliFx.Demo.Models;
|
|
||||||
|
|
||||||
namespace CliFx.Demo.Internal
|
|
||||||
{
|
|
||||||
internal static class Extensions
|
|
||||||
{
|
|
||||||
public static void RenderBook(this IConsole console, Book book)
|
|
||||||
{
|
|
||||||
// Title
|
|
||||||
console.WithForegroundColor(ConsoleColor.White, () => console.Output.WriteLine(book.Title));
|
|
||||||
|
|
||||||
// Author
|
|
||||||
console.Output.Write(" ");
|
|
||||||
console.Output.Write("Author: ");
|
|
||||||
console.WithForegroundColor(ConsoleColor.White, () => console.Output.WriteLine(book.Author));
|
|
||||||
|
|
||||||
// Published
|
|
||||||
console.Output.Write(" ");
|
|
||||||
console.Output.Write("Published: ");
|
|
||||||
console.WithForegroundColor(ConsoleColor.White, () => console.Output.WriteLine($"{book.Published:d}"));
|
|
||||||
|
|
||||||
// ISBN
|
|
||||||
console.Output.Write(" ");
|
|
||||||
console.Output.Write("ISBN: ");
|
|
||||||
console.WithForegroundColor(ConsoleColor.White, () => console.Output.WriteLine(book.Isbn));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,23 +0,0 @@
|
|||||||
using System;
|
|
||||||
|
|
||||||
namespace CliFx.Demo.Models
|
|
||||||
{
|
|
||||||
public class Book
|
|
||||||
{
|
|
||||||
public string Title { get; }
|
|
||||||
|
|
||||||
public string Author { get; }
|
|
||||||
|
|
||||||
public DateTimeOffset Published { get; }
|
|
||||||
|
|
||||||
public Isbn Isbn { get; }
|
|
||||||
|
|
||||||
public Book(string title, string author, DateTimeOffset published, Isbn isbn)
|
|
||||||
{
|
|
||||||
Title = title;
|
|
||||||
Author = author;
|
|
||||||
Published = published;
|
|
||||||
Isbn = isbn;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,22 +0,0 @@
|
|||||||
using System.Linq;
|
|
||||||
|
|
||||||
namespace CliFx.Demo.Models
|
|
||||||
{
|
|
||||||
public static class Extensions
|
|
||||||
{
|
|
||||||
public static Library WithBook(this Library library, Book book)
|
|
||||||
{
|
|
||||||
var books = library.Books.ToList();
|
|
||||||
books.Add(book);
|
|
||||||
|
|
||||||
return new Library(books);
|
|
||||||
}
|
|
||||||
|
|
||||||
public static Library WithoutBook(this Library library, Book book)
|
|
||||||
{
|
|
||||||
var books = library.Books.Where(b => b != book).ToArray();
|
|
||||||
|
|
||||||
return new Library(books);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,45 +0,0 @@
|
|||||||
using System;
|
|
||||||
|
|
||||||
namespace CliFx.Demo.Models
|
|
||||||
{
|
|
||||||
public partial class Isbn
|
|
||||||
{
|
|
||||||
public int EanPrefix { get; }
|
|
||||||
|
|
||||||
public int RegistrationGroup { get; }
|
|
||||||
|
|
||||||
public int Registrant { get; }
|
|
||||||
|
|
||||||
public int Publication { get; }
|
|
||||||
|
|
||||||
public int CheckDigit { get; }
|
|
||||||
|
|
||||||
public Isbn(int eanPrefix, int registrationGroup, int registrant, int publication, int checkDigit)
|
|
||||||
{
|
|
||||||
EanPrefix = eanPrefix;
|
|
||||||
RegistrationGroup = registrationGroup;
|
|
||||||
Registrant = registrant;
|
|
||||||
Publication = publication;
|
|
||||||
CheckDigit = checkDigit;
|
|
||||||
}
|
|
||||||
|
|
||||||
public override string ToString() =>
|
|
||||||
$"{EanPrefix:000}-{RegistrationGroup:00}-{Registrant:00000}-{Publication:00}-{CheckDigit:0}";
|
|
||||||
}
|
|
||||||
|
|
||||||
public partial class Isbn
|
|
||||||
{
|
|
||||||
public static Isbn Parse(string value, IFormatProvider formatProvider)
|
|
||||||
{
|
|
||||||
var components = value.Split('-', 5, StringSplitOptions.RemoveEmptyEntries);
|
|
||||||
|
|
||||||
return new Isbn(
|
|
||||||
int.Parse(components[0], formatProvider),
|
|
||||||
int.Parse(components[1], formatProvider),
|
|
||||||
int.Parse(components[2], formatProvider),
|
|
||||||
int.Parse(components[3], formatProvider),
|
|
||||||
int.Parse(components[4], formatProvider)
|
|
||||||
);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,20 +0,0 @@
|
|||||||
using System;
|
|
||||||
using System.Collections.Generic;
|
|
||||||
|
|
||||||
namespace CliFx.Demo.Models
|
|
||||||
{
|
|
||||||
public partial class Library
|
|
||||||
{
|
|
||||||
public IReadOnlyList<Book> Books { get; }
|
|
||||||
|
|
||||||
public Library(IReadOnlyList<Book> books)
|
|
||||||
{
|
|
||||||
Books = books;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
public partial class Library
|
|
||||||
{
|
|
||||||
public static Library Empty { get; } = new Library(Array.Empty<Book>());
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,35 +1,18 @@
|
|||||||
using System;
|
using CliFx;
|
||||||
using System.Threading.Tasks;
|
using CliFx.Demo.Domain;
|
||||||
using CliFx.Demo.Commands;
|
|
||||||
using CliFx.Demo.Services;
|
|
||||||
using Microsoft.Extensions.DependencyInjection;
|
using Microsoft.Extensions.DependencyInjection;
|
||||||
|
|
||||||
namespace CliFx.Demo
|
// We use Microsoft.Extensions.DependencyInjection for injecting dependencies in commands
|
||||||
{
|
var services = new ServiceCollection();
|
||||||
public static class Program
|
services.AddSingleton<LibraryProvider>();
|
||||||
{
|
|
||||||
private static IServiceProvider GetServiceProvider()
|
|
||||||
{
|
|
||||||
// We use Microsoft.Extensions.DependencyInjection for injecting dependencies in commands
|
|
||||||
var services = new ServiceCollection();
|
|
||||||
|
|
||||||
// Register services
|
// Register all commands as transient services
|
||||||
services.AddSingleton<LibraryService>();
|
foreach (var commandType in commandTypes)
|
||||||
|
services.AddTransient(commandType);
|
||||||
|
|
||||||
// Register commands
|
return await new CliApplicationBuilder()
|
||||||
services.AddTransient<BookCommand>();
|
.SetDescription("Demo application showcasing CliFx features.")
|
||||||
services.AddTransient<BookAddCommand>();
|
.AddCommandsFromThisAssembly()
|
||||||
services.AddTransient<BookRemoveCommand>();
|
.UseTypeActivator(services.BuildServiceProvider())
|
||||||
services.AddTransient<BookListCommand>();
|
.Build()
|
||||||
|
.RunAsync();
|
||||||
return services.BuildServiceProvider();
|
|
||||||
}
|
|
||||||
|
|
||||||
public static async Task<int> Main() =>
|
|
||||||
await new CliApplicationBuilder()
|
|
||||||
.AddCommandsFromThisAssembly()
|
|
||||||
.UseTypeActivator(GetServiceProvider().GetService)
|
|
||||||
.Build()
|
|
||||||
.RunAsync();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -1,7 +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 shows basic CliFx functionality such as command routing, argument parsing, autogenerated help text, and some other things.
|
This demo project showcases basic CliFx functionality such as command routing, argument parsing, and autogenerated help text.
|
||||||
|
|
||||||
You can get a list of available commands by running `CliFx.Demo --help`.
|
|
||||||
|
|||||||
@@ -1,42 +0,0 @@
|
|||||||
using System.IO;
|
|
||||||
using System.Linq;
|
|
||||||
using CliFx.Demo.Models;
|
|
||||||
using Newtonsoft.Json;
|
|
||||||
|
|
||||||
namespace CliFx.Demo.Services
|
|
||||||
{
|
|
||||||
public class LibraryService
|
|
||||||
{
|
|
||||||
private string StorageFilePath => Path.Combine(Directory.GetCurrentDirectory(), "Data.json");
|
|
||||||
|
|
||||||
private void StoreLibrary(Library library)
|
|
||||||
{
|
|
||||||
var data = JsonConvert.SerializeObject(library);
|
|
||||||
File.WriteAllText(StorageFilePath, data);
|
|
||||||
}
|
|
||||||
|
|
||||||
public Library GetLibrary()
|
|
||||||
{
|
|
||||||
if (!File.Exists(StorageFilePath))
|
|
||||||
return Library.Empty;
|
|
||||||
|
|
||||||
var data = File.ReadAllText(StorageFilePath);
|
|
||||||
|
|
||||||
return JsonConvert.DeserializeObject<Library>(data);
|
|
||||||
}
|
|
||||||
|
|
||||||
public Book? GetBook(string title) => GetLibrary().Books.FirstOrDefault(b => b.Title == title);
|
|
||||||
|
|
||||||
public void AddBook(Book book)
|
|
||||||
{
|
|
||||||
var updatedLibrary = GetLibrary().WithBook(book);
|
|
||||||
StoreLibrary(updatedLibrary);
|
|
||||||
}
|
|
||||||
|
|
||||||
public void RemoveBook(Book book)
|
|
||||||
{
|
|
||||||
var updatedLibrary = GetLibrary().WithoutBook(book);
|
|
||||||
StoreLibrary(updatedLibrary);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
39
CliFx.Demo/Utils/ConsoleExtensions.cs
Normal file
39
CliFx.Demo/Utils/ConsoleExtensions.cs
Normal file
@@ -0,0 +1,39 @@
|
|||||||
|
using System;
|
||||||
|
using CliFx.Demo.Domain;
|
||||||
|
using CliFx.Infrastructure;
|
||||||
|
|
||||||
|
namespace CliFx.Demo.Utils;
|
||||||
|
|
||||||
|
internal static class ConsoleExtensions
|
||||||
|
{
|
||||||
|
public static void WriteBook(this ConsoleWriter writer, Book book)
|
||||||
|
{
|
||||||
|
// Title
|
||||||
|
using (writer.Console.WithForegroundColor(ConsoleColor.White))
|
||||||
|
writer.WriteLine(book.Title);
|
||||||
|
|
||||||
|
// Author
|
||||||
|
writer.Write(" ");
|
||||||
|
writer.Write("Author: ");
|
||||||
|
|
||||||
|
using (writer.Console.WithForegroundColor(ConsoleColor.White))
|
||||||
|
writer.WriteLine(book.Author);
|
||||||
|
|
||||||
|
// Published
|
||||||
|
writer.Write(" ");
|
||||||
|
writer.Write("Published: ");
|
||||||
|
|
||||||
|
using (writer.Console.WithForegroundColor(ConsoleColor.White))
|
||||||
|
writer.WriteLine($"{book.Published:d}");
|
||||||
|
|
||||||
|
// ISBN
|
||||||
|
writer.Write(" ");
|
||||||
|
writer.Write("ISBN: ");
|
||||||
|
|
||||||
|
using (writer.Console.WithForegroundColor(ConsoleColor.White))
|
||||||
|
writer.WriteLine(book.Isbn);
|
||||||
|
}
|
||||||
|
|
||||||
|
public static void WriteBook(this IConsole console, Book book) =>
|
||||||
|
console.Output.WriteBook(book);
|
||||||
|
}
|
||||||
27
CliFx.SourceGeneration/CliFx.SourceGeneration.csproj
Normal file
27
CliFx.SourceGeneration/CliFx.SourceGeneration.csproj
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
<Project Sdk="Microsoft.NET.Sdk">
|
||||||
|
|
||||||
|
<PropertyGroup>
|
||||||
|
<TargetFramework>netstandard2.0</TargetFramework>
|
||||||
|
<CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies>
|
||||||
|
<GenerateDependencyFile>true</GenerateDependencyFile>
|
||||||
|
<EnforceExtendedAnalyzerRules>true</EnforceExtendedAnalyzerRules>
|
||||||
|
<NoWarn>$(NoWarn);RS1035</NoWarn>
|
||||||
|
</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>
|
||||||
|
<PackageReference Include="CSharpier.MsBuild" Version="0.28.2" PrivateAssets="all" />
|
||||||
|
<!-- Make sure to target the lowest possible version of the compiler for wider support -->
|
||||||
|
<PackageReference Include="Microsoft.CodeAnalysis" Version="4.11.0" PrivateAssets="all" />
|
||||||
|
<PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.11.0" PrivateAssets="all" />
|
||||||
|
<PackageReference Include="PolyShim" Version="1.12.0" PrivateAssets="all" />
|
||||||
|
</ItemGroup>
|
||||||
|
|
||||||
|
</Project>
|
||||||
130
CliFx.SourceGeneration/CommandSchemaGenerator.cs
Normal file
130
CliFx.SourceGeneration/CommandSchemaGenerator.cs
Normal file
@@ -0,0 +1,130 @@
|
|||||||
|
using System.Linq;
|
||||||
|
using CliFx.SourceGeneration.SemanticModel;
|
||||||
|
using CliFx.SourceGeneration.Utils.Extensions;
|
||||||
|
using Microsoft.CodeAnalysis;
|
||||||
|
using Microsoft.CodeAnalysis.CSharp;
|
||||||
|
using Microsoft.CodeAnalysis.CSharp.Syntax;
|
||||||
|
|
||||||
|
namespace CliFx.SourceGeneration;
|
||||||
|
|
||||||
|
[Generator]
|
||||||
|
public class CommandSchemaGenerator : IIncrementalGenerator
|
||||||
|
{
|
||||||
|
public void Initialize(IncrementalGeneratorInitializationContext context)
|
||||||
|
{
|
||||||
|
var values = context.SyntaxProvider.ForAttributeWithMetadataName<(
|
||||||
|
CommandSymbol?,
|
||||||
|
Diagnostic?
|
||||||
|
)>(
|
||||||
|
KnownSymbolNames.CliFxCommandAttribute,
|
||||||
|
(n, _) => n is TypeDeclarationSyntax,
|
||||||
|
(x, _) =>
|
||||||
|
{
|
||||||
|
// Predicate above ensures that these casts are safe
|
||||||
|
var commandTypeSyntax = (TypeDeclarationSyntax)x.TargetNode;
|
||||||
|
var commandTypeSymbol = (INamedTypeSymbol)x.TargetSymbol;
|
||||||
|
|
||||||
|
// Check if the target type and all its containing types are partial
|
||||||
|
if (
|
||||||
|
commandTypeSyntax
|
||||||
|
.AncestorsAndSelf()
|
||||||
|
.Any(a =>
|
||||||
|
a is TypeDeclarationSyntax t
|
||||||
|
&& !t.Modifiers.Any(m => m.IsKind(SyntaxKind.PartialKeyword))
|
||||||
|
)
|
||||||
|
)
|
||||||
|
{
|
||||||
|
return (
|
||||||
|
null,
|
||||||
|
Diagnostic.Create(
|
||||||
|
DiagnosticDescriptors.CommandMustBePartial,
|
||||||
|
commandTypeSyntax.Identifier.GetLocation()
|
||||||
|
)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check if the target type implements ICommand
|
||||||
|
var hasCommandInterface = commandTypeSymbol.AllInterfaces.Any(i =>
|
||||||
|
i.DisplayNameMatches(KnownSymbolNames.CliFxCommandInterface)
|
||||||
|
);
|
||||||
|
|
||||||
|
if (!hasCommandInterface)
|
||||||
|
{
|
||||||
|
return (
|
||||||
|
null,
|
||||||
|
Diagnostic.Create(
|
||||||
|
DiagnosticDescriptors.CommandMustImplementInterface,
|
||||||
|
commandTypeSymbol.Locations.First()
|
||||||
|
)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Resolve the command
|
||||||
|
var commandAttribute = x.Attributes.First(a =>
|
||||||
|
a.AttributeClass?.DisplayNameMatches(KnownSymbolNames.CliFxCommandAttribute)
|
||||||
|
== true
|
||||||
|
);
|
||||||
|
|
||||||
|
var command = CommandSymbol.FromSymbol(commandTypeSymbol, commandAttribute);
|
||||||
|
|
||||||
|
// TODO: validate command
|
||||||
|
|
||||||
|
return (command, null);
|
||||||
|
}
|
||||||
|
);
|
||||||
|
|
||||||
|
// Report diagnostics
|
||||||
|
var diagnostics = values.Select((v, _) => v.Item2).WhereNotNull();
|
||||||
|
context.RegisterSourceOutput(diagnostics, (x, d) => x.ReportDiagnostic(d));
|
||||||
|
|
||||||
|
// Generate command schemas
|
||||||
|
var symbols = values.Select((v, _) => v.Item1).WhereNotNull();
|
||||||
|
context.RegisterSourceOutput(
|
||||||
|
symbols,
|
||||||
|
(x, c) =>
|
||||||
|
x.AddSource(
|
||||||
|
$"{c.Type.FullyQualifiedName}.CommandSchema.Generated.cs",
|
||||||
|
// lang=csharp
|
||||||
|
$$"""
|
||||||
|
namespace {{c.Type.Namespace}};
|
||||||
|
|
||||||
|
partial class {{c.Type.Name}}
|
||||||
|
{
|
||||||
|
public static CliFx.Schema.CommandSchema<{{c.Type.FullyQualifiedName}}> Schema { get; } = {{c.GenerateSchemaInitializationCode()}};
|
||||||
|
}
|
||||||
|
"""
|
||||||
|
)
|
||||||
|
);
|
||||||
|
|
||||||
|
// Generate extension methods
|
||||||
|
var symbolsCollected = symbols.Collect();
|
||||||
|
context.RegisterSourceOutput(
|
||||||
|
symbolsCollected,
|
||||||
|
(x, cs) =>
|
||||||
|
x.AddSource(
|
||||||
|
"CommandSchemaExtensions.Generated.cs",
|
||||||
|
// lang=csharp
|
||||||
|
$$"""
|
||||||
|
namespace CliFx;
|
||||||
|
|
||||||
|
static partial class GeneratedExtensions
|
||||||
|
{
|
||||||
|
public static CliFx.CliApplicationBuilder AddCommandsFromThisAssembly(this CliFx.CliApplicationBuilder builder)
|
||||||
|
{
|
||||||
|
{{
|
||||||
|
cs.Select(c => c.Type.FullyQualifiedName)
|
||||||
|
.Select(t =>
|
||||||
|
// lang=csharp
|
||||||
|
$"builder.AddCommand({t}.Schema);"
|
||||||
|
)
|
||||||
|
.JoinToString("\n")
|
||||||
|
}}
|
||||||
|
|
||||||
|
return builder;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
"""
|
||||||
|
)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
27
CliFx.SourceGeneration/DiagnosticDescriptors.cs
Normal file
27
CliFx.SourceGeneration/DiagnosticDescriptors.cs
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
using CliFx.SourceGeneration.SemanticModel;
|
||||||
|
using Microsoft.CodeAnalysis;
|
||||||
|
|
||||||
|
namespace CliFx.SourceGeneration;
|
||||||
|
|
||||||
|
internal static class DiagnosticDescriptors
|
||||||
|
{
|
||||||
|
public static DiagnosticDescriptor CommandMustBePartial { get; } =
|
||||||
|
new(
|
||||||
|
$"{nameof(CliFx)}_{nameof(CommandMustBePartial)}",
|
||||||
|
"Command types must be declared as `partial`",
|
||||||
|
"This type (and all its containing types, if present) must be declared as `partial` in order to be a valid command.",
|
||||||
|
"CliFx",
|
||||||
|
DiagnosticSeverity.Error,
|
||||||
|
true
|
||||||
|
);
|
||||||
|
|
||||||
|
public static DiagnosticDescriptor CommandMustImplementInterface { get; } =
|
||||||
|
new(
|
||||||
|
$"{nameof(CliFx)}_{nameof(CommandMustImplementInterface)}",
|
||||||
|
$"Commands must implement the `{KnownSymbolNames.CliFxCommandInterface}` interface",
|
||||||
|
$"This type must implement the `{KnownSymbolNames.CliFxCommandInterface}` interface in order to be a valid command.",
|
||||||
|
"CliFx",
|
||||||
|
DiagnosticSeverity.Error,
|
||||||
|
true
|
||||||
|
);
|
||||||
|
}
|
||||||
66
CliFx.SourceGeneration/SemanticModel/CommandInputSymbol.cs
Normal file
66
CliFx.SourceGeneration/SemanticModel/CommandInputSymbol.cs
Normal file
@@ -0,0 +1,66 @@
|
|||||||
|
using System;
|
||||||
|
using System.Collections.Generic;
|
||||||
|
using System.Linq;
|
||||||
|
using Microsoft.CodeAnalysis;
|
||||||
|
|
||||||
|
namespace CliFx.SourceGeneration.SemanticModel;
|
||||||
|
|
||||||
|
internal abstract partial class CommandInputSymbol(
|
||||||
|
PropertyDescriptor property,
|
||||||
|
bool isSequence,
|
||||||
|
string? description,
|
||||||
|
TypeDescriptor? converterType,
|
||||||
|
IReadOnlyList<TypeDescriptor> validatorTypes
|
||||||
|
)
|
||||||
|
{
|
||||||
|
public PropertyDescriptor Property { get; } = property;
|
||||||
|
|
||||||
|
public bool IsSequence { get; } = isSequence;
|
||||||
|
|
||||||
|
public string? Description { get; } = description;
|
||||||
|
|
||||||
|
public TypeDescriptor? ConverterType { get; } = converterType;
|
||||||
|
|
||||||
|
public IReadOnlyList<TypeDescriptor> ValidatorTypes { get; } = validatorTypes;
|
||||||
|
}
|
||||||
|
|
||||||
|
internal partial class CommandInputSymbol : IEquatable<CommandInputSymbol>
|
||||||
|
{
|
||||||
|
public bool Equals(CommandInputSymbol? other)
|
||||||
|
{
|
||||||
|
if (ReferenceEquals(null, other))
|
||||||
|
return false;
|
||||||
|
if (ReferenceEquals(this, other))
|
||||||
|
return true;
|
||||||
|
|
||||||
|
return Property.Equals(other.Property)
|
||||||
|
&& IsSequence == other.IsSequence
|
||||||
|
&& Description == other.Description
|
||||||
|
&& Equals(ConverterType, other.ConverterType)
|
||||||
|
&& ValidatorTypes.SequenceEqual(other.ValidatorTypes);
|
||||||
|
}
|
||||||
|
|
||||||
|
public override bool Equals(object? obj)
|
||||||
|
{
|
||||||
|
if (ReferenceEquals(null, obj))
|
||||||
|
return false;
|
||||||
|
if (ReferenceEquals(this, obj))
|
||||||
|
return true;
|
||||||
|
if (obj.GetType() != GetType())
|
||||||
|
return false;
|
||||||
|
|
||||||
|
return Equals((CommandInputSymbol)obj);
|
||||||
|
}
|
||||||
|
|
||||||
|
public override int GetHashCode() =>
|
||||||
|
HashCode.Combine(Property, IsSequence, Description, ConverterType, ValidatorTypes);
|
||||||
|
}
|
||||||
|
|
||||||
|
internal partial class CommandInputSymbol
|
||||||
|
{
|
||||||
|
public static bool IsSequenceType(ITypeSymbol type) =>
|
||||||
|
type.AllInterfaces.Any(i =>
|
||||||
|
i.SpecialType == SpecialType.System_Collections_Generic_IEnumerable_T
|
||||||
|
)
|
||||||
|
&& type.SpecialType != SpecialType.System_String;
|
||||||
|
}
|
||||||
90
CliFx.SourceGeneration/SemanticModel/CommandOptionSymbol.cs
Normal file
90
CliFx.SourceGeneration/SemanticModel/CommandOptionSymbol.cs
Normal file
@@ -0,0 +1,90 @@
|
|||||||
|
using System;
|
||||||
|
using System.Collections.Generic;
|
||||||
|
using System.Linq;
|
||||||
|
using CliFx.SourceGeneration.Utils.Extensions;
|
||||||
|
using Microsoft.CodeAnalysis;
|
||||||
|
|
||||||
|
namespace CliFx.SourceGeneration.SemanticModel;
|
||||||
|
|
||||||
|
internal partial class CommandOptionSymbol(
|
||||||
|
PropertyDescriptor property,
|
||||||
|
bool isSequence,
|
||||||
|
string? name,
|
||||||
|
char? shortName,
|
||||||
|
string? environmentVariable,
|
||||||
|
bool isRequired,
|
||||||
|
string? description,
|
||||||
|
TypeDescriptor? converterType,
|
||||||
|
IReadOnlyList<TypeDescriptor> validatorTypes
|
||||||
|
) : CommandInputSymbol(property, isSequence, description, converterType, validatorTypes)
|
||||||
|
{
|
||||||
|
public string? Name { get; } = name;
|
||||||
|
|
||||||
|
public char? ShortName { get; } = shortName;
|
||||||
|
|
||||||
|
public string? EnvironmentVariable { get; } = environmentVariable;
|
||||||
|
|
||||||
|
public bool IsRequired { get; } = isRequired;
|
||||||
|
}
|
||||||
|
|
||||||
|
internal partial class CommandOptionSymbol : IEquatable<CommandOptionSymbol>
|
||||||
|
{
|
||||||
|
public bool Equals(CommandOptionSymbol? other)
|
||||||
|
{
|
||||||
|
if (ReferenceEquals(null, other))
|
||||||
|
return false;
|
||||||
|
if (ReferenceEquals(this, other))
|
||||||
|
return true;
|
||||||
|
|
||||||
|
return base.Equals(other)
|
||||||
|
&& Name == other.Name
|
||||||
|
&& ShortName == other.ShortName
|
||||||
|
&& EnvironmentVariable == other.EnvironmentVariable
|
||||||
|
&& IsRequired == other.IsRequired;
|
||||||
|
}
|
||||||
|
|
||||||
|
public override bool Equals(object? obj)
|
||||||
|
{
|
||||||
|
if (ReferenceEquals(null, obj))
|
||||||
|
return false;
|
||||||
|
if (ReferenceEquals(this, obj))
|
||||||
|
return true;
|
||||||
|
if (obj.GetType() != GetType())
|
||||||
|
return false;
|
||||||
|
|
||||||
|
return Equals((CommandOptionSymbol)obj);
|
||||||
|
}
|
||||||
|
|
||||||
|
public override int GetHashCode() =>
|
||||||
|
HashCode.Combine(base.GetHashCode(), Name, ShortName, EnvironmentVariable, IsRequired);
|
||||||
|
}
|
||||||
|
|
||||||
|
internal partial class CommandOptionSymbol
|
||||||
|
{
|
||||||
|
public static CommandOptionSymbol FromSymbol(
|
||||||
|
IPropertySymbol property,
|
||||||
|
AttributeData attribute
|
||||||
|
) =>
|
||||||
|
new(
|
||||||
|
PropertyDescriptor.FromSymbol(property),
|
||||||
|
IsSequenceType(property.Type),
|
||||||
|
attribute
|
||||||
|
.ConstructorArguments.FirstOrDefault(a =>
|
||||||
|
a.Type?.SpecialType == SpecialType.System_String
|
||||||
|
)
|
||||||
|
.Value as string,
|
||||||
|
attribute
|
||||||
|
.ConstructorArguments.FirstOrDefault(a =>
|
||||||
|
a.Type?.SpecialType == SpecialType.System_Char
|
||||||
|
)
|
||||||
|
.Value as char?,
|
||||||
|
attribute.GetNamedArgumentValue("EnvironmentVariable", default(string)),
|
||||||
|
attribute.GetNamedArgumentValue("IsRequired", property.IsRequired),
|
||||||
|
attribute.GetNamedArgumentValue("Description", default(string)),
|
||||||
|
TypeDescriptor.FromSymbol(attribute.GetNamedArgumentValue<ITypeSymbol?>("Converter")),
|
||||||
|
attribute
|
||||||
|
.GetNamedArgumentValues<ITypeSymbol>("Validators")
|
||||||
|
.Select(TypeDescriptor.FromSymbol)
|
||||||
|
.ToArray()
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -0,0 +1,77 @@
|
|||||||
|
using System;
|
||||||
|
using System.Collections.Generic;
|
||||||
|
using System.Linq;
|
||||||
|
using CliFx.SourceGeneration.Utils.Extensions;
|
||||||
|
using Microsoft.CodeAnalysis;
|
||||||
|
|
||||||
|
namespace CliFx.SourceGeneration.SemanticModel;
|
||||||
|
|
||||||
|
internal partial class CommandParameterSymbol(
|
||||||
|
PropertyDescriptor property,
|
||||||
|
bool isSequence,
|
||||||
|
int order,
|
||||||
|
string name,
|
||||||
|
bool isRequired,
|
||||||
|
string? description,
|
||||||
|
TypeDescriptor? converterType,
|
||||||
|
IReadOnlyList<TypeDescriptor> validatorTypes
|
||||||
|
) : CommandInputSymbol(property, isSequence, description, converterType, validatorTypes)
|
||||||
|
{
|
||||||
|
public int Order { get; } = order;
|
||||||
|
|
||||||
|
public string Name { get; } = name;
|
||||||
|
|
||||||
|
public bool IsRequired { get; } = isRequired;
|
||||||
|
}
|
||||||
|
|
||||||
|
internal partial class CommandParameterSymbol : IEquatable<CommandParameterSymbol>
|
||||||
|
{
|
||||||
|
public bool Equals(CommandParameterSymbol? other)
|
||||||
|
{
|
||||||
|
if (ReferenceEquals(null, other))
|
||||||
|
return false;
|
||||||
|
if (ReferenceEquals(this, other))
|
||||||
|
return true;
|
||||||
|
|
||||||
|
return base.Equals(other)
|
||||||
|
&& Order == other.Order
|
||||||
|
&& Name == other.Name
|
||||||
|
&& IsRequired == other.IsRequired;
|
||||||
|
}
|
||||||
|
|
||||||
|
public override bool Equals(object? obj)
|
||||||
|
{
|
||||||
|
if (ReferenceEquals(null, obj))
|
||||||
|
return false;
|
||||||
|
if (ReferenceEquals(this, obj))
|
||||||
|
return true;
|
||||||
|
if (obj.GetType() != GetType())
|
||||||
|
return false;
|
||||||
|
|
||||||
|
return Equals((CommandParameterSymbol)obj);
|
||||||
|
}
|
||||||
|
|
||||||
|
public override int GetHashCode() =>
|
||||||
|
HashCode.Combine(base.GetHashCode(), Order, Name, IsRequired);
|
||||||
|
}
|
||||||
|
|
||||||
|
internal partial class CommandParameterSymbol
|
||||||
|
{
|
||||||
|
public static CommandParameterSymbol FromSymbol(
|
||||||
|
IPropertySymbol property,
|
||||||
|
AttributeData attribute
|
||||||
|
) =>
|
||||||
|
new(
|
||||||
|
PropertyDescriptor.FromSymbol(property),
|
||||||
|
IsSequenceType(property.Type),
|
||||||
|
(int)attribute.ConstructorArguments.First().Value!,
|
||||||
|
attribute.GetNamedArgumentValue("Name", default(string)),
|
||||||
|
attribute.GetNamedArgumentValue("IsRequired", true),
|
||||||
|
attribute.GetNamedArgumentValue("Description", default(string)),
|
||||||
|
TypeDescriptor.FromSymbol(attribute.GetNamedArgumentValue<ITypeSymbol>("Converter")),
|
||||||
|
attribute
|
||||||
|
.GetNamedArgumentValues<ITypeSymbol>("Validators")
|
||||||
|
.Select(TypeDescriptor.FromSymbol)
|
||||||
|
.ToArray()
|
||||||
|
);
|
||||||
|
}
|
||||||
167
CliFx.SourceGeneration/SemanticModel/CommandSymbol.cs
Normal file
167
CliFx.SourceGeneration/SemanticModel/CommandSymbol.cs
Normal file
@@ -0,0 +1,167 @@
|
|||||||
|
using System;
|
||||||
|
using System.Collections.Generic;
|
||||||
|
using System.Linq;
|
||||||
|
using CliFx.SourceGeneration.Utils.Extensions;
|
||||||
|
using Microsoft.CodeAnalysis;
|
||||||
|
|
||||||
|
namespace CliFx.SourceGeneration.SemanticModel;
|
||||||
|
|
||||||
|
internal partial class CommandSymbol(
|
||||||
|
TypeDescriptor type,
|
||||||
|
string? name,
|
||||||
|
string? description,
|
||||||
|
IReadOnlyList<CommandInputSymbol> inputs
|
||||||
|
)
|
||||||
|
{
|
||||||
|
public TypeDescriptor Type { get; } = type;
|
||||||
|
|
||||||
|
public string? Name { get; } = name;
|
||||||
|
|
||||||
|
public string? Description { get; } = description;
|
||||||
|
|
||||||
|
public IReadOnlyList<CommandInputSymbol> Inputs { get; } = inputs;
|
||||||
|
|
||||||
|
public IReadOnlyList<CommandParameterSymbol> Parameters =>
|
||||||
|
Inputs.OfType<CommandParameterSymbol>().ToArray();
|
||||||
|
|
||||||
|
public IReadOnlyList<CommandOptionSymbol> Options =>
|
||||||
|
Inputs.OfType<CommandOptionSymbol>().ToArray();
|
||||||
|
|
||||||
|
private string GeneratePropertyBindingInitializationCode(PropertyDescriptor property) =>
|
||||||
|
// lang=csharp
|
||||||
|
$$"""
|
||||||
|
new CliFx.Schema.PropertyBinding<{{Type.FullyQualifiedName}}, {{property
|
||||||
|
.Type
|
||||||
|
.FullyQualifiedName}}>(
|
||||||
|
(obj) => obj.{{property.Name}},
|
||||||
|
(obj, value) => obj.{{property.Name}} = value
|
||||||
|
)
|
||||||
|
""";
|
||||||
|
|
||||||
|
private string GenerateSchemaInitializationCode(CommandInputSymbol input) =>
|
||||||
|
input switch
|
||||||
|
{
|
||||||
|
CommandParameterSymbol parameter
|
||||||
|
=>
|
||||||
|
// lang=csharp
|
||||||
|
$$"""
|
||||||
|
new CliFx.Schema.CommandParameterSchema<{{Type.FullyQualifiedName}}, {{parameter
|
||||||
|
.Property
|
||||||
|
.Type
|
||||||
|
.FullyQualifiedName}}>(
|
||||||
|
{{GeneratePropertyBindingInitializationCode(parameter.Property)}},
|
||||||
|
{{parameter.IsSequence}},
|
||||||
|
{{parameter.Order}},
|
||||||
|
"{{parameter.Name}}",
|
||||||
|
{{parameter.IsRequired}},
|
||||||
|
"{{parameter.Description}}",
|
||||||
|
// TODO,
|
||||||
|
// TODO
|
||||||
|
);
|
||||||
|
""",
|
||||||
|
CommandOptionSymbol option
|
||||||
|
=>
|
||||||
|
// lang=csharp
|
||||||
|
$$"""
|
||||||
|
new CliFx.Schema.CommandOptionSchema<{{Type.FullyQualifiedName}}, {{option
|
||||||
|
.Property
|
||||||
|
.Type
|
||||||
|
.FullyQualifiedName}}>(
|
||||||
|
{{GeneratePropertyBindingInitializationCode(option.Property)}},
|
||||||
|
{{option.IsSequence}},
|
||||||
|
"{{option.Name}}",
|
||||||
|
'{{option.ShortName}}',
|
||||||
|
"{{option.EnvironmentVariable}}",
|
||||||
|
{{option.IsRequired}},
|
||||||
|
"{{option.Description}}",
|
||||||
|
// TODO,
|
||||||
|
// TODO
|
||||||
|
);
|
||||||
|
""",
|
||||||
|
_ => throw new ArgumentOutOfRangeException(nameof(input), input, null)
|
||||||
|
};
|
||||||
|
|
||||||
|
public string GenerateSchemaInitializationCode() =>
|
||||||
|
// lang=csharp
|
||||||
|
$$"""
|
||||||
|
new CliFx.Schema.CommandSchema<{{Type.FullyQualifiedName}}>(
|
||||||
|
"{{Name}}",
|
||||||
|
"{{Description}}",
|
||||||
|
new CliFx.Schema.CommandInputSchema[]
|
||||||
|
{
|
||||||
|
{{Inputs.Select(GenerateSchemaInitializationCode).JoinToString(",\n")}}
|
||||||
|
}
|
||||||
|
)
|
||||||
|
""";
|
||||||
|
}
|
||||||
|
|
||||||
|
internal partial class CommandSymbol : IEquatable<CommandSymbol>
|
||||||
|
{
|
||||||
|
public bool Equals(CommandSymbol? other)
|
||||||
|
{
|
||||||
|
if (ReferenceEquals(null, other))
|
||||||
|
return false;
|
||||||
|
if (ReferenceEquals(this, other))
|
||||||
|
return true;
|
||||||
|
|
||||||
|
return Type.Equals(other.Type)
|
||||||
|
&& Name == other.Name
|
||||||
|
&& Description == other.Description
|
||||||
|
&& Inputs.SequenceEqual(other.Inputs);
|
||||||
|
}
|
||||||
|
|
||||||
|
public override bool Equals(object? obj)
|
||||||
|
{
|
||||||
|
if (ReferenceEquals(null, obj))
|
||||||
|
return false;
|
||||||
|
if (ReferenceEquals(this, obj))
|
||||||
|
return true;
|
||||||
|
if (obj.GetType() != GetType())
|
||||||
|
return false;
|
||||||
|
|
||||||
|
return Equals((CommandSymbol)obj);
|
||||||
|
}
|
||||||
|
|
||||||
|
public override int GetHashCode() => HashCode.Combine(Type, Name, Description, Inputs);
|
||||||
|
}
|
||||||
|
|
||||||
|
internal partial class CommandSymbol
|
||||||
|
{
|
||||||
|
public static CommandSymbol FromSymbol(INamedTypeSymbol symbol, AttributeData attribute)
|
||||||
|
{
|
||||||
|
var inputs = new List<CommandInputSymbol>();
|
||||||
|
foreach (var property in symbol.GetMembers().OfType<IPropertySymbol>())
|
||||||
|
{
|
||||||
|
var parameterAttribute = property
|
||||||
|
.GetAttributes()
|
||||||
|
.FirstOrDefault(a =>
|
||||||
|
a.AttributeClass?.Name == KnownSymbolNames.CliFxCommandParameterAttribute
|
||||||
|
);
|
||||||
|
|
||||||
|
if (parameterAttribute is not null)
|
||||||
|
{
|
||||||
|
inputs.Add(CommandParameterSymbol.FromSymbol(property, parameterAttribute));
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
var optionAttribute = property
|
||||||
|
.GetAttributes()
|
||||||
|
.FirstOrDefault(a =>
|
||||||
|
a.AttributeClass?.Name == KnownSymbolNames.CliFxCommandOptionAttribute
|
||||||
|
);
|
||||||
|
|
||||||
|
if (optionAttribute is not null)
|
||||||
|
{
|
||||||
|
inputs.Add(CommandOptionSymbol.FromSymbol(property, optionAttribute));
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return new CommandSymbol(
|
||||||
|
TypeDescriptor.FromSymbol(symbol),
|
||||||
|
attribute.ConstructorArguments.FirstOrDefault().Value as string,
|
||||||
|
attribute.GetNamedArgumentValue("Description", default(string)),
|
||||||
|
inputs
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
10
CliFx.SourceGeneration/SemanticModel/KnownSymbolNames.cs
Normal file
10
CliFx.SourceGeneration/SemanticModel/KnownSymbolNames.cs
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
namespace CliFx.SourceGeneration.SemanticModel;
|
||||||
|
|
||||||
|
internal static class KnownSymbolNames
|
||||||
|
{
|
||||||
|
public const string CliFxCommandInterface = "CliFx.ICommand";
|
||||||
|
public const string CliFxCommandAttribute = "CliFx.Attributes.CommandAttribute";
|
||||||
|
public const string CliFxCommandParameterAttribute =
|
||||||
|
"CliFx.Attributes.CommandParameterAttribute";
|
||||||
|
public const string CliFxCommandOptionAttribute = "CliFx.Attributes.CommandOptionAttribute";
|
||||||
|
}
|
||||||
44
CliFx.SourceGeneration/SemanticModel/PropertyDescriptor.cs
Normal file
44
CliFx.SourceGeneration/SemanticModel/PropertyDescriptor.cs
Normal file
@@ -0,0 +1,44 @@
|
|||||||
|
using System;
|
||||||
|
using Microsoft.CodeAnalysis;
|
||||||
|
|
||||||
|
namespace CliFx.SourceGeneration.SemanticModel;
|
||||||
|
|
||||||
|
internal partial class PropertyDescriptor(TypeDescriptor type, string name)
|
||||||
|
{
|
||||||
|
public TypeDescriptor Type { get; } = type;
|
||||||
|
|
||||||
|
public string Name { get; } = name;
|
||||||
|
}
|
||||||
|
|
||||||
|
internal partial class PropertyDescriptor : IEquatable<PropertyDescriptor>
|
||||||
|
{
|
||||||
|
public bool Equals(PropertyDescriptor? other)
|
||||||
|
{
|
||||||
|
if (ReferenceEquals(null, other))
|
||||||
|
return false;
|
||||||
|
if (ReferenceEquals(this, other))
|
||||||
|
return true;
|
||||||
|
|
||||||
|
return Type.Equals(other.Type) && Name == other.Name;
|
||||||
|
}
|
||||||
|
|
||||||
|
public override bool Equals(object? obj)
|
||||||
|
{
|
||||||
|
if (ReferenceEquals(null, obj))
|
||||||
|
return false;
|
||||||
|
if (ReferenceEquals(this, obj))
|
||||||
|
return true;
|
||||||
|
if (obj.GetType() != GetType())
|
||||||
|
return false;
|
||||||
|
|
||||||
|
return Equals((PropertyDescriptor)obj);
|
||||||
|
}
|
||||||
|
|
||||||
|
public override int GetHashCode() => HashCode.Combine(Type, Name);
|
||||||
|
}
|
||||||
|
|
||||||
|
internal partial class PropertyDescriptor
|
||||||
|
{
|
||||||
|
public static PropertyDescriptor FromSymbol(IPropertySymbol symbol) =>
|
||||||
|
new(TypeDescriptor.FromSymbol(symbol.Type), symbol.Name);
|
||||||
|
}
|
||||||
47
CliFx.SourceGeneration/SemanticModel/TypeDescriptor.cs
Normal file
47
CliFx.SourceGeneration/SemanticModel/TypeDescriptor.cs
Normal file
@@ -0,0 +1,47 @@
|
|||||||
|
using System;
|
||||||
|
using CliFx.SourceGeneration.Utils.Extensions;
|
||||||
|
using Microsoft.CodeAnalysis;
|
||||||
|
|
||||||
|
namespace CliFx.SourceGeneration.SemanticModel;
|
||||||
|
|
||||||
|
internal partial class TypeDescriptor(string fullyQualifiedName)
|
||||||
|
{
|
||||||
|
public string FullyQualifiedName { get; } = fullyQualifiedName;
|
||||||
|
|
||||||
|
public string Namespace { get; } = fullyQualifiedName.SubstringUntilLast(".");
|
||||||
|
|
||||||
|
public string Name { get; } = fullyQualifiedName.SubstringAfterLast(".");
|
||||||
|
}
|
||||||
|
|
||||||
|
internal partial class TypeDescriptor : IEquatable<TypeDescriptor>
|
||||||
|
{
|
||||||
|
public bool Equals(TypeDescriptor? other)
|
||||||
|
{
|
||||||
|
if (ReferenceEquals(null, other))
|
||||||
|
return false;
|
||||||
|
if (ReferenceEquals(this, other))
|
||||||
|
return true;
|
||||||
|
|
||||||
|
return FullyQualifiedName == other.FullyQualifiedName;
|
||||||
|
}
|
||||||
|
|
||||||
|
public override bool Equals(object? obj)
|
||||||
|
{
|
||||||
|
if (ReferenceEquals(null, obj))
|
||||||
|
return false;
|
||||||
|
if (ReferenceEquals(this, obj))
|
||||||
|
return true;
|
||||||
|
if (obj.GetType() != GetType())
|
||||||
|
return false;
|
||||||
|
|
||||||
|
return Equals((TypeDescriptor)obj);
|
||||||
|
}
|
||||||
|
|
||||||
|
public override int GetHashCode() => FullyQualifiedName.GetHashCode();
|
||||||
|
}
|
||||||
|
|
||||||
|
internal partial class TypeDescriptor
|
||||||
|
{
|
||||||
|
public static TypeDescriptor FromSymbol(ITypeSymbol symbol) =>
|
||||||
|
new(symbol.ToDisplayString(SymbolDisplayFormat.FullyQualifiedFormat));
|
||||||
|
}
|
||||||
@@ -0,0 +1,16 @@
|
|||||||
|
using System.Collections.Generic;
|
||||||
|
|
||||||
|
namespace CliFx.SourceGeneration.Utils.Extensions;
|
||||||
|
|
||||||
|
internal static class CollectionExtensions
|
||||||
|
{
|
||||||
|
public static IEnumerable<T> WhereNotNull<T>(this IEnumerable<T?> source)
|
||||||
|
where T : class
|
||||||
|
{
|
||||||
|
foreach (var i in source)
|
||||||
|
{
|
||||||
|
if (i is not null)
|
||||||
|
yield return i;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
using System;
|
||||||
|
|
||||||
|
namespace CliFx.SourceGeneration.Utils.Extensions;
|
||||||
|
|
||||||
|
internal static class GenericExtensions
|
||||||
|
{
|
||||||
|
public static TOut Pipe<TIn, TOut>(this TIn input, Func<TIn, TOut> transform) =>
|
||||||
|
transform(input);
|
||||||
|
}
|
||||||
39
CliFx.SourceGeneration/Utils/Extensions/RoslynExtensions.cs
Normal file
39
CliFx.SourceGeneration/Utils/Extensions/RoslynExtensions.cs
Normal file
@@ -0,0 +1,39 @@
|
|||||||
|
using System;
|
||||||
|
using System.Collections.Generic;
|
||||||
|
using System.Collections.Immutable;
|
||||||
|
using System.Linq;
|
||||||
|
using Microsoft.CodeAnalysis;
|
||||||
|
|
||||||
|
namespace CliFx.SourceGeneration.Utils.Extensions;
|
||||||
|
|
||||||
|
internal static class RoslynExtensions
|
||||||
|
{
|
||||||
|
public static bool DisplayNameMatches(this ISymbol symbol, string name) =>
|
||||||
|
string.Equals(
|
||||||
|
// Fully qualified name, without `global::`
|
||||||
|
symbol.ToDisplayString(SymbolDisplayFormat.CSharpErrorMessageFormat),
|
||||||
|
name,
|
||||||
|
StringComparison.Ordinal
|
||||||
|
);
|
||||||
|
|
||||||
|
public static T GetNamedArgumentValue<T>(
|
||||||
|
this AttributeData attribute,
|
||||||
|
string name,
|
||||||
|
T defaultValue = default
|
||||||
|
) =>
|
||||||
|
attribute.NamedArguments.FirstOrDefault(i => i.Key == name).Value.Value is T valueAsT
|
||||||
|
? valueAsT
|
||||||
|
: defaultValue;
|
||||||
|
|
||||||
|
public static IReadOnlyList<T> GetNamedArgumentValues<T>(
|
||||||
|
this AttributeData attribute,
|
||||||
|
string name
|
||||||
|
)
|
||||||
|
where T : class =>
|
||||||
|
attribute.NamedArguments.FirstOrDefault(i => i.Key == name).Value.Values.CastArray<T>();
|
||||||
|
|
||||||
|
public static IncrementalValuesProvider<T> WhereNotNull<T>(
|
||||||
|
this IncrementalValuesProvider<T?> values
|
||||||
|
)
|
||||||
|
where T : class => values.Where(i => i is not null);
|
||||||
|
}
|
||||||
30
CliFx.SourceGeneration/Utils/Extensions/StringExtensions.cs
Normal file
30
CliFx.SourceGeneration/Utils/Extensions/StringExtensions.cs
Normal file
@@ -0,0 +1,30 @@
|
|||||||
|
using System;
|
||||||
|
using System.Collections.Generic;
|
||||||
|
|
||||||
|
namespace CliFx.SourceGeneration.Utils.Extensions;
|
||||||
|
|
||||||
|
internal static class StringExtensions
|
||||||
|
{
|
||||||
|
public static string SubstringUntilLast(
|
||||||
|
this string str,
|
||||||
|
string sub,
|
||||||
|
StringComparison comparison = StringComparison.Ordinal
|
||||||
|
)
|
||||||
|
{
|
||||||
|
var index = str.LastIndexOf(sub, comparison);
|
||||||
|
return index < 0 ? str : str[..index];
|
||||||
|
}
|
||||||
|
|
||||||
|
public static string SubstringAfterLast(
|
||||||
|
this string str,
|
||||||
|
string sub,
|
||||||
|
StringComparison comparison = StringComparison.Ordinal
|
||||||
|
)
|
||||||
|
{
|
||||||
|
var index = str.LastIndexOf(sub, comparison);
|
||||||
|
return index >= 0 ? str.Substring(index + sub.Length, str.Length - index - sub.Length) : "";
|
||||||
|
}
|
||||||
|
|
||||||
|
public static string JoinToString<T>(this IEnumerable<T> source, string separator) =>
|
||||||
|
string.Join(separator, source);
|
||||||
|
}
|
||||||
@@ -1,14 +1,18 @@
|
|||||||
<Project Sdk="Microsoft.NET.Sdk">
|
<Project Sdk="Microsoft.NET.Sdk">
|
||||||
<Import Project="../CliFx.props" />
|
|
||||||
|
|
||||||
<PropertyGroup>
|
<PropertyGroup>
|
||||||
<OutputType>Exe</OutputType>
|
<OutputType>Exe</OutputType>
|
||||||
<TargetFramework>netcoreapp3.1</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.SourceGeneration\CliFx.SourceGeneration.csproj" ReferenceOutputAssembly="false" OutputItemType="analyzer" />
|
||||||
</ItemGroup>
|
</ItemGroup>
|
||||||
|
|
||||||
</Project>
|
</Project>
|
||||||
27
CliFx.Tests.Dummy/Commands/CancellationTestCommand.cs
Normal file
27
CliFx.Tests.Dummy/Commands/CancellationTestCommand.cs
Normal 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;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,23 +1,23 @@
|
|||||||
using System;
|
using System;
|
||||||
using System.Threading.Tasks;
|
using System.Threading.Tasks;
|
||||||
using CliFx.Attributes;
|
using CliFx.Attributes;
|
||||||
|
using CliFx.Infrastructure;
|
||||||
|
|
||||||
namespace CliFx.Tests.Dummy.Commands
|
namespace CliFx.Tests.Dummy.Commands;
|
||||||
|
|
||||||
|
[Command("console-test")]
|
||||||
|
public class ConsoleTestCommand : ICommand
|
||||||
{
|
{
|
||||||
[Command("console-test")]
|
public ValueTask ExecuteAsync(IConsole console)
|
||||||
public class ConsoleTestCommand : ICommand
|
|
||||||
{
|
{
|
||||||
public ValueTask ExecuteAsync(IConsole console)
|
var input = console.Input.ReadToEnd();
|
||||||
|
|
||||||
|
using (console.WithColors(ConsoleColor.Black, ConsoleColor.White))
|
||||||
{
|
{
|
||||||
var input = console.Input.ReadToEnd();
|
console.Output.WriteLine(input);
|
||||||
|
console.Error.WriteLine(input);
|
||||||
console.WithColors(ConsoleColor.Black, ConsoleColor.White, () =>
|
|
||||||
{
|
|
||||||
console.Output.WriteLine(input);
|
|
||||||
console.Error.WriteLine(input);
|
|
||||||
});
|
|
||||||
|
|
||||||
return default;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
return default;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
18
CliFx.Tests.Dummy/Commands/EnvironmentTestCommand.cs
Normal file
18
CliFx.Tests.Dummy/Commands/EnvironmentTestCommand.cs
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
using System.Threading.Tasks;
|
||||||
|
using CliFx.Attributes;
|
||||||
|
using CliFx.Infrastructure;
|
||||||
|
|
||||||
|
namespace CliFx.Tests.Dummy.Commands;
|
||||||
|
|
||||||
|
[Command("env-test")]
|
||||||
|
public class EnvironmentTestCommand : ICommand
|
||||||
|
{
|
||||||
|
[CommandOption("target", EnvironmentVariable = "ENV_TARGET")]
|
||||||
|
public string GreetingTarget { get; init; } = "World";
|
||||||
|
|
||||||
|
public ValueTask ExecuteAsync(IConsole console)
|
||||||
|
{
|
||||||
|
console.WriteLine($"Hello {GreetingTarget}!");
|
||||||
|
return default;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,19 +0,0 @@
|
|||||||
using System.Threading.Tasks;
|
|
||||||
using CliFx.Attributes;
|
|
||||||
|
|
||||||
namespace CliFx.Tests.Dummy.Commands
|
|
||||||
{
|
|
||||||
[Command]
|
|
||||||
public class HelloWorldCommand : ICommand
|
|
||||||
{
|
|
||||||
[CommandOption("target", EnvironmentVariableName = "ENV_TARGET")]
|
|
||||||
public string Target { get; set; } = "World";
|
|
||||||
|
|
||||||
public ValueTask ExecuteAsync(IConsole console)
|
|
||||||
{
|
|
||||||
console.Output.WriteLine($"Hello {Target}!");
|
|
||||||
|
|
||||||
return default;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,21 +1,28 @@
|
|||||||
using System.Reflection;
|
using System;
|
||||||
|
using System.IO;
|
||||||
|
using System.Reflection;
|
||||||
using System.Threading.Tasks;
|
using System.Threading.Tasks;
|
||||||
|
|
||||||
namespace CliFx.Tests.Dummy
|
namespace CliFx.Tests.Dummy;
|
||||||
|
|
||||||
|
// This dummy application is used in tests for scenarios that require an external process to properly verify
|
||||||
|
public static class Program
|
||||||
{
|
{
|
||||||
public static partial class Program
|
// Path to the apphost
|
||||||
{
|
public static string FilePath { get; } =
|
||||||
public static Assembly Assembly { get; } = typeof(Program).Assembly;
|
Path.ChangeExtension(
|
||||||
|
Assembly.GetExecutingAssembly().Location,
|
||||||
|
OperatingSystem.IsWindows() ? "exe" : null
|
||||||
|
);
|
||||||
|
|
||||||
public static string Location { get; } = Assembly.Location;
|
public static async Task Main()
|
||||||
}
|
|
||||||
|
|
||||||
public static partial class Program
|
|
||||||
{
|
{
|
||||||
public static async Task Main() =>
|
// Make sure color codes are not produced because we rely on the output in tests
|
||||||
await new CliApplicationBuilder()
|
Environment.SetEnvironmentVariable(
|
||||||
.AddCommandsFromThisAssembly()
|
"DOTNET_SYSTEM_CONSOLE_ALLOW_ANSI_COLOR_REDIRECTION",
|
||||||
.Build()
|
"false"
|
||||||
.RunAsync();
|
);
|
||||||
|
|
||||||
|
await new CliApplicationBuilder().AddCommandsFromThisAssembly().Build().RunAsync();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,375 +1,71 @@
|
|||||||
using System;
|
using System;
|
||||||
using System.IO;
|
using System.Collections.Generic;
|
||||||
using System.Threading.Tasks;
|
using System.Threading.Tasks;
|
||||||
using CliFx.Tests.Commands;
|
using CliFx.Tests.Utils;
|
||||||
using CliFx.Tests.Commands.Invalid;
|
|
||||||
using FluentAssertions;
|
using FluentAssertions;
|
||||||
using Xunit;
|
using Xunit;
|
||||||
using Xunit.Abstractions;
|
using Xunit.Abstractions;
|
||||||
|
|
||||||
namespace CliFx.Tests
|
namespace CliFx.Tests;
|
||||||
|
|
||||||
|
public class ApplicationSpecs(ITestOutputHelper testOutput) : SpecsBase(testOutput)
|
||||||
{
|
{
|
||||||
public class ApplicationSpecs
|
[Fact]
|
||||||
|
public async Task I_can_create_an_application_with_the_default_configuration()
|
||||||
{
|
{
|
||||||
private readonly ITestOutputHelper _output;
|
// Act
|
||||||
|
var app = new CliApplicationBuilder()
|
||||||
|
.AddCommandsFromThisAssembly()
|
||||||
|
.UseConsole(FakeConsole)
|
||||||
|
.Build();
|
||||||
|
|
||||||
public ApplicationSpecs(ITestOutputHelper output) => _output = output;
|
var exitCode = await app.RunAsync([], new Dictionary<string, string>());
|
||||||
|
|
||||||
[Fact]
|
// Assert
|
||||||
public void Application_can_be_created_with_a_default_configuration()
|
exitCode.Should().Be(0);
|
||||||
{
|
|
||||||
// Act
|
|
||||||
var app = new CliApplicationBuilder()
|
|
||||||
.AddCommandsFromThisAssembly()
|
|
||||||
.Build();
|
|
||||||
|
|
||||||
// Assert
|
|
||||||
app.Should().NotBeNull();
|
|
||||||
}
|
|
||||||
|
|
||||||
[Fact]
|
|
||||||
public void Application_can_be_created_with_a_custom_configuration()
|
|
||||||
{
|
|
||||||
// Act
|
|
||||||
var app = new CliApplicationBuilder()
|
|
||||||
.AddCommand<DefaultCommand>()
|
|
||||||
.AddCommandsFrom(typeof(DefaultCommand).Assembly)
|
|
||||||
.AddCommands(new[] {typeof(DefaultCommand)})
|
|
||||||
.AddCommandsFrom(new[] {typeof(DefaultCommand).Assembly})
|
|
||||||
.AddCommandsFromThisAssembly()
|
|
||||||
.AllowDebugMode()
|
|
||||||
.AllowPreviewMode()
|
|
||||||
.UseTitle("test")
|
|
||||||
.UseExecutableName("test")
|
|
||||||
.UseVersionText("test")
|
|
||||||
.UseDescription("test")
|
|
||||||
.UseConsole(new VirtualConsole(Stream.Null))
|
|
||||||
.UseTypeActivator(Activator.CreateInstance!)
|
|
||||||
.Build();
|
|
||||||
|
|
||||||
// Assert
|
|
||||||
app.Should().NotBeNull();
|
|
||||||
}
|
|
||||||
|
|
||||||
[Fact]
|
|
||||||
public async Task At_least_one_command_must_be_defined_in_an_application()
|
|
||||||
{
|
|
||||||
var (console, _, stdErr) = VirtualConsole.CreateBuffered();
|
|
||||||
|
|
||||||
var application = new CliApplicationBuilder()
|
|
||||||
.UseConsole(console)
|
|
||||||
.Build();
|
|
||||||
|
|
||||||
// Act
|
|
||||||
var exitCode = await application.RunAsync(Array.Empty<string>());
|
|
||||||
|
|
||||||
// Assert
|
|
||||||
exitCode.Should().NotBe(0);
|
|
||||||
stdErr.GetString().Should().NotBeNullOrWhiteSpace();
|
|
||||||
|
|
||||||
_output.WriteLine(stdErr.GetString());
|
|
||||||
}
|
|
||||||
|
|
||||||
[Fact]
|
|
||||||
public async Task Commands_must_implement_the_corresponding_interface()
|
|
||||||
{
|
|
||||||
var (console, _, stdErr) = VirtualConsole.CreateBuffered();
|
|
||||||
|
|
||||||
var application = new CliApplicationBuilder()
|
|
||||||
.AddCommand(typeof(NonImplementedCommand))
|
|
||||||
.UseConsole(console)
|
|
||||||
.Build();
|
|
||||||
|
|
||||||
// Act
|
|
||||||
var exitCode = await application.RunAsync(Array.Empty<string>());
|
|
||||||
|
|
||||||
// Assert
|
|
||||||
exitCode.Should().NotBe(0);
|
|
||||||
stdErr.GetString().Should().NotBeNullOrWhiteSpace();
|
|
||||||
|
|
||||||
_output.WriteLine(stdErr.GetString());
|
|
||||||
}
|
|
||||||
|
|
||||||
[Fact]
|
|
||||||
public async Task Commands_must_be_annotated_by_an_attribute()
|
|
||||||
{
|
|
||||||
var (console, _, stdErr) = VirtualConsole.CreateBuffered();
|
|
||||||
|
|
||||||
var application = new CliApplicationBuilder()
|
|
||||||
.AddCommand<NonAnnotatedCommand>()
|
|
||||||
.UseConsole(console)
|
|
||||||
.Build();
|
|
||||||
|
|
||||||
// Act
|
|
||||||
var exitCode = await application.RunAsync(Array.Empty<string>());
|
|
||||||
|
|
||||||
// Assert
|
|
||||||
exitCode.Should().NotBe(0);
|
|
||||||
stdErr.GetString().Should().NotBeNullOrWhiteSpace();
|
|
||||||
|
|
||||||
_output.WriteLine(stdErr.GetString());
|
|
||||||
}
|
|
||||||
|
|
||||||
[Fact]
|
|
||||||
public async Task Commands_must_have_unique_names()
|
|
||||||
{
|
|
||||||
var (console, _, stdErr) = VirtualConsole.CreateBuffered();
|
|
||||||
|
|
||||||
var application = new CliApplicationBuilder()
|
|
||||||
.AddCommand<GenericExceptionCommand>()
|
|
||||||
.AddCommand<CommandExceptionCommand>()
|
|
||||||
.UseConsole(console)
|
|
||||||
.Build();
|
|
||||||
|
|
||||||
// Act
|
|
||||||
var exitCode = await application.RunAsync(Array.Empty<string>());
|
|
||||||
|
|
||||||
// Assert
|
|
||||||
exitCode.Should().NotBe(0);
|
|
||||||
stdErr.GetString().Should().NotBeNullOrWhiteSpace();
|
|
||||||
|
|
||||||
_output.WriteLine(stdErr.GetString());
|
|
||||||
}
|
|
||||||
|
|
||||||
[Fact]
|
|
||||||
public async Task Command_can_be_default_but_only_if_it_is_the_only_such_command()
|
|
||||||
{
|
|
||||||
var (console, _, stdErr) = VirtualConsole.CreateBuffered();
|
|
||||||
|
|
||||||
var application = new CliApplicationBuilder()
|
|
||||||
.AddCommand<DefaultCommand>()
|
|
||||||
.AddCommand<OtherDefaultCommand>()
|
|
||||||
.UseConsole(console)
|
|
||||||
.Build();
|
|
||||||
|
|
||||||
// Act
|
|
||||||
var exitCode = await application.RunAsync(Array.Empty<string>());
|
|
||||||
|
|
||||||
// Assert
|
|
||||||
exitCode.Should().NotBe(0);
|
|
||||||
stdErr.GetString().Should().NotBeNullOrWhiteSpace();
|
|
||||||
|
|
||||||
_output.WriteLine(stdErr.GetString());
|
|
||||||
}
|
|
||||||
|
|
||||||
[Fact]
|
|
||||||
public async Task Command_parameters_must_have_unique_order()
|
|
||||||
{
|
|
||||||
var (console, _, stdErr) = VirtualConsole.CreateBuffered();
|
|
||||||
|
|
||||||
var application = new CliApplicationBuilder()
|
|
||||||
.AddCommand<DuplicateParameterOrderCommand>()
|
|
||||||
.UseConsole(console)
|
|
||||||
.Build();
|
|
||||||
|
|
||||||
// Act
|
|
||||||
var exitCode = await application.RunAsync(Array.Empty<string>());
|
|
||||||
|
|
||||||
// Assert
|
|
||||||
exitCode.Should().NotBe(0);
|
|
||||||
stdErr.GetString().Should().NotBeNullOrWhiteSpace();
|
|
||||||
|
|
||||||
_output.WriteLine(stdErr.GetString());
|
|
||||||
}
|
|
||||||
|
|
||||||
[Fact]
|
|
||||||
public async Task Command_parameters_must_have_unique_names()
|
|
||||||
{
|
|
||||||
var (console, _, stdErr) = VirtualConsole.CreateBuffered();
|
|
||||||
|
|
||||||
var application = new CliApplicationBuilder()
|
|
||||||
.AddCommand<DuplicateParameterNameCommand>()
|
|
||||||
.UseConsole(console)
|
|
||||||
.Build();
|
|
||||||
|
|
||||||
// Act
|
|
||||||
var exitCode = await application.RunAsync(Array.Empty<string>());
|
|
||||||
|
|
||||||
// Assert
|
|
||||||
exitCode.Should().NotBe(0);
|
|
||||||
stdErr.GetString().Should().NotBeNullOrWhiteSpace();
|
|
||||||
|
|
||||||
_output.WriteLine(stdErr.GetString());
|
|
||||||
}
|
|
||||||
|
|
||||||
[Fact]
|
|
||||||
public async Task Command_parameter_can_be_non_scalar_only_if_no_other_such_parameter_is_present()
|
|
||||||
{
|
|
||||||
var (console, _, stdErr) = VirtualConsole.CreateBuffered();
|
|
||||||
|
|
||||||
var application = new CliApplicationBuilder()
|
|
||||||
.AddCommand<MultipleNonScalarParametersCommand>()
|
|
||||||
.UseConsole(console)
|
|
||||||
.Build();
|
|
||||||
|
|
||||||
// Act
|
|
||||||
var exitCode = await application.RunAsync(Array.Empty<string>());
|
|
||||||
|
|
||||||
// Assert
|
|
||||||
exitCode.Should().NotBe(0);
|
|
||||||
stdErr.GetString().Should().NotBeNullOrWhiteSpace();
|
|
||||||
|
|
||||||
_output.WriteLine(stdErr.GetString());
|
|
||||||
}
|
|
||||||
|
|
||||||
[Fact]
|
|
||||||
public async Task Command_parameter_can_be_non_scalar_only_if_it_is_the_last_in_order()
|
|
||||||
{
|
|
||||||
var (console, _, stdErr) = VirtualConsole.CreateBuffered();
|
|
||||||
|
|
||||||
var application = new CliApplicationBuilder()
|
|
||||||
.AddCommand<NonLastNonScalarParameterCommand>()
|
|
||||||
.UseConsole(console)
|
|
||||||
.Build();
|
|
||||||
|
|
||||||
// Act
|
|
||||||
var exitCode = await application.RunAsync(Array.Empty<string>());
|
|
||||||
|
|
||||||
// Assert
|
|
||||||
exitCode.Should().NotBe(0);
|
|
||||||
stdErr.GetString().Should().NotBeNullOrWhiteSpace();
|
|
||||||
|
|
||||||
_output.WriteLine(stdErr.GetString());
|
|
||||||
}
|
|
||||||
|
|
||||||
[Fact]
|
|
||||||
public async Task Command_options_must_have_names_that_are_not_empty()
|
|
||||||
{
|
|
||||||
var (console, _, stdErr) = VirtualConsole.CreateBuffered();
|
|
||||||
|
|
||||||
var application = new CliApplicationBuilder()
|
|
||||||
.AddCommand<EmptyOptionNameCommand>()
|
|
||||||
.UseConsole(console)
|
|
||||||
.Build();
|
|
||||||
|
|
||||||
// Act
|
|
||||||
var exitCode = await application.RunAsync(Array.Empty<string>());
|
|
||||||
|
|
||||||
// Assert
|
|
||||||
exitCode.Should().NotBe(0);
|
|
||||||
stdErr.GetString().Should().NotBeNullOrWhiteSpace();
|
|
||||||
|
|
||||||
_output.WriteLine(stdErr.GetString());
|
|
||||||
}
|
|
||||||
|
|
||||||
[Fact]
|
|
||||||
public async Task Command_options_must_have_names_that_are_longer_than_one_character()
|
|
||||||
{
|
|
||||||
var (console, _, stdErr) = VirtualConsole.CreateBuffered();
|
|
||||||
|
|
||||||
var application = new CliApplicationBuilder()
|
|
||||||
.AddCommand<SingleCharacterOptionNameCommand>()
|
|
||||||
.UseConsole(console)
|
|
||||||
.Build();
|
|
||||||
|
|
||||||
// Act
|
|
||||||
var exitCode = await application.RunAsync(Array.Empty<string>());
|
|
||||||
|
|
||||||
// Assert
|
|
||||||
exitCode.Should().NotBe(0);
|
|
||||||
stdErr.GetString().Should().NotBeNullOrWhiteSpace();
|
|
||||||
|
|
||||||
_output.WriteLine(stdErr.GetString());
|
|
||||||
}
|
|
||||||
|
|
||||||
[Fact]
|
|
||||||
public async Task Command_options_must_have_unique_names()
|
|
||||||
{
|
|
||||||
var (console, _, stdErr) = VirtualConsole.CreateBuffered();
|
|
||||||
|
|
||||||
var application = new CliApplicationBuilder()
|
|
||||||
.AddCommand<DuplicateOptionNamesCommand>()
|
|
||||||
.UseConsole(console)
|
|
||||||
.Build();
|
|
||||||
|
|
||||||
// Act
|
|
||||||
var exitCode = await application.RunAsync(Array.Empty<string>());
|
|
||||||
|
|
||||||
// Assert
|
|
||||||
exitCode.Should().NotBe(0);
|
|
||||||
stdErr.GetString().Should().NotBeNullOrWhiteSpace();
|
|
||||||
|
|
||||||
_output.WriteLine(stdErr.GetString());
|
|
||||||
}
|
|
||||||
|
|
||||||
[Fact]
|
|
||||||
public async Task Command_options_must_have_unique_short_names()
|
|
||||||
{
|
|
||||||
var (console, _, stdErr) = VirtualConsole.CreateBuffered();
|
|
||||||
|
|
||||||
var application = new CliApplicationBuilder()
|
|
||||||
.AddCommand<DuplicateOptionShortNamesCommand>()
|
|
||||||
.UseConsole(console)
|
|
||||||
.Build();
|
|
||||||
|
|
||||||
// Act
|
|
||||||
var exitCode = await application.RunAsync(Array.Empty<string>());
|
|
||||||
|
|
||||||
// Assert
|
|
||||||
exitCode.Should().NotBe(0);
|
|
||||||
stdErr.GetString().Should().NotBeNullOrWhiteSpace();
|
|
||||||
|
|
||||||
_output.WriteLine(stdErr.GetString());
|
|
||||||
}
|
|
||||||
|
|
||||||
[Fact]
|
|
||||||
public async Task Command_options_must_have_unique_environment_variable_names()
|
|
||||||
{
|
|
||||||
var (console, _, stdErr) = VirtualConsole.CreateBuffered();
|
|
||||||
|
|
||||||
var application = new CliApplicationBuilder()
|
|
||||||
.AddCommand<DuplicateOptionEnvironmentVariableNamesCommand>()
|
|
||||||
.UseConsole(console)
|
|
||||||
.Build();
|
|
||||||
|
|
||||||
// Act
|
|
||||||
var exitCode = await application.RunAsync(Array.Empty<string>());
|
|
||||||
|
|
||||||
// Assert
|
|
||||||
exitCode.Should().NotBe(0);
|
|
||||||
stdErr.GetString().Should().NotBeNullOrWhiteSpace();
|
|
||||||
|
|
||||||
_output.WriteLine(stdErr.GetString());
|
|
||||||
}
|
|
||||||
|
|
||||||
[Fact]
|
|
||||||
public async Task Command_options_must_not_have_conflicts_with_the_implicit_help_option()
|
|
||||||
{
|
|
||||||
var (console, _, stdErr) = VirtualConsole.CreateBuffered();
|
|
||||||
|
|
||||||
var application = new CliApplicationBuilder()
|
|
||||||
.AddCommand<ConflictWithHelpOptionCommand>()
|
|
||||||
.UseConsole(console)
|
|
||||||
.Build();
|
|
||||||
|
|
||||||
// Act
|
|
||||||
var exitCode = await application.RunAsync(Array.Empty<string>());
|
|
||||||
|
|
||||||
// Assert
|
|
||||||
exitCode.Should().NotBe(0);
|
|
||||||
stdErr.GetString().Should().NotBeNullOrWhiteSpace();
|
|
||||||
|
|
||||||
_output.WriteLine(stdErr.GetString());
|
|
||||||
}
|
|
||||||
|
|
||||||
[Fact]
|
|
||||||
public async Task Command_options_must_not_have_conflicts_with_the_implicit_version_option()
|
|
||||||
{
|
|
||||||
var (console, _, stdErr) = VirtualConsole.CreateBuffered();
|
|
||||||
|
|
||||||
var application = new CliApplicationBuilder()
|
|
||||||
.AddCommand<ConflictWithVersionOptionCommand>()
|
|
||||||
.UseConsole(console)
|
|
||||||
.Build();
|
|
||||||
|
|
||||||
// Act
|
|
||||||
var exitCode = await application.RunAsync(Array.Empty<string>());
|
|
||||||
|
|
||||||
// Assert
|
|
||||||
exitCode.Should().NotBe(0);
|
|
||||||
stdErr.GetString().Should().NotBeNullOrWhiteSpace();
|
|
||||||
|
|
||||||
_output.WriteLine(stdErr.GetString());
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
|
||||||
|
[Fact]
|
||||||
|
public async Task I_can_create_an_application_with_a_custom_configuration()
|
||||||
|
{
|
||||||
|
// Act
|
||||||
|
var app = new CliApplicationBuilder()
|
||||||
|
.AddCommand<NoOpCommand>()
|
||||||
|
.AddCommandsFrom(typeof(NoOpCommand).Assembly)
|
||||||
|
.AddCommands([typeof(NoOpCommand)])
|
||||||
|
.AddCommandsFrom([typeof(NoOpCommand).Assembly])
|
||||||
|
.AddCommandsFromThisAssembly()
|
||||||
|
.AllowDebugMode()
|
||||||
|
.AllowPreviewMode()
|
||||||
|
.SetTitle("test")
|
||||||
|
.SetExecutableName("test")
|
||||||
|
.SetVersion("test")
|
||||||
|
.SetDescription("test")
|
||||||
|
.UseConsole(FakeConsole)
|
||||||
|
.UseTypeActivator(Activator.CreateInstance!)
|
||||||
|
.Build();
|
||||||
|
|
||||||
|
var exitCode = await app.RunAsync([], new Dictionary<string, string>());
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
exitCode.Should().Be(0);
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public async Task I_can_try_to_create_an_application_and_get_an_error_if_it_has_invalid_commands()
|
||||||
|
{
|
||||||
|
// Act
|
||||||
|
var app = new CliApplicationBuilder()
|
||||||
|
.AddCommand(typeof(ApplicationSpecs))
|
||||||
|
.UseConsole(FakeConsole)
|
||||||
|
.Build();
|
||||||
|
|
||||||
|
var exitCode = await app.RunAsync([], new Dictionary<string, string>());
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
exitCode.Should().NotBe(0);
|
||||||
|
|
||||||
|
var stdErr = FakeConsole.ReadErrorString();
|
||||||
|
stdErr.Should().Contain("not a valid command");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -1,242 +0,0 @@
|
|||||||
using System.Threading.Tasks;
|
|
||||||
using CliFx.Tests.Commands;
|
|
||||||
using CliFx.Tests.Internal;
|
|
||||||
using FluentAssertions;
|
|
||||||
using Xunit;
|
|
||||||
using Xunit.Abstractions;
|
|
||||||
|
|
||||||
namespace CliFx.Tests
|
|
||||||
{
|
|
||||||
public class ArgumentBindingSpecs
|
|
||||||
{
|
|
||||||
private readonly ITestOutputHelper _output;
|
|
||||||
|
|
||||||
public ArgumentBindingSpecs(ITestOutputHelper output) => _output = output;
|
|
||||||
|
|
||||||
[Fact]
|
|
||||||
public async Task Property_annotated_as_an_option_can_be_bound_from_multiple_values_even_if_the_inputs_use_mixed_naming()
|
|
||||||
{
|
|
||||||
// Arrange
|
|
||||||
var (console, stdOut, _) = VirtualConsole.CreateBuffered();
|
|
||||||
|
|
||||||
var application = new CliApplicationBuilder()
|
|
||||||
.AddCommand<WithStringArrayOptionCommand>()
|
|
||||||
.UseConsole(console)
|
|
||||||
.Build();
|
|
||||||
|
|
||||||
// Act
|
|
||||||
var exitCode = await application.RunAsync(new[]
|
|
||||||
{
|
|
||||||
"cmd", "--opt", "foo", "-o", "bar", "--opt", "baz"
|
|
||||||
});
|
|
||||||
|
|
||||||
var commandInstance = stdOut.GetString().DeserializeJson<WithStringArrayOptionCommand>();
|
|
||||||
|
|
||||||
// Assert
|
|
||||||
exitCode.Should().Be(0);
|
|
||||||
|
|
||||||
commandInstance.Should().BeEquivalentTo(new WithStringArrayOptionCommand
|
|
||||||
{
|
|
||||||
Opt = new[] {"foo", "bar", "baz"}
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
[Fact]
|
|
||||||
public async Task Property_annotated_as_a_required_option_must_always_be_set()
|
|
||||||
{
|
|
||||||
// Arrange
|
|
||||||
var (console, _, stdErr) = VirtualConsole.CreateBuffered();
|
|
||||||
|
|
||||||
var application = new CliApplicationBuilder()
|
|
||||||
.AddCommand<WithSingleRequiredOptionCommand>()
|
|
||||||
.UseConsole(console)
|
|
||||||
.Build();
|
|
||||||
|
|
||||||
// Act
|
|
||||||
var exitCode = await application.RunAsync(new[]
|
|
||||||
{
|
|
||||||
"cmd", "--opt-a", "foo"
|
|
||||||
});
|
|
||||||
|
|
||||||
// Assert
|
|
||||||
exitCode.Should().NotBe(0);
|
|
||||||
stdErr.GetString().Should().NotBeNullOrWhiteSpace();
|
|
||||||
|
|
||||||
_output.WriteLine(stdErr.GetString());
|
|
||||||
}
|
|
||||||
|
|
||||||
[Fact]
|
|
||||||
public async Task Property_annotated_as_a_required_option_must_always_be_bound_to_some_value()
|
|
||||||
{
|
|
||||||
// Arrange
|
|
||||||
var (console, _, stdErr) = VirtualConsole.CreateBuffered();
|
|
||||||
|
|
||||||
var application = new CliApplicationBuilder()
|
|
||||||
.AddCommand<WithSingleRequiredOptionCommand>()
|
|
||||||
.UseConsole(console)
|
|
||||||
.Build();
|
|
||||||
|
|
||||||
// Act
|
|
||||||
var exitCode = await application.RunAsync(new[]
|
|
||||||
{
|
|
||||||
"cmd", "--opt-a"
|
|
||||||
});
|
|
||||||
|
|
||||||
// Assert
|
|
||||||
exitCode.Should().NotBe(0);
|
|
||||||
stdErr.GetString().Should().NotBeNullOrWhiteSpace();
|
|
||||||
|
|
||||||
_output.WriteLine(stdErr.GetString());
|
|
||||||
}
|
|
||||||
|
|
||||||
[Fact]
|
|
||||||
public async Task Property_annotated_as_a_required_option_must_always_be_bound_to_at_least_one_value_if_it_expects_multiple_values()
|
|
||||||
{
|
|
||||||
// Arrange
|
|
||||||
var (console, _, stdErr) = VirtualConsole.CreateBuffered();
|
|
||||||
|
|
||||||
var application = new CliApplicationBuilder()
|
|
||||||
.AddCommand<WithRequiredOptionsCommand>()
|
|
||||||
.UseConsole(console)
|
|
||||||
.Build();
|
|
||||||
|
|
||||||
// Act
|
|
||||||
var exitCode = await application.RunAsync(new[]
|
|
||||||
{
|
|
||||||
"cmd", "--opt-a", "foo"
|
|
||||||
});
|
|
||||||
|
|
||||||
// Assert
|
|
||||||
exitCode.Should().NotBe(0);
|
|
||||||
stdErr.GetString().Should().NotBeNullOrWhiteSpace();
|
|
||||||
|
|
||||||
_output.WriteLine(stdErr.GetString());
|
|
||||||
}
|
|
||||||
|
|
||||||
[Fact]
|
|
||||||
public async Task Property_annotated_as_parameter_is_bound_directly_from_argument_value_according_to_the_order()
|
|
||||||
{
|
|
||||||
// Arrange
|
|
||||||
var (console, stdOut, _) = VirtualConsole.CreateBuffered();
|
|
||||||
|
|
||||||
var application = new CliApplicationBuilder()
|
|
||||||
.AddCommand<WithParametersCommand>()
|
|
||||||
.UseConsole(console)
|
|
||||||
.Build();
|
|
||||||
|
|
||||||
// Act
|
|
||||||
var exitCode = await application.RunAsync(new[]
|
|
||||||
{
|
|
||||||
"cmd", "foo", "13", "bar", "baz"
|
|
||||||
});
|
|
||||||
|
|
||||||
var commandInstance = stdOut.GetString().DeserializeJson<WithParametersCommand>();
|
|
||||||
|
|
||||||
// Assert
|
|
||||||
exitCode.Should().Be(0);
|
|
||||||
|
|
||||||
commandInstance.Should().BeEquivalentTo(new WithParametersCommand
|
|
||||||
{
|
|
||||||
ParamA = "foo",
|
|
||||||
ParamB = 13,
|
|
||||||
ParamC = new[] {"bar", "baz"}
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
[Fact]
|
|
||||||
public async Task Property_annotated_as_parameter_must_always_be_bound_to_some_value()
|
|
||||||
{
|
|
||||||
// Arrange
|
|
||||||
var (console, _, stdErr) = VirtualConsole.CreateBuffered();
|
|
||||||
|
|
||||||
var application = new CliApplicationBuilder()
|
|
||||||
.AddCommand<WithSingleParameterCommand>()
|
|
||||||
.UseConsole(console)
|
|
||||||
.Build();
|
|
||||||
|
|
||||||
// Act
|
|
||||||
var exitCode = await application.RunAsync(new[]
|
|
||||||
{
|
|
||||||
"cmd"
|
|
||||||
});
|
|
||||||
|
|
||||||
// Assert
|
|
||||||
exitCode.Should().NotBe(0);
|
|
||||||
stdErr.GetString().Should().NotBeNullOrWhiteSpace();
|
|
||||||
|
|
||||||
_output.WriteLine(stdErr.GetString());
|
|
||||||
}
|
|
||||||
|
|
||||||
[Fact]
|
|
||||||
public async Task Property_annotated_as_parameter_must_always_be_bound_to_at_least_one_value_if_it_expects_multiple_values()
|
|
||||||
{
|
|
||||||
// Arrange
|
|
||||||
var (console, _, stdErr) = VirtualConsole.CreateBuffered();
|
|
||||||
|
|
||||||
var application = new CliApplicationBuilder()
|
|
||||||
.AddCommand<WithParametersCommand>()
|
|
||||||
.UseConsole(console)
|
|
||||||
.Build();
|
|
||||||
|
|
||||||
// Act
|
|
||||||
var exitCode = await application.RunAsync(new[]
|
|
||||||
{
|
|
||||||
"cmd", "foo", "13"
|
|
||||||
});
|
|
||||||
|
|
||||||
// Assert
|
|
||||||
exitCode.Should().NotBe(0);
|
|
||||||
stdErr.GetString().Should().NotBeNullOrWhiteSpace();
|
|
||||||
|
|
||||||
_output.WriteLine(stdErr.GetString());
|
|
||||||
}
|
|
||||||
|
|
||||||
[Fact]
|
|
||||||
public async Task All_provided_option_arguments_must_be_bound_to_corresponding_properties()
|
|
||||||
{
|
|
||||||
// Arrange
|
|
||||||
var (console, _, stdErr) = VirtualConsole.CreateBuffered();
|
|
||||||
|
|
||||||
var application = new CliApplicationBuilder()
|
|
||||||
.AddCommand<SupportedArgumentTypesCommand>()
|
|
||||||
.UseConsole(console)
|
|
||||||
.Build();
|
|
||||||
|
|
||||||
// Act
|
|
||||||
var exitCode = await application.RunAsync(new[]
|
|
||||||
{
|
|
||||||
"cmd", "--non-existing-option", "13"
|
|
||||||
});
|
|
||||||
|
|
||||||
// Assert
|
|
||||||
exitCode.Should().NotBe(0);
|
|
||||||
stdErr.GetString().Should().NotBeNullOrWhiteSpace();
|
|
||||||
|
|
||||||
_output.WriteLine(stdErr.GetString());
|
|
||||||
}
|
|
||||||
|
|
||||||
[Fact]
|
|
||||||
public async Task All_provided_parameter_arguments_must_be_bound_to_corresponding_properties()
|
|
||||||
{
|
|
||||||
// Arrange
|
|
||||||
var (console, _, stdErr) = VirtualConsole.CreateBuffered();
|
|
||||||
|
|
||||||
var application = new CliApplicationBuilder()
|
|
||||||
.AddCommand<SupportedArgumentTypesCommand>()
|
|
||||||
.UseConsole(console)
|
|
||||||
.Build();
|
|
||||||
|
|
||||||
// Act
|
|
||||||
var exitCode = await application.RunAsync(new[]
|
|
||||||
{
|
|
||||||
"cnd", "non-existing-parameter"
|
|
||||||
});
|
|
||||||
|
|
||||||
// Assert
|
|
||||||
exitCode.Should().NotBe(0);
|
|
||||||
stdErr.GetString().Should().NotBeNullOrWhiteSpace();
|
|
||||||
|
|
||||||
_output.WriteLine(stdErr.GetString());
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
File diff suppressed because it is too large
Load Diff
@@ -1,36 +1,107 @@
|
|||||||
using System;
|
using System;
|
||||||
|
using System.Collections.Generic;
|
||||||
|
using System.Text;
|
||||||
using System.Threading;
|
using System.Threading;
|
||||||
using System.Threading.Tasks;
|
using System.Threading.Tasks;
|
||||||
using CliFx.Tests.Commands;
|
using CliFx.Tests.Utils;
|
||||||
|
using CliFx.Tests.Utils.Extensions;
|
||||||
|
using CliWrap;
|
||||||
using FluentAssertions;
|
using FluentAssertions;
|
||||||
using Xunit;
|
using Xunit;
|
||||||
|
using Xunit.Abstractions;
|
||||||
|
|
||||||
namespace CliFx.Tests
|
namespace CliFx.Tests;
|
||||||
|
|
||||||
|
public class CancellationSpecs(ITestOutputHelper testOutput) : SpecsBase(testOutput)
|
||||||
{
|
{
|
||||||
public class CancellationSpecs
|
[Fact(Timeout = 15000)]
|
||||||
|
public async Task I_can_configure_the_command_to_listen_to_the_interrupt_signal()
|
||||||
{
|
{
|
||||||
[Fact]
|
// Arrange
|
||||||
public async Task Command_can_perform_additional_cleanup_if_cancellation_is_requested()
|
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)
|
||||||
{
|
{
|
||||||
// Can't test it with a real console because CliWrap can't send Ctrl+C
|
if (string.Equals(line, "Started.", StringComparison.OrdinalIgnoreCase))
|
||||||
|
cts.CancelAfter(TimeSpan.FromSeconds(0.2));
|
||||||
// Arrange
|
|
||||||
using var cts = new CancellationTokenSource();
|
|
||||||
var (console, stdOut, _) = VirtualConsole.CreateBuffered(cts.Token);
|
|
||||||
|
|
||||||
var application = new CliApplicationBuilder()
|
|
||||||
.AddCommand<CancellableCommand>()
|
|
||||||
.UseConsole(console)
|
|
||||||
.Build();
|
|
||||||
|
|
||||||
// Act
|
|
||||||
cts.CancelAfter(TimeSpan.FromSeconds(0.2));
|
|
||||||
|
|
||||||
var exitCode = await application.RunAsync(new[] {"cmd"});
|
|
||||||
|
|
||||||
// Assert
|
|
||||||
exitCode.Should().NotBe(0);
|
|
||||||
stdOut.GetString().Trim().Should().Be(CancellableCommand.CancellationOutputText);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
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]
|
||||||
|
public async Task I_can_configure_the_command_to_listen_to_the_interrupt_signal_when_running_in_isolation()
|
||||||
|
{
|
||||||
|
// Arrange
|
||||||
|
var commandType = DynamicCommandBuilder.Compile(
|
||||||
|
// lang=csharp
|
||||||
|
"""
|
||||||
|
[Command]
|
||||||
|
public class Command : 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;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
"""
|
||||||
|
);
|
||||||
|
|
||||||
|
var application = new CliApplicationBuilder()
|
||||||
|
.AddCommand(commandType)
|
||||||
|
.UseConsole(FakeConsole)
|
||||||
|
.Build();
|
||||||
|
|
||||||
|
FakeConsole.RequestCancellation(TimeSpan.FromSeconds(0.2));
|
||||||
|
|
||||||
|
// Act
|
||||||
|
var exitCode = await application.RunAsync(
|
||||||
|
[],
|
||||||
|
new Dictionary<string, string>()
|
||||||
|
);
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
exitCode.Should().NotBe(0);
|
||||||
|
|
||||||
|
var stdOut = FakeConsole.ReadOutputString();
|
||||||
|
stdOut.Trim().Should().ConsistOfLines("Started.", "Cancelled.");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -1,13 +1,7 @@
|
|||||||
<Project Sdk="Microsoft.NET.Sdk">
|
<Project Sdk="Microsoft.NET.Sdk">
|
||||||
<Import Project="../CliFx.props" />
|
|
||||||
|
|
||||||
<PropertyGroup>
|
<PropertyGroup>
|
||||||
<TargetFramework>netcoreapp3.1</TargetFramework>
|
<TargetFramework>net9.0</TargetFramework>
|
||||||
<IsPackable>false</IsPackable>
|
|
||||||
<IsTestProject>true</IsTestProject>
|
|
||||||
<CollectCoverage>true</CollectCoverage>
|
|
||||||
<CoverletOutputFormat>opencover</CoverletOutputFormat>
|
|
||||||
<CoverletOutput>bin/$(Configuration)/Coverage.xml</CoverletOutput>
|
|
||||||
</PropertyGroup>
|
</PropertyGroup>
|
||||||
|
|
||||||
<ItemGroup>
|
<ItemGroup>
|
||||||
@@ -15,14 +9,18 @@
|
|||||||
</ItemGroup>
|
</ItemGroup>
|
||||||
|
|
||||||
<ItemGroup>
|
<ItemGroup>
|
||||||
<PackageReference Include="CliWrap" Version="3.0.0" />
|
<PackageReference Include="Basic.Reference.Assemblies.Net80" Version="1.8.2" />
|
||||||
<PackageReference Include="FluentAssertions" Version="5.10.2" />
|
<PackageReference Include="CliWrap" Version="3.9.0" />
|
||||||
<PackageReference Include="GitHubActionsTestLogger" Version="1.0.0" />
|
<PackageReference Include="coverlet.collector" Version="6.0.4" PrivateAssets="all" />
|
||||||
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.5.0" />
|
<PackageReference Include="CSharpier.MsBuild" Version="0.30.6" PrivateAssets="all" />
|
||||||
<PackageReference Include="Newtonsoft.Json" Version="12.0.3" />
|
<PackageReference Include="FluentAssertions" Version="8.4.0" />
|
||||||
<PackageReference Include="xunit" Version="2.4.1" />
|
<PackageReference Include="GitHubActionsTestLogger" Version="2.4.1" PrivateAssets="all" />
|
||||||
<PackageReference Include="xunit.runner.visualstudio" Version="2.4.1" />
|
<PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.11.0" />
|
||||||
<PackageReference Include="coverlet.msbuild" Version="2.8.0" PrivateAssets="all" />
|
<PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="9.0.6" />
|
||||||
|
<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.1" PrivateAssets="all" />
|
||||||
</ItemGroup>
|
</ItemGroup>
|
||||||
|
|
||||||
<ItemGroup>
|
<ItemGroup>
|
||||||
@@ -30,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>
|
||||||
@@ -1,31 +0,0 @@
|
|||||||
using System;
|
|
||||||
using System.Threading.Tasks;
|
|
||||||
using CliFx.Attributes;
|
|
||||||
|
|
||||||
namespace CliFx.Tests.Commands
|
|
||||||
{
|
|
||||||
[Command("cmd")]
|
|
||||||
public class CancellableCommand : ICommand
|
|
||||||
{
|
|
||||||
public const string CompletionOutputText = "Finished";
|
|
||||||
public const string CancellationOutputText = "Canceled";
|
|
||||||
|
|
||||||
public async ValueTask ExecuteAsync(IConsole console)
|
|
||||||
{
|
|
||||||
try
|
|
||||||
{
|
|
||||||
await Task.Delay(
|
|
||||||
TimeSpan.FromSeconds(3),
|
|
||||||
console.GetCancellationToken()
|
|
||||||
);
|
|
||||||
|
|
||||||
console.Output.WriteLine(CompletionOutputText);
|
|
||||||
}
|
|
||||||
catch (OperationCanceledException)
|
|
||||||
{
|
|
||||||
console.Output.WriteLine(CancellationOutputText);
|
|
||||||
throw;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,21 +0,0 @@
|
|||||||
using System.Threading.Tasks;
|
|
||||||
using CliFx.Attributes;
|
|
||||||
using CliFx.Exceptions;
|
|
||||||
|
|
||||||
namespace CliFx.Tests.Commands
|
|
||||||
{
|
|
||||||
[Command("cmd")]
|
|
||||||
public class CommandExceptionCommand : ICommand
|
|
||||||
{
|
|
||||||
[CommandOption("code", 'c')]
|
|
||||||
public int ExitCode { get; set; } = 133;
|
|
||||||
|
|
||||||
[CommandOption("msg", 'm')]
|
|
||||||
public string? Message { get; set; }
|
|
||||||
|
|
||||||
[CommandOption("show-help")]
|
|
||||||
public bool ShowHelp { get; set; }
|
|
||||||
|
|
||||||
public ValueTask ExecuteAsync(IConsole console) => throw new CommandException(Message, ExitCode, ShowHelp);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,17 +0,0 @@
|
|||||||
using System.Threading.Tasks;
|
|
||||||
using CliFx.Attributes;
|
|
||||||
|
|
||||||
namespace CliFx.Tests.Commands
|
|
||||||
{
|
|
||||||
[Command(Description = "Default command description")]
|
|
||||||
public class DefaultCommand : ICommand
|
|
||||||
{
|
|
||||||
public const string ExpectedOutputText = nameof(DefaultCommand);
|
|
||||||
|
|
||||||
public ValueTask ExecuteAsync(IConsole console)
|
|
||||||
{
|
|
||||||
console.Output.WriteLine(ExpectedOutputText);
|
|
||||||
return default;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
using System;
|
|
||||||
using System.Threading.Tasks;
|
|
||||||
using CliFx.Attributes;
|
|
||||||
|
|
||||||
namespace CliFx.Tests.Commands
|
|
||||||
{
|
|
||||||
[Command("cmd")]
|
|
||||||
public class GenericExceptionCommand : ICommand
|
|
||||||
{
|
|
||||||
[CommandOption("msg", 'm')]
|
|
||||||
public string? Message { get; set; }
|
|
||||||
|
|
||||||
public ValueTask ExecuteAsync(IConsole console) => throw new Exception(Message);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
using CliFx.Attributes;
|
|
||||||
|
|
||||||
namespace CliFx.Tests.Commands.Invalid
|
|
||||||
{
|
|
||||||
[Command("cmd")]
|
|
||||||
public class ConflictWithHelpOptionCommand : SelfSerializeCommandBase
|
|
||||||
{
|
|
||||||
[CommandOption("option-h", 'h')]
|
|
||||||
public string? OptionH { get; set; }
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
using CliFx.Attributes;
|
|
||||||
|
|
||||||
namespace CliFx.Tests.Commands.Invalid
|
|
||||||
{
|
|
||||||
// Must be default because version option is available only on default commands
|
|
||||||
[Command]
|
|
||||||
public class ConflictWithVersionOptionCommand : SelfSerializeCommandBase
|
|
||||||
{
|
|
||||||
[CommandOption("version")]
|
|
||||||
public string? Version { get; set; }
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,14 +0,0 @@
|
|||||||
using CliFx.Attributes;
|
|
||||||
|
|
||||||
namespace CliFx.Tests.Commands.Invalid
|
|
||||||
{
|
|
||||||
[Command("cmd")]
|
|
||||||
public class DuplicateOptionEnvironmentVariableNamesCommand : SelfSerializeCommandBase
|
|
||||||
{
|
|
||||||
[CommandOption("option-a", EnvironmentVariableName = "ENV_VAR")]
|
|
||||||
public string? OptionA { get; set; }
|
|
||||||
|
|
||||||
[CommandOption("option-b", EnvironmentVariableName = "ENV_VAR")]
|
|
||||||
public string? OptionB { get; set; }
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,14 +0,0 @@
|
|||||||
using CliFx.Attributes;
|
|
||||||
|
|
||||||
namespace CliFx.Tests.Commands.Invalid
|
|
||||||
{
|
|
||||||
[Command("cmd")]
|
|
||||||
public class DuplicateOptionNamesCommand : SelfSerializeCommandBase
|
|
||||||
{
|
|
||||||
[CommandOption("fruits")]
|
|
||||||
public string? Apples { get; set; }
|
|
||||||
|
|
||||||
[CommandOption("fruits")]
|
|
||||||
public string? Oranges { get; set; }
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,14 +0,0 @@
|
|||||||
using CliFx.Attributes;
|
|
||||||
|
|
||||||
namespace CliFx.Tests.Commands.Invalid
|
|
||||||
{
|
|
||||||
[Command("cmd")]
|
|
||||||
public class DuplicateOptionShortNamesCommand : SelfSerializeCommandBase
|
|
||||||
{
|
|
||||||
[CommandOption('x')]
|
|
||||||
public string? OptionA { get; set; }
|
|
||||||
|
|
||||||
[CommandOption('x')]
|
|
||||||
public string? OptionB { get; set; }
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,14 +0,0 @@
|
|||||||
using CliFx.Attributes;
|
|
||||||
|
|
||||||
namespace CliFx.Tests.Commands.Invalid
|
|
||||||
{
|
|
||||||
[Command("cmd")]
|
|
||||||
public class DuplicateParameterNameCommand : SelfSerializeCommandBase
|
|
||||||
{
|
|
||||||
[CommandParameter(0, Name = "param")]
|
|
||||||
public string? ParamA { get; set; }
|
|
||||||
|
|
||||||
[CommandParameter(1, Name = "param")]
|
|
||||||
public string? ParamB { get; set; }
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,14 +0,0 @@
|
|||||||
using CliFx.Attributes;
|
|
||||||
|
|
||||||
namespace CliFx.Tests.Commands.Invalid
|
|
||||||
{
|
|
||||||
[Command("cmd")]
|
|
||||||
public class DuplicateParameterOrderCommand : SelfSerializeCommandBase
|
|
||||||
{
|
|
||||||
[CommandParameter(13)]
|
|
||||||
public string? ParamA { get; set; }
|
|
||||||
|
|
||||||
[CommandParameter(13)]
|
|
||||||
public string? ParamB { get; set; }
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
using CliFx.Attributes;
|
|
||||||
|
|
||||||
namespace CliFx.Tests.Commands.Invalid
|
|
||||||
{
|
|
||||||
[Command("cmd")]
|
|
||||||
public class EmptyOptionNameCommand : SelfSerializeCommandBase
|
|
||||||
{
|
|
||||||
[CommandOption("")]
|
|
||||||
public string? Apples { get; set; }
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
using System.Collections.Generic;
|
|
||||||
using CliFx.Attributes;
|
|
||||||
|
|
||||||
namespace CliFx.Tests.Commands.Invalid
|
|
||||||
{
|
|
||||||
[Command("cmd")]
|
|
||||||
public class MultipleNonScalarParametersCommand : SelfSerializeCommandBase
|
|
||||||
{
|
|
||||||
[CommandParameter(0)]
|
|
||||||
public IReadOnlyList<string>? ParamA { get; set; }
|
|
||||||
|
|
||||||
[CommandParameter(1)]
|
|
||||||
public IReadOnlyList<string>? ParamB { get; set; }
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,6 +0,0 @@
|
|||||||
namespace CliFx.Tests.Commands.Invalid
|
|
||||||
{
|
|
||||||
public class NonAnnotatedCommand : SelfSerializeCommandBase
|
|
||||||
{
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
using CliFx.Attributes;
|
|
||||||
|
|
||||||
namespace CliFx.Tests.Commands.Invalid
|
|
||||||
{
|
|
||||||
[Command]
|
|
||||||
public class NonImplementedCommand
|
|
||||||
{
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
using System.Collections.Generic;
|
|
||||||
using CliFx.Attributes;
|
|
||||||
|
|
||||||
namespace CliFx.Tests.Commands.Invalid
|
|
||||||
{
|
|
||||||
[Command("cmd")]
|
|
||||||
public class NonLastNonScalarParameterCommand : SelfSerializeCommandBase
|
|
||||||
{
|
|
||||||
[CommandParameter(0)]
|
|
||||||
public IReadOnlyList<string>? ParamA { get; set; }
|
|
||||||
|
|
||||||
[CommandParameter(1)]
|
|
||||||
public string? ParamB { get; set; }
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
using CliFx.Attributes;
|
|
||||||
|
|
||||||
namespace CliFx.Tests.Commands.Invalid
|
|
||||||
{
|
|
||||||
[Command]
|
|
||||||
public class OtherDefaultCommand : SelfSerializeCommandBase
|
|
||||||
{
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
using CliFx.Attributes;
|
|
||||||
|
|
||||||
namespace CliFx.Tests.Commands.Invalid
|
|
||||||
{
|
|
||||||
[Command("cmd")]
|
|
||||||
public class SingleCharacterOptionNameCommand : SelfSerializeCommandBase
|
|
||||||
{
|
|
||||||
[CommandOption("a")]
|
|
||||||
public string? Apples { get; set; }
|
|
||||||
}
|
|
||||||
}
|
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user