Copy diagnostic hover text

[predragnikolic]

This is a POC that could address #2600

Sublime.Text.mp4

This enables coping hover responses from server,
and diagnostics text, at the moment.

TODO:

• Error diagnostics look broken, need to fix that.()

-[] Add logic to copy signature help as well.

closes #2600

[rchl]

What about a case when the popup also shows other info like symbol documentation? Is the whole contents of the popup copied or each section is copied separately. If the latter then it would probably be hard to convey what is going to get copied.

[netlify]

✅ Deploy Preview for sublime-lsp ready!

Name	Link
🔨 Latest commit	ab65e90
🔍 Latest deploy log	https://app.netlify.com/projects/sublime-lsp/deploys/68b87f1df926670008c069f2
😎 Deploy Preview	https://deploy-preview-2618--sublime-lsp.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[predragnikolic]

Latest update after c0957cb

[predragnikolic]

FWIW, I do find the pngs approach nicer looking #2618 (comment)
then the utf-char #2618 (comment)

[predragnikolic]

We are getting close with this, we just need to decide
png or utf-8

[predragnikolic]

I do find the png approach nicer looking (because the icon is a bit bigger, a nicer looking, but it cannot be customized with css, and it does require more code)

Based on the above messages, Rafal and Janos are leaning towards utf-8.
1 person is for png, 2 are for utf, so I guess the utf-8 char approach wins. But please confirm.

(also no rush in the decision)

[rchl]

I do find the png approach nicer looking (because the icon is a bit bigger, a nicer looking, but it cannot be customized with css, and it does require more code)

Based on the above messages, Rafal and Janos are leaning towards utf-8. 1 person is for png, 2 are for utf, so I guess the utf-8 char approach wins. But please confirm.

(also no rush in the decision)

I agree that utf-8 character looks a bit worse due to the fact that at least on Mac it looks a bit blurry at default 1rem. It looks good at 1.2rem but then it makes line height taller... I don't see a way to fix that with limited minihtml capabilities.
Then font rendering is also very OS/font specific so it might look better (or worse ;)) for others.

I would still take utf-8 version for its simplicity and versatility.

[jwortmann]

If I click the copy icon in the popup when hovering the gutter icon, a webbrowser (which is not even my default browser) opens...

[predragnikolic]

Nice catch. Found the reason ->

LSP/plugin/documents.py

    def _on_navigate(self, href: str, point: int) -> None:
        if href.startswith('code-actions:'):
            ...
            else:
                self.handle_code_action_select(config_name, actions, 0)
        else:
            open_in_browser(href)

[jwortmann]

The icon is a bit blurry on Windows too (I assume Segoe UI Symbol font), but I'd say it looks okay.

I tried some alternatives:

U+2BBA (less blurry, but slightly smaller):

U+2BBB (hm... too bright):

[predragnikolic]

I did try one other approach. but no success.
But for documentation purposes here it is:

To avoid the blur I did try to create the icon with css,
with a combination of borders/ padding/inline-boxes/border radius...

But minihtml doesn't behave as html and css, so I either break height of the outer box, or I break the look of the boxes itself.

[jwortmann]

This function could be inlined, since it consists of only a single expression and is not used elsewhere:

copy_text = f"{diagnostic['message']} {f'({source})' if source else ''}".strip()
html += f"""<a class='copy-icon' title='Copy to clipboard' href='{sublime.command_url(
        'lsp_copy_text', {'text': copy_text}
    )}'>⧉</a>"""

[jwortmann]

One thing I noticed is that the copied text can contain for example non-breaking space characters. But this happens because the server (in this case Pyright) already contains these characters as \n\xa0\xa0 in the JSON payload, assumingly to enforce indentation after a linebreak, which would otherwise not get through the HTML rendering in the popup. Perhaps we should filter out/replace such characters? On the other hand that would feel a bit arbitrary and ultimatively it's the responsibility of the server what it puts into the diagnostic message.

[predragnikolic]

Perhaps we should filter out/replace such characters?

I had code for this, but I reverted it because later I could not find the exact example on why I added the code in the first place baed32c

I am in favor of replacing such chars, I think it benefits the user.

[predragnikolic]

Hello, if there are no further comments, I will merge this PR tonight.