Feature: Truncate inlay hint label #2514

bivashy · 2024-09-15T19:32:02Z

Description

This pull request allows inlay hints to be truncated, which could be useful if inlay hints are too large. For example: TypeScript has absurdly long inlay hints (see screenshot 1).
The default truncate limit is 1000.
~~Truncated content reveal is not implemented, which means you cannot see the full content of the inlay hint if it is truncated.~~

Tested with:
LSP-typescript
LSP-gopls
LSP-rust-analyzer

1. Long inlay hint

2. `LSP-typescript` (limit 30)

3. `LSP-gopls` (limit 30)

4. `LSP-rust-analyzer` (limit 30)

plugin/inlay_hint.py

LSP.sublime-settings

jwortmann · 2024-09-17T16:20:40Z

Could you use … instead of ...? I think that would look nicer.

I wonder whether this really needs a setting, maybe long labels could instead always be truncated if we pick a reasonable cutoff length? And if the label gets truncated, it could be added to the tooltip, so you can easily see the full inlay hint on mouse hover. So in that case the html.escape of the full label and probably also a \n (or  ?) should be prepended to the title attribute at

LSP/plugin/inlay_hint.py

Line 145 in f4223d6

    
           result += f'<span title="{(tooltip + instruction_text).strip()}">{html.escape(label)}</span>'

and

LSP/plugin/inlay_hint.py

Line 170 in f4223d6

    
           result += f"<span title=\"{(tooltip + instruction_text).strip()}\">{value}</span>"

Could be useful to try whether that works and how it would look like.

bivashy · 2024-09-19T15:16:05Z

Could you use … instead of ...? I think that would look nicer.

Maybe we should make this configurable from the preferences? Or is this redundant?

And if the label gets truncated, it could be added to the tooltip, so you can easily see the full inlay hint on mouse hover. So in that case the html.escape of the full label and probably also a \n (or  ?) should be prepended to the title attribute at

LSP/plugin/inlay_hint.py

Line 145 in f4223d6

result += f'{html.escape(label)}'

and

LSP/plugin/inlay_hint.py

Line 170 in f4223d6

result += f"{value}"

Could be useful to try whether that works and how it would look like.

I'll try to implement that.

I am not sure how we would choose a reasonable length, because it might vary by language and user preference, someone might be fine with big inlay hints, but other people would want to have very short inlay hints.

rchl · 2024-09-19T15:47:44Z

Could you use … instead of ...? I think that would look nicer.

Maybe we should make this configurable from the preferences? Or is this redundant?

We strive to limit the number of exposed options so no. But also … is the correct one to use semantically. Three separate dots don't mean much semantically. And also it's slightly shorter.

bivashy · 2024-09-19T19:25:36Z

I've used suggested characters instead of plain ..., I think it looks nice.

plugin/inlay_hint.py

netlify · 2024-09-22T16:30:26Z

✅ Deploy Preview for sublime-lsp ready!

Name	Link
🔨 Latest commit	`1ba72a6`
🔍 Latest deploy log	https://app.netlify.com/sites/sublime-lsp/deploys/66f045ef1176bd0008be3e70
😎 Deploy Preview	https://deploy-preview-2514--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 site configuration.

netlify · 2024-09-22T16:31:14Z

✅ Deploy Preview for sublime-lsp ready!

Name	Link
🔨 Latest commit	`1c313b5`
🔍 Latest deploy log	https://app.netlify.com/sites/sublime-lsp/deploys/66f04600868a650008791ad6
😎 Deploy Preview	https://deploy-preview-2514--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 site configuration.

netlify · 2024-09-22T16:32:01Z

✅ Deploy Preview for sublime-lsp ready!

Name	Link
🔨 Latest commit	`8e86dc3`
🔍 Latest deploy log	https://app.netlify.com/sites/sublime-lsp/deploys/6730d04c54b4ae0008299b68
😎 Deploy Preview	https://deploy-preview-2514--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 site configuration.

plugin/inlay_hint.py

jwortmann · 2024-10-03T12:41:42Z

I think a better default length would be something like 30 or 40, and I would probably name the setting "inlay_hints_truncate_length" or "inlay_hints_max_length" (just a suggestion).

plugin/inlay_hint.py

jwortmann · 2024-10-25T14:08:03Z

plugin/inlay_hint.py

-
+    remaining_truncate_limit = truncate_limit
+    full_label = "".join(label_part['value'] for label_part in label)
+    full_label_truncated = len(full_label) >= truncate_limit and truncate_limit > 0


Should this also be > here or not?

I have tested the PR with a server that uses the regular label (no label parts) and I think it works well with the tooltips.

My only suggestion left would be to use a lower default value for the setting. I think 30 would be a sane default. I would say the truncation is actually a good thing to do, and some users might not check settings or read update notes, so it should be applied by default. Opinions?

Should this also be > here or not?

I have tested the PR with a server that uses the regular label (no label parts) and I think it works well with the tooltips.

My only suggestion left would be to use a lower default value for the setting. I think 30 would be a sane default. I would say the truncation is actually a good thing to do, and some users might not check settings or read update notes, so it should be applied by default. Opinions?

I'll check it out. Thanks for pointing that out.

I think inlay hint is not enabled by default, so most users will not be affected. So I agree that this feature should be enabled by default. I'll wait for more opinions.

I'll check it out. Thanks for pointing that out.

Done in d6a544a.

Done in a43e68a

I will not resolve this conversation in case of reconsideration, should I?

sublime-package.json

jwortmann · 2024-11-08T17:59:36Z

LSP.sublime-settings

@@ -180,6 +180,9 @@
   // or a custom keybinding.
  "show_inlay_hints": false,

+  // Maximum length for inlay hints. Truncates exceeding characters and adds an ellipsis. Zero or less means no truncation.


A linebreak would be nice here. Less than zero would violate the JSON schema btw.

I pushed a small change for the description.

Is there anything more or can we merge the PR? (I have tested only for the regular inlay hints without label parts)

I pushed a small change for the description.

Is there anything more or can we merge the PR? (I have tested only for the regular inlay hints without label parts)

I think it is ready to use. I don't have any more changes.

Thanks to all reviewers for their patience!

A linebreak would be nice here. Less than zero would violate the JSON schema btw.

Linebreak after each sentence, if I understand correctly

bivashy added 5 commits September 15, 2024 23:26

Truncate inlay hint label

1d85bcc

Split long line into multiple lines

41150db

Add inlay_truncate_limit into settings

0c9f49c

Add inlay_truncate_limit into sublime package

9755ed2

Fix missing ellipsis at specific cases

5c86172

rchl reviewed Sep 17, 2024

View reviewed changes

plugin/inlay_hint.py Outdated Show resolved Hide resolved

plugin/inlay_hint.py Outdated Show resolved Hide resolved

rchl reviewed Sep 17, 2024

View reviewed changes

LSP.sublime-settings Outdated Show resolved Hide resolved

bivashy added 2 commits September 17, 2024 20:05

Rename property inlay_truncate_limit into inlay_hints_truncate_limit

528a430

Do not modify method variable, use local variable instead

6335b74

Make sure that truncation limit is exclusive

8265c1b

Split long line into multiple lines

c43d722

bivashy added 2 commits September 20, 2024 00:30

Replace three dots with a compact character

a882902

Inlay hint tooltip implementation

808e817

jwortmann reviewed Sep 20, 2024

View reviewed changes

plugin/inlay_hint.py Outdated Show resolved Hide resolved

jwortmann reviewed Sep 20, 2024

View reviewed changes

plugin/inlay_hint.py Outdated Show resolved Hide resolved

bivashy added 2 commits September 22, 2024 21:29

Read from user preference directly

1ba72a6

Show truncation tooltip if label is raw string

1c313b5

Merge branch 'main' into main

25be2dd

rchl reviewed Sep 22, 2024

View reviewed changes

plugin/inlay_hint.py Outdated Show resolved Hide resolved

rchl reviewed Sep 22, 2024

View reviewed changes

plugin/inlay_hint.py Outdated Show resolved Hide resolved

rchl reviewed Sep 22, 2024

View reviewed changes

plugin/inlay_hint.py Outdated Show resolved Hide resolved

bivashy added 2 commits September 26, 2024 11:36

Fix typo

c618857

Merge remote-tracking branch 'origin/main'

cc4ad00

bivashy added 3 commits October 3, 2024 00:43

Inclusive truncate limit

abe0987

Change default truncate limit to 100

17591c1

Support negative, or zero truncate limit

09162a2

jwortmann reviewed Oct 3, 2024

View reviewed changes

plugin/inlay_hint.py Outdated Show resolved Hide resolved

bivashy and others added 6 commits October 3, 2024 21:43

Merge branch 'main' into main

79fee60

Merge branch 'main' into main

19a991a

Rename inlay_hints_truncate_limit into inlay_hints_max_length

0496789

Append truncation tooltip instead of wrapping result

c6e0055

Merge branch 'main' into main

e5b9050

Merge branch 'main' into main

c4c74cc

bivashy requested a review from rchl October 22, 2024 17:29

jwortmann reviewed Oct 23, 2024

View reviewed changes

plugin/inlay_hint.py Outdated Show resolved Hide resolved

bivashy added 2 commits October 25, 2024 17:15

Remove empty lines

b83a147

Change truncation limit to exclusive one.

9be92d9

jwortmann reviewed Oct 25, 2024

View reviewed changes

sublime-package.json Outdated Show resolved Hide resolved

bivashy and others added 5 commits October 26, 2024 01:46

Match sublime-package.json with settings description

dc7d5ca

Merge branch 'main' into main

87db8f3

Change truncation limit to exclusive

d6a544a

Merge branch 'main' into main

0a4a246

Lower the limit of the inlay hint

a43e68a

rchl reviewed Nov 4, 2024

View reviewed changes

sublime-package.json Outdated Show resolved Hide resolved

bivashy and others added 2 commits November 8, 2024 10:36

Merge branch 'main' into main

875a7a0

Specify missing truncation case in description

572b1cd

jwortmann approved these changes Nov 8, 2024

View reviewed changes

jwortmann and others added 2 commits November 10, 2024 15:36

Tweak setting description

b039ea8

Merge branch 'main' into main

8e86dc3

rchl approved these changes Nov 10, 2024

View reviewed changes

rchl merged commit 2f37a49 into sublimelsp:main Nov 10, 2024
8 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature: Truncate inlay hint label #2514

Feature: Truncate inlay hint label #2514

bivashy commented Sep 15, 2024 •

edited

Loading

jwortmann commented Sep 17, 2024 •

edited

Loading

bivashy commented Sep 19, 2024 •

edited

Loading

rchl commented Sep 19, 2024

bivashy commented Sep 19, 2024 •

edited

Loading

netlify bot commented Sep 22, 2024

netlify bot commented Sep 22, 2024

netlify bot commented Sep 22, 2024 •

edited

Loading

jwortmann commented Oct 3, 2024

jwortmann Oct 25, 2024

bivashy Oct 25, 2024

bivashy Nov 4, 2024

jwortmann Nov 8, 2024

jwortmann Nov 10, 2024

bivashy Nov 10, 2024

bivashy Nov 10, 2024

Feature: Truncate inlay hint label #2514

Feature: Truncate inlay hint label #2514

Conversation

bivashy commented Sep 15, 2024 • edited Loading

Description

1. Long inlay hint

2. `LSP-typescript` (limit 30)

3. `LSP-gopls` (limit 30)

4. `LSP-rust-analyzer` (limit 30)

jwortmann commented Sep 17, 2024 • edited Loading

bivashy commented Sep 19, 2024 • edited Loading

rchl commented Sep 19, 2024

bivashy commented Sep 19, 2024 • edited Loading

netlify bot commented Sep 22, 2024

✅ Deploy Preview for sublime-lsp ready!

netlify bot commented Sep 22, 2024

✅ Deploy Preview for sublime-lsp ready!

netlify bot commented Sep 22, 2024 • edited Loading

✅ Deploy Preview for sublime-lsp ready!

jwortmann commented Oct 3, 2024

jwortmann Oct 25, 2024

Choose a reason for hiding this comment

bivashy Oct 25, 2024

Choose a reason for hiding this comment

bivashy Nov 4, 2024

Choose a reason for hiding this comment

jwortmann Nov 8, 2024

Choose a reason for hiding this comment

jwortmann Nov 10, 2024

Choose a reason for hiding this comment

bivashy Nov 10, 2024

Choose a reason for hiding this comment

bivashy Nov 10, 2024

Choose a reason for hiding this comment

bivashy commented Sep 15, 2024 •

edited

Loading

jwortmann commented Sep 17, 2024 •

edited

Loading

bivashy commented Sep 19, 2024 •

edited

Loading

bivashy commented Sep 19, 2024 •

edited

Loading

netlify bot commented Sep 22, 2024 •

edited

Loading