Supply JSON schemas for YAML files

[thernstig]

Feature Request

Files like .clang-format etc. have a JSON schema, see https://json.schemastore.org/clang-format.json.

Users can reference those schemas in a few ways in VS Code. For example if using the most common YAML extension in VS Code, one can associate a schema like this:

# yaml-language-server: $schema=<urlToTheSchema>

However, to avoid this manual addition, this extension should automatically contribute so that common file name conventions (.clang-format, .clang-tidy etc.) automatically gets the correct JSON schemas.

I believe this is one way to get this working: https://code.visualstudio.com/api/references/contribution-points#contributes.jsonValidation

[bobbrow]

Thank you for the suggestion.

I took a look at this and it turns out that there is a whole YAML language server provided by the RedHat YAML extension. It is not provided by VS Code so it's not something we can just plug into. The contribution point VS Code offers will provide JSON language services, but it does not provide services for YAML (as far as my testing showed).

Unfortunately, it is too much work for us to re-implement YAML language services in our extension and I feel it is a bit out of scope for us, especially considering that the RedHat extension seems to already provide a good experience. I did not need to run the command you mentioned to enable the support. I just opened a .clang-format file, changed the language ID to YAML and selected the schema from the status bar.

[thernstig]

@bobbrow thank you for looking into this.

For some reason, VS Code gives automatic validation via the JSON schema store for e.g. .clang-tidy:

It does not do that for .clang-format:

I wonder how VS Code finds one, but not the other. If that problem is solved then I suppose this problem is solved anyway.

[bobbrow]

@thernstig are you saying that you are getting language services for .clang-tidy without the RedHat YAML extension installed? That was not my experience. Do you have other extensions installed that might be doing it? Or are you saying you get validation only (no auto-complete, etc)?

[thernstig]

@bobbrow No, I do need the RedHat YAML extension. I am saying that with the extension, .clang-tidy gets automatically referenced to the correct JSON schema from the https://github.com/SchemaStore/, whilst .clang-format does not.

My feature request was an idea to solve this in another way, to make sure it works for everyone. But seeing as the VS Code API only supports contributions for JSON validation, and not YAML, this topic kind of turned into a "why does .clang-format not get JSON schema validation when using the RedHat YAML extension, whilst .clang-tidy does." 😆

This was never my intention, and nothing you can affect in this repo, so if this was derailed I am sorry! I will try to figure this out.