(MAINT) Improve schemas #172
Merged
Conversation
This file contains 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
SteveL-MSFT
approved these changes
Aug 29, 2023
This change makes minor fixes and improvements to the decomposed schemas.
Changes include:
1. Fixing the data-type conditionals for configuration parameters so that
the `min*`/`max*` keywords only apply to the correct data types.
1. Adding type validation for default and allowed values based on the defined
data type for the parameter.
1. Adding VS Code keywords to improve the DevX when authoring configurations
and resource manifests:
- The `markdownDescription` ensures that descriptive text can render as
Markdown. Where possible, these descriptions also include a link to
the relevant online documentation to help authors get more information
as needed.
- The `markdownEnumDescriptions` keyword enables adding per-enum-value
documentation that shows on hover and with auto-complete.
- The `patternErrorMessage` shows a useful error message instead of just
informing the user that a string did not match a regular expression.
- The `defaultSnippets` enables simpler auto-complete for values, allowing
an author to pick from a list of snippets that work like normal VS Code
snippets.
1. Ensuring that the processed schemas only include the VS Code keywords for
the bundled VS Code schemas.
1. Adding schema associations so `*.dsc.resource.json` files are associated with
the bundled VS Code schema for resource manifests and `.dsc[.config].yaml`
files are associated with the bundled VS Code schema for configuration
documents.
Together, these changes make the schemas more accurate and improve the authoring
DevX for DSCv3.
auto-merge was automatically disabled
August 31, 2023 13:57
Head branch was pushed to by a user without write access
michaeltlombardi
force-pushed
the
maint/main/enhance-schemas
branch
from
d4e94cb
to
e3a001c
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
PR Summary
This change makes minor fixes and improvements to the decomposed schemas.
Changes include:
Fixing the data-type conditionals for configuration parameters so that the
min*/max*keywords only apply to the correct data types.Adding type validation for default and allowed values based on the defined data type for the parameter.
Adding VS Code keywords to improve the DevX when authoring configurations and resource manifests:
markdownDescriptionensures that descriptive text can render as Markdown. Where possible, these descriptions also include a link to the relevant online documentation to help authors get more information as needed.markdownEnumDescriptionskeyword enables adding per-enum-value documentation that shows on hover and with auto-complete.patternErrorMessageshows a useful error message instead of just informing the user that a string did not match a regular expression.defaultSnippetsenables simpler auto-complete for values, allowing an author to pick from a list of snippets that work like normal VS Code snippets.Ensuring that the processed schemas only include the VS Code keywords for the bundled VS Code schemas.
Adding schema associations so
*.dsc.resource.jsonfiles are associated with the bundled VS Code schema for resource manifests and.dsc[.config].yamlfiles are associated with the bundled VS Code schema for configuration documents.PR Context
Together, these changes make the schemas more accurate and improve the authoring DevX for DSCv3.