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 $schema to cgmanifest.json #2487

Merged
merged 1 commit into from
Sep 1, 2022
Merged

Add $schema to cgmanifest.json #2487

merged 1 commit into from
Sep 1, 2022

Conversation

JamieMagee
Copy link
Member

@JamieMagee JamieMagee commented Sep 1, 2022

This pull request adds the JSON schema for cgmanifest.json.

FAQ

Why?

A JSON schema helps you to ensure that your cgmanifest.json file is valid.
JSON schema validation is a build-in feature in most modern IDEs like Visual Studio and Visual Studio Code.
Most modern IDEs also provide code-completion for JSON schemas.

How can I validate my cgmanifest.json file?

Most modern IDEs like Visual Studio and Visual Studio Code have a built-in feature to validate JSON files.
You can also use this small script to validate your cgmanifest.json file.

Why does it suggest camel case for the properties?

Component Detection is able to read camel case and pascal case properties.
However, the JSON schema doesn't have a case-insensitive mode.
We therefore suggest camel case as it's the most common format for JSON.

Why is the diff so large?

To deserialize the cgmanifest.json file, we use JSON.parse().
However, to serialize the JSON again we use prettier.
We found that, in general, it gave smaller diffs than the default JSON.stringify() function.

Microsoft Reviewers: Open in CodeFlow

@JamieMagee JamieMagee requested a review from a team as a code owner September 1, 2022 18:46
@yao-msft yao-msft merged commit d86a67e into microsoft:master Sep 1, 2022
@JamieMagee JamieMagee deleted the cgmanifest-schema branch September 1, 2022 21:00
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.

2 participants