Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add .NET Aspire schemas #215

Merged
merged 2 commits into from
Apr 26, 2024
Merged

Add .NET Aspire schemas #215

merged 2 commits into from
Apr 26, 2024

Conversation

mhutch
Copy link
Owner

@mhutch mhutch commented Apr 26, 2024

Added schemas for .NET Aspire

image

image

Fixes #203

@@ -0,0 +1,40 @@
{
"license": "Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.",
"properties": {

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it also be possible to document here metadata on specific Items? I'm mainly asking as it would be interesting if we can also provide info around IsAspireProjectResource. cc: @eerhardt

See https://github.com/dotnet/aspire/blob/c6d17908dce366b8c08b77509f2ce692b861cbd1/src/Aspire.Hosting.Sdk/SDK/Sdk.targets#L22 for more info

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nevermind, I see you did this already in AspireHostingSDK

Copy link

@joperezr joperezr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for doing this!

Comment on lines +4 to +19
"DcpDir": {
"description": "The path to the directory containing the DCP tools.",
"type": "folder-with-slash"
},
"DcpExtensionsDir": {
"description": "The path to the directory containing the DCP tool extensions.",
"type": "folder-with-slash"
},
"DcpBinDir": {
"description": "The path to the directory containing the DCP tool extension binaries.",
"type": "folder-with-slash"
},
"DcpCliPath": {
"description": "The path to the DCP CLI executable.",
"type": "file"
}

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we want users setting these properties at all. These are more "internal" properties to Aspire.

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They'll be in completion anyways as they'll be discovered in the imported targets - so I figured they may as well have docs. The MSBuild Editor only hides symbols that use the underscore prefix convention to indicate private/internal use.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok, that makes sense. Thanks for the explanation.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it make sense to add something like (for testing/validation scenarios) to indicate that they aren't properties we'd normally expect to be customized?

Copy link

@eerhardt eerhardt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These looks good to me. Thanks for taking care of this @mhutch!

@mhutch mhutch merged commit a0d20ca into main Apr 26, 2024
1 check passed
@mhutch mhutch deleted the aspire-schemas branch April 30, 2024 17:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Warning with IsAspireSharedProject
4 participants