redhat-developer / redhat-developer/vscode-yaml
Newlines and other chars in JSON schema "examples" property interpreted correctly
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 829
- Forks
- 260
- Avg merge
- 5h 43m
- Merged PRs (30d)
- 1
Description
Describe the bug
Newlines and other chars are not reflected properly when hovering over a variable in YAML file which uses a JSON schema containing the "examples" property
YAML contents:
prop: This\n is\n wrong\n while\n doing\n hover \n
Expected Behavior
I would expect to see the text with newlines and other chars correctly interpreted
Current Behavior
This is what I see when hovering over prop in the YAML file:
Steps to Reproduce
- Refer from YAML file to example.schema.json
- Write
propin the YAML file - Hover over
prop
Environment
- Windows
- Mac
- Linux
- other (please specify)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by tracing the hover behavior for a YAML property whose JSON schema uses the examples property, using the attached example.schema.json and YAML reproduction. Verify how newline and other characters are interpreted, then confirm that hovering over prop displays the expected text correctly on Linux.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript, vscode
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100