Skip to content

Add $schema to cgmanifest.json#159779

Merged
aeschli merged 2 commits intomicrosoft:mainfrom
JamieMagee:cgmanifest-schema
Sep 28, 2022
Merged

Add $schema to cgmanifest.json#159779
aeschli merged 2 commits intomicrosoft:mainfrom
JamieMagee:cgmanifest-schema

Conversation

@JamieMagee
Copy link
Member

This is part of a broad effort to improve the experience of using cgmanifest.json. I've mostly been creating these PRs using a script (for example microsoft/Olive#108) however, the vscode repo has a lot of custom tooling built on top of cgmanifest.json so I decided to create this one manually after discussing with @isidorn

@isidorn
Copy link
Collaborator

isidorn commented Sep 1, 2022

@JamieMagee thanks for this PR. So this gets rid of our own cgmanifest schema which makes sense.
Assigning to @aeschli for review for schema smarts
fyi @lszomoru

@aeschli
Copy link
Contributor

aeschli commented Sep 2, 2022

$schema is not the most elegant way. Note that $schema is not a standard, just a convenience invented by the JSON support in VS Code.

The easiest way would have been to change the schema association in '.vscode/settings' to use 'https://json.schemastore.org/component-detection-manifest.json'.

Alternative is to have a schema association in one of our built-in extensions. extension-editing would be a good place.

@JamieMagee
Copy link
Member Author

JamieMagee commented Sep 2, 2022

@aeschli I thought that $schema was part of the standard? It's documented here. Regardless, I can revert the changes and add the association in .vscode/settings.json for now.

If I were to make the change in extension-editing, where would I need to make it?

@aeschli
Copy link
Contributor

aeschli commented Sep 5, 2022

@JamieMagee
Copy link
Member Author

@aeschli I made the change you suggested in .vscode/settings.json. I'll send a followup PR for extension-editing at a later date.

@aeschli aeschli added this to the October 2022 milestone Sep 28, 2022
@aeschli aeschli modified the milestones: October 2022, September 2022 Sep 28, 2022
@aeschli aeschli enabled auto-merge (squash) September 28, 2022 09:20
@aeschli
Copy link
Contributor

aeschli commented Sep 28, 2022

Sneaking in September as this is a safe and simple change.

@aeschli aeschli merged commit 8044546 into microsoft:main Sep 28, 2022
@isidorn
Copy link
Collaborator

isidorn commented Sep 28, 2022

YOLO :)

@aeschli aeschli requested a review from isidorn September 28, 2022 12:23
@aeschli
Copy link
Contributor

aeschli commented Sep 28, 2022

@isidorn as second reviewer :-)

@JamieMagee JamieMagee deleted the cgmanifest-schema branch October 20, 2022 16:06
@github-actions github-actions bot locked and limited conversation to collaborators Nov 12, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants