Skip to content

JSDoc Intellisense continues to completely remove HTML tag contents #146521

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
thw0rted opened this issue Apr 1, 2022 · 9 comments
Closed

JSDoc Intellisense continues to completely remove HTML tag contents #146521

thw0rted opened this issue Apr 1, 2022 · 9 comments
Assignees
Labels
feature-request Request for new features or functionality javascript JavaScript support issues typescript Typescript support issues

Comments

@thw0rted
Copy link

thw0rted commented Apr 1, 2022

Issue Type: Bug

The issue I reported a year and a half ago has not been resolved as of the current Insider build of VSCode. The contents of HTML tags in JSDoc comments are still completely removed.

Notice the <p> tags containing a large amount of information about this class:

JSDoc for the Cesium class KMLDataSource

That information is not shown in the tooltip and there is no indication that anything has been removed:

Intellisense tooltip for the same class

Related issues:
#31161
#40607 (marked as resolved via #132182)
#113959
microsoft/language-server-protocol#1344 (LSP says it's not their fault)

cc @mjbvz , who worked the linked PR


VS Code version: Code - Insiders 1.67.0-insider (8b7086a, 2022-04-01T05:16:02.350Z)
OS version: Windows_NT x64 10.0.19044
Restricted Mode: No

System Info
Item Value
CPUs Intel(R) Core(TM) i7-8650U CPU @ 1.90GHz (8 x 2112)
GPU Status 2d_canvas: enabled
canvas_oop_rasterization: disabled_off
direct_rendering_display_compositor: disabled_off_ok
gpu_compositing: enabled
multiple_raster_threads: enabled_on
oop_rasterization: enabled
opengl: enabled_on
rasterization: enabled
raw_draw: disabled_off_ok
skia_renderer: enabled_on
video_decode: enabled
video_encode: enabled
vulkan: disabled_off
webgl: enabled
webgl2: enabled
Load (avg) undefined
Memory (System) 15.92GB (5.05GB free)
Process Argv
Screen Reader no
VM 0%
Extensions (1)
Extension Author (truncated) Version
vscode-eslint dba 2.2.3
A/B Experiments
vsliv695:30137379
vsins829:30139715
vsliv368:30146709
vsreu685:30147344
python383:30185418
vspor879:30202332
vspor708:30202333
vspor363:30204092
vswsl492cf:30256198
pythonvspyl392:30422396
pythontb:30258533
pythonptprofiler:30281269
vshan820:30294714
pythondataviewer:30285072
vscod805cf:30301675
pythonvspyt200:30323110
bridge0708:30335490
bridge0723:30353136
vsaa593:30376534
pythonvs932:30404738
wslgetstarted:30449409
vsclayoutctrc:30405799
pythonvspyt640:30438691
vscscmwlcmc:30428972
vscgsvidc:30433759
pynewfile477:30451556

@thw0rted
Copy link
Author

thw0rted commented Apr 1, 2022

Just as an aside, maybe y'all could make the auto-lock-bot a little less aggressive, so that when you make a change that's supposed to resolve an issue, the issue doesn't get locked before the change makes its way into a production release where the reporter can actually confirm that the fix worked.

@mjbvz
Copy link
Collaborator

mjbvz commented Apr 1, 2022

Yes that PR only enables the ability for an extension to turn on html rendering. We didn't actually enable it for JS/TS

Marking as a feature request to gauge interest

@mjbvz mjbvz added feature-request Request for new features or functionality typescript Typescript support issues javascript JavaScript support issues labels Apr 1, 2022
@thw0rted
Copy link
Author

thw0rted commented Apr 1, 2022

As I said in my previous issue, I am not making a feature request. I don't need the tag to render as HTML, I need the bare text content to render at all and not be completely discarded. Not showing 80% of the docs for this class is a bug, period. It's frustrating that for years I have had to go look up docs in a browser because my IDE cannot render them without losing random snippets of text.

@mjbvz
Copy link
Collaborator

mjbvz commented Apr 1, 2022

The current behavior is by-design. Changing the design is a feature request

@thw0rted
Copy link
Author

thw0rted commented Apr 4, 2022

@mjbvz I think my previous comment came off as rude, but I just want to confirm that the official position of the VSCode team is that the following behavior is "by design":

image

Maybe I could re-file this as a security issue? "Attacker can craft documentation with different meanings in different IDEs"? Somebody a little more clever than I could probably come up with something akin to a homograph attack.

@mjbvz
Copy link
Collaborator

mjbvz commented Apr 4, 2022

Yes it's by design and it's also not a security issues IMO since this is non-executing code. This is been how VS Code has rendered JSDoc for 5+ years so let's wait for more feedback on the request

@vscodenpa
Copy link

This feature request has not yet received the 20 community upvotes it takes to make to our backlog. 10 days to go. To learn more about how we handle feature requests, please see our documentation.

Happy Coding!

@vscodenpa
Copy link

🙁 In the last 60 days, this feature request has received less than 20 community upvotes and we closed it. Still a big Thank You to you for taking the time to create this issue! To learn more about how we handle feature requests, please see our documentation.

Happy Coding!

@github-actions github-actions bot locked and limited conversation to collaborators Jul 16, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
feature-request Request for new features or functionality javascript JavaScript support issues typescript Typescript support issues
Projects
None yet
Development

No branches or pull requests

4 participants
@thw0rted @mjbvz @vscodenpa and others