Given this:
foo: 123 # @schema description: hello **world**
I want this:
"foo": {
"type": "integer",
"description": "hello **world**",
+ "markdownDescription": "hello **world**"
}Suggested implementation:
-
add a --markdown-description flag which copies any description property into any unset markdownDescription fields
flag could have an enum value:
--markdown-description=none removes any markdownDescription (default)--markdown-description=copy-description copies value from description--markdown-description=replace-description copies value from description and removes the description
-
add a # @schema description.md: foobar annotation to manually set markdown description, which should always override whatever the --markdown-description flag sets.
Motivation:
Given this:
I want this:
"foo": { "type": "integer", "description": "hello **world**", + "markdownDescription": "hello **world**" }Suggested implementation:
add a
--markdown-descriptionflag which copies anydescriptionproperty into any unsetmarkdownDescriptionfieldsflag could have an enum value:
--markdown-description=noneremoves anymarkdownDescription(default)--markdown-description=copy-descriptioncopies value fromdescription--markdown-description=replace-descriptioncopies value fromdescriptionand removes thedescriptionadd a
# @schema description.md: foobarannotation to manually set markdown description, which should always override whatever the--markdown-descriptionflag sets.Motivation:
markdownDescriptionbecause VS Code started supporting it: [json] Markdown in hovers (descriptions from schema) microsoft/vscode#34498, which means a lot of editors has support for this.