[WIP] Use inlay hints to render captures #34
Conversation
src/extension.ts
Outdated
| const result = await client.sendRequest(ExecuteCommandRequest.type, { | ||
| command: "inferredCaptures", | ||
| arguments: [{ uri: document.uri.toString() }] | ||
| }) as { location: vscode.Location, captureText: string }[]; | ||
|
|
||
| log("Inlay hints result: " + JSON.stringify(result)); | ||
|
|
||
| if (!result) { | ||
| log("No results returned."); | ||
| return hints; | ||
| } |
There was a problem hiding this comment.
Sometimes the backend just returns null, no idea why.
|
Sometimes it's a bit much to see them. What's the expected UX? Should we even show empty captures? |
Agreed. The use case is teaching ( / demos ) and debugging. So roughly the same as it is right now. In order to see the captures, you'll have to enable showCaptures in the Effekt VSCode plugin config and enable inlay hints in the VSCode config. So even more complicated than it is right now :) It also serves as a tiny proof of concept of how we could even use inlay hints in the future. (It's a super rough WIP experiment since I though "well how hard could it be".)
Yes, I think it's worth it for both of the mentioned use cases. EDIT: For clarity, here's how you can set up how your inlay hints look in VSCode: |
| // Truncate long captures ourselves. | ||
| // TODO: Does this make sense? Shouldn't we at least show the first one? | ||
| // TODO: Can the backend send them in a list so that we can have a somewhat stable (alphabetic?) order? | ||
| const hintText = response.captureText.length > 30 ? "{…}" : response.captureText; |
There was a problem hiding this comment.
VSCode actively truncates inlay hints that are too long (something like 34 chars?), therefore it's better that we try to truncate ourselves. We can bike shed the proper constant here, but should we show at least some captures like {async, io, Exception, ...} or should we just go to {...} in such a case (and rely only on the hover like in the screenshot above?)
Very WIP, but here are a few screenshots:
A short-term goal is to retire the current hacky implementation of rendering inferred captures (by using inlay hints instead).
A long-term goal would be to use inlay hints as a proper mechanism on the server side (relevant to effekt-lang/effekt#524)
Resolves #32 (mostly by accident)
Current issues / TODOs:
inferredCapturesAPI works, sometimes it's weirdly invalidated? (If I figure out what I should want, we could even change the Effekt compiler here...)showCaptures, add to docs that one needs to enable inlay hints in the editor globally (as a feature)holescode can also be replaced by this perhaps? (probably not though)