redhat-developer / redhat-developer/vscode-yaml

HTML special characters not escaped in documentation tooltips

Open
#381 1 comment 0 reactions 1 assignee View on GitHub

@evidolob is already working on this.

Since Oct 28, 2020.

bug upstream
Dominant language
TypeScript
Stars
829
Forks
260
Avg merge
5h 43m
Merged PRs (30d)
1

Description

Describe the bug

If a JSON schema contains HTML characters (eg. <span>foo</span>) in the description field, those are not escaped before being handed over to VS Code, which apparently interprets them (probably to offer rich formatting).

Extension version: 0.11.1

Expected Behavior

HTML special chars like < get replaced by their entites (&lt;) before being passed to VS Code

Current Behavior

HTML special chars are passed directly to VS Code.

This could actually be considered a feature, but I don't know if other tools reading the schema (eg. doc generators) play well with that...

Steps to Reproduce

  1. Write a schema with <span>hello</span> in the description field
  2. Hover a term in a YAML doc to invoke the documentation tooltip

Environment

  • Windows
  • Mac
  • Linux
  • other (please specify)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.