Add setting to render code lenses as a phantom #1750

Rapptz · 2021-06-15T13:59:48Z

This also adds a setting to disable the rendering entirely.

In order to satisfy those who like their code lenses as an annotation I kept the setting as-is rather than replacing them. I did change the default setting to use a phantom since that representation is probably more common for those coming from VSCode.

I've tested this code and it works, but I'm unsure if there are any state related bugs. One thing I noticed is that the code lenses only show up when the file is reopened. This felt undesirable to me, however I did not know where exactly to fix it. In a normal plugin lifecycle I would hook into on_load_async, on_activated_async, and (potentially) on_post_save_async. There was the _register_async helper function which would have felt like an appropriate place to send the code lenses request, but I was unsure if the state was properly set there or if this was even desirable. Personally, reopening the file to get code lenses is a bad experience.

Code lenses with the phantom setting are rendered similarly to VSCode, as seen below:

Sublime Text	VSCode

LSP.sublime-settings

plugin/core/views.py

plugin/documents.py

predragnikolic · 2021-06-15T19:29:38Z

IMO, the phantoms looks nice! Really Nice! 👍

I did a quick test run with the LSP-elm server
and noticed a few issues, which lead me to believe that there is still some polishing to do in the UX.

Like for example:

if I insert new lines, the code lens will on the same line (than inserted back to where it should be)
if I delete a line before a code lens, the code lens will be deleted (than inserted back in) - I think that this is ST behavior and that we cannot prevent the deletion of phantoms.

there is a problem where one code lens appears multiple times.

notice the exposed | 4 references | 4 references

notice the exposed | 7 references | 7 references | 7 references | 7 references

Rapptz · 2021-06-16T03:44:00Z

I've fixed the review comments.

if I insert new lines, the code lens will on the same line (than inserted back to where it should be)

Ideally, the code lens would be re-calculated when there are modifications. I'd personally use on_modified_async for this with the 300ms delay to prevent spamming. I'm not sure if this would be the approach I should take though. There are other nits I want to fix like the one I mentioned in the starting PR comment above. Fundamentally, I don't know when I'm "ready" to start sending requests to the server.

if I delete a line before a code lens, the code lens will be deleted (than inserted back in) - I think that this is ST behavior and that we cannot prevent the deletion of phantoms.

I think this one's in the same vein as the one above, which is to re-calculate code lenses on modification. I'm not entirely sure if it fixes it but I'm willing to try.

there is a problem where one code lens appears multiple times.

I've seen this one before myself! I don't know what causes it other than maybe the server sending duplicates (unlikely?) or some state not being cleared properly. I think I need LSP server logs to figure it out but I'd love to get it fixed as well.

plugin/documents.py

plugin/core/views.py

plugin/documents.py

Rapptz · 2021-06-20T01:22:28Z

I've force pushed the changesets to rebase from the previous refactoring and it's ready for review again.

plugin/code_lens.py

rchl

There is unused resolved_code_lens method in CodeLensView.

And the unresolved_visible_code_lens should end with *lenses IMO.

plugin/code_lens.py

rwols

The major problem I have with this is that phantoms are not attached to their actual region they represent. This causes all kinds of problems when modifying the buffer, for instance:

Schermopname.2021-06-26.om.12.15.03.mov

Use sublime.LAYOUT_BELOW and attach to the region it's meant to be attached to. We will have to wait for sublimehq/sublime_text#4469, if ever implemented.

Rapptz · 2021-06-26T14:10:43Z

This does not look pleasing.

I'm fine with changing it to the bottom but only if the region follows the same indentation rules as the code, i.e. the region is expanded to the line and indented, sort of like LAYOUT_BLOCK but not really.

For example:

RNRRaGXypX.mp4

TerminalFi · 2021-07-01T18:21:10Z

This is starting to look really clean. Hopefully we get a sublime.LAYOUT_ABOVE option for phantoms here in the near future and then this can become user configurable

rwols

Phantoms:

Annotations:

Seems to work OK now.

rwols requested changes Jun 15, 2021

View reviewed changes

LSP.sublime-settings Outdated Show resolved Hide resolved

plugin/core/views.py Outdated Show resolved Hide resolved

plugin/documents.py Outdated Show resolved Hide resolved

plugin/documents.py Outdated Show resolved Hide resolved

Rapptz force-pushed the phantom-code-lens branch from 6f29038 to b1bbcf8 Compare June 16, 2021 03:36

rwols reviewed Jun 16, 2021

View reviewed changes

plugin/documents.py Outdated Show resolved Hide resolved

rchl reviewed Jun 16, 2021

View reviewed changes

plugin/core/views.py Outdated Show resolved Hide resolved

rchl reviewed Jun 16, 2021

View reviewed changes

plugin/core/views.py Outdated Show resolved Hide resolved

plugin/core/views.py Outdated Show resolved Hide resolved

plugin/documents.py Outdated Show resolved Hide resolved

Rapptz marked this pull request as draft June 17, 2021 11:34

Rapptz force-pushed the phantom-code-lens branch from b1bbcf8 to 9960ddd Compare June 19, 2021 21:34

Rapptz marked this pull request as ready for review June 20, 2021 01:21

rwols requested changes Jun 20, 2021

View reviewed changes

plugin/code_lens.py Outdated Show resolved Hide resolved

plugin/code_lens.py Outdated Show resolved Hide resolved

rchl reviewed Jun 20, 2021

View reviewed changes

plugin/code_lens.py Show resolved Hide resolved

plugin/code_lens.py Outdated Show resolved Hide resolved

plugin/code_lens.py Outdated Show resolved Hide resolved

plugin/code_lens.py Outdated Show resolved Hide resolved

rwols requested changes Jun 26, 2021

View reviewed changes

Rapptz requested a review from rwols July 1, 2021 23:24

Rapptz added 5 commits July 1, 2021 19:26

Add setting to render code lenses as a phantom

c970e5a

Render Code Lenses as phantoms

43a33ef

Review nits

65dc61e

Render code lenses in UI thread

686f693

Code lens on the bottom

0c5f118

Rapptz force-pushed the phantom-code-lens branch from d6767a8 to 0c5f118 Compare July 1, 2021 23:27

rwols approved these changes Jul 3, 2021

View reviewed changes

rwols merged commit 9d6b1fa into sublimelsp:main Jul 3, 2021

Rapptz deleted the phantom-code-lens branch July 4, 2021 01:49

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add setting to render code lenses as a phantom #1750

Add setting to render code lenses as a phantom #1750

Rapptz commented Jun 15, 2021

predragnikolic commented Jun 15, 2021

Rapptz commented Jun 16, 2021 •

edited

Loading

Rapptz commented Jun 20, 2021

rchl left a comment •

edited

Loading

rwols left a comment

Rapptz commented Jun 26, 2021 •

edited

Loading

TerminalFi commented Jul 1, 2021

rwols left a comment

Add setting to render code lenses as a phantom #1750

Add setting to render code lenses as a phantom #1750

Conversation

Rapptz commented Jun 15, 2021

predragnikolic commented Jun 15, 2021

Rapptz commented Jun 16, 2021 • edited Loading

Rapptz commented Jun 20, 2021

rchl left a comment • edited Loading

Choose a reason for hiding this comment

rwols left a comment

Choose a reason for hiding this comment

Rapptz commented Jun 26, 2021 • edited Loading

TerminalFi commented Jul 1, 2021

rwols left a comment

Choose a reason for hiding this comment

Rapptz commented Jun 16, 2021 •

edited

Loading

rchl left a comment •

edited

Loading

Rapptz commented Jun 26, 2021 •

edited

Loading