mirror of
https://github.com/microsoft/terminal.git
synced 2025-12-10 18:43:54 -06:00
3ae67a9b68
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](https://github.com/JamieMagee/verify-cgmanifest) 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()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse). However, to serialize the JSON again we use [`prettier`](https://prettier.io/). We found that, in general, it gave smaller diffs than the default [`JSON.stringify()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify) function.
Component-Governance-tracked OSS dependencies
This directory contains mirrored open-source projects that are used by the console host and Windows Terminal. Code in this directory will be replicated into the Windows OS repository.
All projects in this directory must bear Component Governance Manifests
(cgmanifest.json files) indicating their provenance.