Code Hints API is confusing about HTML escaping

[core-ai-bot]

Issue by peterflynn
Monday Mar 17, 2014 at 22:50 GMT
Originally opened as adobe/brackets#7217

---

The Code Hints extensibility API has some confusing semantics, mainly driven by the code in CodeHintList._buildListView():

• If you provide a match property, it assumes you're providing strings and not jQuery objects -- this is probably sensible, but it's not documented anywhere.
• If you provide strings, it assumes they're already HTML-escaped. This is undocumented, and confusing since we already support jQuery objects if you want to provide formatted output.
• If there is HTML markup or escaping in the string you provide, and you also provide match, it's possible for the match-text to match something in the HTML part of the string -- so the match-bolding logic will break the HTML code.

[core-ai-bot]

Comment by peterflynn
Wednesday Mar 19, 2014 at 18:53 GMT

---

Marking low priority@RaymondLim, but nominating for 1.0 -- would be nice to clean up this API before then.

[core-ai-bot]

Comment by pthiess
Thursday May 01, 2014 at 16:09 GMT

---

Reviewed leave the 1.0 milestone. Seems like a small fix.