facebookarchive/atom-ide-ui

Consider allowing HTML in datatip markdown

Open

#99 opened on Oct 18, 2017

View on GitHub
 (9 comments) (4 reactions) (0 assignees)JavaScript (937 stars) (110 forks)batch import
datatipsenhancementhelp wanted

Description

Description

I noticed that markdown in datatips sanitizes out HTML. I can understand this, but would like to request the ability to disable this, perhaps in the datatip or MarkedString data itself.

The reason for this is, at least in PHP, docblock comments can intermingle markdown and HTML and one codebase may decide to use markdown whilst one of its dependencies may resort solely to HTML.

I see that datatips uses the marked library, which I am currently also using. It should already allow this by simply not requesting sanitization of the input value. (In the end, the embedded HTML is just more HTML to be displayed in the datatip after the markdown has been converted.)

Expected Behavior

HTML would not be sanitized or there would be an option to disable it for datatip markdown strings.

Actual Behavior

HTML is always sanitized in datatip markdown strings.

Versions

  • Atom: 1.21.0
  • Client OS: Linux
  • atom-ide-ui: 0.5.1

Contributor guide

Tech stack
javascript
Domain
developer experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
JavaScriptAtom package development
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Review the datatip markdown rendering code in the atom ide ui package, likely in files under lib/datatip/. Look for how the `marked` library is called and where sanitization is applied. Consider adding an option to the datatip data model to control HTML sanitization. Check existing comments for further context on desired implementation.