feat: support non-standard markdownDescription property #23
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #23 +/- ##
==========================================
+ Coverage 87.67% 87.80% +0.12%
==========================================
Files 9 9
Lines 698 705 +7
==========================================
+ Hits 612 619 +7
Misses 64 64
Partials 22 22 ☔ View full report in Codecov by Sentry. |
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.
Adds support for the non-standard
markdownDescriptionproperty. This property is primarily used by a few LSP language servers (JSON, YAML, etc) to render documentation when hovering over properties in IDEs. They treatdescriptionas plain text and escape any markdown present. Schema authors that want rendered markdown must also includemarkdownDescription.For now, schemadoc is going to render everything as markdown. I suspect few schemas are bothering with duplicating their descriptions across two props. But for those that do, we should support rendering
markdownDescriptionif present.