Improve reporting of extension config schema validation errors#120457
Merged
sandy081 merged 1 commit intomicrosoft:mainfrom Apr 6, 2021
Merged
Improve reporting of extension config schema validation errors#120457sandy081 merged 1 commit intomicrosoft:mainfrom
sandy081 merged 1 commit intomicrosoft:mainfrom
Conversation
It now says which property was bad.
Contributor
Author
|
(I think this is a preexisting broken build fwiw) |
sandy081
approved these changes
Apr 6, 2021
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
In large extension configuration schemas, if a type error is present on a configuration key, an error message like the following is generated:

This requires the extension developer to go through each property and check it's the right type. I made it print out which one was bad:
This PR can be tested by updating the top level object of an extension
package.jsonwith this fragment:{ "contributes": { "configuration": { "type": "object", "title": "Rust Analyzer", "properties": { "rust-analyzer.thisPropShouldBeAnObjectButIsnt": false } } }