feat: examples completion for propertyNames #286
Merged
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.
This PR adds support for using
examplesdefined inside apropertyNamesschema as completion suggestions.Currently, when a JSON Schema contains
propertyNameswith anexamplesarray, the values are ignored by the language service.Changes
jsonCompletion.tsto checkpropertyNames.examples.examplesis present and contains strings, they are included in the completion list as property name suggestions.Example schema
{ "type": "object", "propertyNames": { "type": "string", "pattern": "^[a-z]+$", "examples": ["username", "email", "address"] } }Expected behavior
When editing a JSON file with this schema, the completion list for new property names should include
"username","email", and"address".Motivation
This improves usability when working with schemas that define flexible object properties but still want to provide user-friendly suggestions via
examples.Notes & Future Improvements
According to the JSON Schema Validation specification (draft-07, §10.4), it is RECOMMENDED that the values in
examplesare valid against the associated schema.This PR does not enforce validation of
examplesagainstpatternconstraints. Instead, it assumes that schema authors provide consistent examples.As a potential future improvement, validation could be added to filter out
examplesthat don’t conform to thepatternregular expression.