Lsp/inlay hints on pipes and functions #3290

ascandone · 2024-06-18T16:21:49Z

edit: in addition to the inlay hints on pipelines, this PR also implements inlay hints for functions' parameter types (via the gleam.inlayHints.parameterTypes option) and for functions' return type (via the gleam.inlayHints.returnTypes option)

Implements #3291

This PR shows inlay hints with the type of a pipeline step (only for pipeline expressions that span across multiple lines). Hints won't be shown for literal values (ints, floats, strings, bitstrings
The functionality is toggled via the gleam.inlayHints.pipelines client config option

The PR uses the type_::printer::Printer to pretty print the types, thus all the rigid type vars, aliases, etc are already taken care of, and the output should be consistent with the mouse hover output

The PR is meant to be read as a whole, not commit by commit

Here's the vscode client PR: gleam-lang/vscode-gleam#82

How to activate hints

Vscode

Once the vscode client pr is merged, it will be possible to toggle the option via the vscode settings

Sublime text

The user will need to enable the functionality in the settings of the LSP sublime extension:

{
  "clients": {
    "gleam": {
      "settings": {
        "gleam.inlayHints.pipelines": true
      }
    }
  },
}

Nvim

The user will need to enable the functionality in the init.lua file:

require'lspconfig'.gleam.setup{
  settings = {
    gleam = {
      inlayHints = {
        pipelines = true,
      },
    },
  },
}

Future development

handle hover on inlay hints (e.g. show type doc)
handle click on inlay hints (e.g. goto definition or add annotations)
other possible inlay hints:
- function calls args, e.g. my_fn(/*param_name*/0, /* other_param*/ 100)
- local let bindings, e.g. let x/*: Int*/ = my_fn(). Same for use bindings
- bindings of case patterns

Credits

The part of the pr about config is partially based upon this previous pr #2393

ascandone · 2024-06-21T22:54:55Z

Hi @lpil the PR is almost ready for review.
Is it ok for it to implement the feature without including a switch in the config (for now)?

If not, could we consider merging the PR (once it's reviewed) as dead code? (e.g. setting the inlay_hint_provider option as false in the capabilities config)
This would decrease the risk of having conflicts while I try to implement the config part (that would also involve a PR on the client)

lpil · 2024-06-23T12:30:13Z

Is it ok for it to implement the feature without including a switch in the config (for now)?

How would the programmer turn it on in this case? I think they need to be able to turn it on and add as needed in a straightforward fashion.

ascandone · 2024-06-23T12:54:38Z

Is it ok for it to implement the feature without including a switch in the config (for now)?

How would the programmer turn it on in this case? I think they need to be able to turn it on and add as needed in a straightforward fashion.

It wouldn't be possible. What I was proposing was either:

To just implement the feature without allowing to turn it off (for now)
To merge the feature as dead code, and then right after try to implement another PR to create the option in the config. This would just reduce the odds of having git conflicts in case I take too much time implementing the config part

Otherwise I can just try to implement the config part in this PR

compiler-core/src/ast/inlay_hints.rs

compiler-core/src/language_server/configuration.rs

ascandone · 2024-06-25T12:49:24Z

@lpil I think that should be it 🙂
(sorry for the ping, I didn't know if marking the PR as ready already sends you a notification)

ascandone · 2024-07-05T13:16:57Z

@lpil I've updated the PR with the description of how to turn the feature on. In general, it requires setting to true the gleam.inlayHints.pipelines client config option, but every editor has it's way to do that

Depending on the editor, there could be ways to turn it on momentarily (e.g. with a keyboard shortcut)
E.g. this (untested) config (took from here)

if client and client.server_capabilities.inlayHintProvider and vim.lsp.inlay_hint then
    map('<leader>th', function()
        vim.lsp.inlay_hint.enable(not vim.lsp.inlay_hint.is_enabled())
    end, '[T]oggle Inlay [H]ints')
end

lpil

Great stuff! Thank you very much for waiting too, I've nearly got through all the compiler PRs 😅

compiler-core/src/ast/inlay_hints.rs

compiler-core/src/ast/tests/inlay_hints.rs

lpil · 2024-07-13T17:21:29Z

compiler-core/src/language_server/configuration.rs

+}
+
+#[derive(Debug, Clone, Deserialize)]
+#[serde(rename_all = "camelCase")]


snake_case please, we never use camelCase

update: I noticed that for a better integration with vscode, it's better to use camelCase instead
you can take a look at how it is rendered in the client side pr: gleam-lang/vscode-gleam#82

This still needs to be done.

compiler-core/src/language_server/messages.rs

lpil · 2024-07-13T17:24:32Z

compiler-core/src/language_server/messages.rs

+
+    fn configuration_update_received(&mut self, result: serde_json::Value) -> Next {
+        let Some(first_el) = result.as_array().and_then(|a| a.first()) else {
+            return Next::MorePlease;


Shouldn't this be an error?

lpil · 2024-07-13T17:25:31Z

compiler-core/src/language_server/messages.rs

+    }
+
+    fn response(&mut self, response: lsp_server::Response) -> Next {
+        if let Some(handler) = self.response_handlers.remove(&response.id) {


When would it be valid for there to be a response that we don't have a handler for? Or there being a handler but no result in the response?

This question hasn't been answered!

I'm also a bit confused as I can't see where this function is used- where can I find that?

compiler-core/src/language_server/tests/inlay_hints.rs

ascandone · 2024-07-30T16:36:03Z

Sorry for keeping it open for a long time; I had less time recently but I might able to make it to the finish line in the following days

lpil · 2024-08-20T12:17:57Z

Hello! Sorry, just catch up after my holiday. Is this ready for review?

ascandone · 2024-08-30T17:15:07Z

Hello! Sorry, just catch up after my holiday. Is this ready for review?

Hi Louis, sorry about the wait - I have been a little busy too. There are still a couple of things missing but I should be able to take care of them this week

ascandone · 2024-09-08T15:46:05Z

Hey @lpil everything should be good to go, except for this couple of bits where I am not sure how to handle error within MessageBuffer handlers

gleam/compiler-core/src/language_server/messages.rs

Lines 253 to 257 in 8b63e33

    
           fn configuration_update_received(&mut self, result: serde_json::Value) -> Next { 
        
               let parsed_update_items: Result<(Configuration,), _> = serde_json::from_value(result); 
        
               let Ok((parsed_config,)) = parsed_update_items else { 
        
                   return Next::MorePlease; 
        
               };

gleam/compiler-core/src/language_server/messages.rs

Lines 271 to 280 in 8b63e33

    
           fn response(&mut self, response: lsp_server::Response) -> Next { 
        
               if let Some(handler) = self.response_handlers.remove(&response.id) { 
        
                   if let Some(result) = response.result { 
        
                       return self.handle_response(handler, result); 
        
                   } 
        
               } 
        
               // We do not use or expect responses from the client currently. 
        
               Next::MorePlease 
        
           }

Should I add a new variant to the Next enum? Or return Next::Stop ?

ascandone · 2025-03-14T09:07:13Z

@lpil ready for review 👍

fix: fix rebase issues

lpil

Thank you! I've left some notes inline, and the notes from the previous review still need to be addressed

lpil · 2025-03-16T17:28:51Z

compiler-core/src/ast/typed.rs

@@ -180,6 +180,36 @@ pub enum TypedExpr {
 }

 impl TypedExpr {
+    /// Determines if the expression is a simple literal whose inlayHints must not be showed
+    /// in a pipeline chain
+    pub fn is_simple_lit(&self) -> bool {


What's a simple lit?

This documentation seems to be for some other part of the codebase rather than being generic to all uses of the types AST. Perhaps it belongs elsewhere, or the documentation needs to be updated.

lpil · 2025-03-16T17:29:55Z

compiler-core/src/language_server/configuration.rs

+}
+
+#[derive(Debug, Clone, Deserialize)]
+#[serde(rename_all = "camelCase")]


This still needs to be done.

lpil · 2025-03-16T17:30:39Z

compiler-core/src/language_server/configuration.rs

+    pub pipelines: bool,
+
+    /// Whether to show type inlay hints of function parameters
+    pub parameter_types: bool,


How about function_parameter_types and function_return_types? As it doesn't apply to all type parameters

lpil · 2025-03-16T17:31:38Z

compiler-core/src/language_server/configuration.rs

+use serde::Deserialize;
+use std::sync::{Arc, RwLock};
+
+pub type SharedConfig = Arc<RwLock<Configuration>>;


Remove this alias for clarity please 🙏

lpil · 2025-03-16T17:39:31Z

compiler-core/src/language_server/inlay_hints.rs

+
+impl<'ast> Visit<'ast> for InlayHintsVisitor<'_> {
+    fn visit_typed_function(&mut self, fun: &'ast crate::ast::TypedFunction) {
+        // This must be reset on every statement


Shouldn't this be inside the loop of statements? Here it's being reset for every module function definition rather than every statement.

lpil · 2025-03-16T17:59:52Z

compiler-core/src/language_server/server.rs

        })
    }

    pub fn run(&mut self) -> Result<()> {
        self.start_watching_gleam_toml();
-        let mut buffer = MessageBuffer::new();
+        self.start_watching_config();
+        let _ = self.request_configuration();


What's this discarded value?

lpil · 2025-03-16T18:00:13Z

compiler-core/src/language_server/server.rs

@@ -168,6 +207,35 @@ where
        }
    }

+    fn start_watching_config(&mut self) {


Can we be more specific with the name please 🙏

lpil · 2025-03-16T18:01:01Z

compiler-core/src/language_server/configuration.rs

+#[derive(Debug, Default, Clone, Deserialize, PartialEq, Eq)]
+#[serde(default)]
+#[serde(rename_all = "camelCase")]
+pub struct Configuration {


This is called configuration here but "user config" elsewhere. Is there a canonical name for this sort of configuration in the protocol?

lpil · 2025-03-16T18:02:12Z

compiler-core/src/language_server/server.rs

@@ -269,6 +333,53 @@ where
        }
    }

+    fn inlay_hints_refresh(&mut self) {


Suggested change

fn inlay_hints_refresh(&mut self) {

fn send_inlay_hints_refresh_request(&mut self) {

lpil · 2025-03-16T18:05:24Z

compiler-core/src/language_server/server.rs

+        self.connection
+            .sender
+            .send(lsp_server::Message::Request(request))
+            .unwrap_or_else(|_| panic!("send {method}"));


Do not discard the error please, otherwise it's hard to debug 🙏

ascandone mentioned this pull request Jun 18, 2024

LSP: Inlay hints for multiline pipelines #3291

Open

ascandone force-pushed the lsp/inlay-hints-on-pipe branch from 64afe96 to 9f46fff Compare June 22, 2024 09:06

ascandone force-pushed the lsp/inlay-hints-on-pipe branch 2 times, most recently from 697960d to 2d52e9e Compare June 25, 2024 01:52

ascandone mentioned this pull request Jun 25, 2024

Add configuration option for inlay hints in pipelines gleam-lang/vscode-gleam#82

Draft

ascandone force-pushed the lsp/inlay-hints-on-pipe branch 4 times, most recently from 9ed02ef to 7894a79 Compare June 25, 2024 12:28

ascandone commented Jun 25, 2024

View reviewed changes

compiler-core/src/ast/inlay_hints.rs Outdated Show resolved Hide resolved

ascandone marked this pull request as ready for review June 25, 2024 12:33

ascandone commented Jun 25, 2024

View reviewed changes

compiler-core/src/language_server/configuration.rs Outdated Show resolved Hide resolved

ascandone force-pushed the lsp/inlay-hints-on-pipe branch from fe20ce7 to 7894a79 Compare July 3, 2024 15:53

ascandone requested a review from lpil July 5, 2024 13:15

lpil reviewed Jul 13, 2024

View reviewed changes

lpil marked this pull request as draft July 13, 2024 17:32

ascandone force-pushed the lsp/inlay-hints-on-pipe branch 3 times, most recently from e6b80fd to 9824c74 Compare July 30, 2024 20:57

ascandone force-pushed the lsp/inlay-hints-on-pipe branch 2 times, most recently from db11626 to f14e019 Compare September 8, 2024 12:29

ascandone marked this pull request as ready for review March 11, 2025 17:06

ascandone force-pushed the lsp/inlay-hints-on-pipe branch 2 times, most recently from f55844a to bb4652d Compare March 13, 2025 19:34

ascandone changed the title ~~Lsp/inlay hints on pipe~~ Lsp/inlay hints on pipes and functions Mar 14, 2025

ascandone added 14 commits March 16, 2025 16:00

Implemented inlay hints

549f676

fix: fix rebase issues

fixes after rebase

5e06b1e

fix functionality

9ba6858

removed snapshots

f588273

impl hints on fn params

bdd704c

cleaned up

d02c23e

fix

aed76cc

refactor

57fd956

more granular config and fixed tests regression

14cc5d4

added tests

488f222

added tests

bc9f5ef

removed snap

889670b

simplify

2e37a23

fix

b0b7bd5

ascandone force-pushed the lsp/inlay-hints-on-pipe branch from bb4652d to b0b7bd5 Compare March 16, 2025 15:01

fix after rebase

d3de0d3

lpil reviewed Mar 16, 2025

View reviewed changes

lpil marked this pull request as draft March 16, 2025 18:06

ascandone added 7 commits March 16, 2025 19:23

moved is_simple_lit utility

99897b1

renamed config options

c6a4ad1

removed SharedConfig type alias

7d30794

renamed function

72977e6

renamed local vars

4376e9b

moved printer reset to a different visitor method

a5dac94

removed abbreviation

1aeaf02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Lsp/inlay hints on pipes and functions #3290

Lsp/inlay hints on pipes and functions #3290

ascandone commented Jun 18, 2024 •

edited

Loading

ascandone commented Jun 21, 2024 •

edited

Loading

lpil commented Jun 23, 2024 •

edited

Loading

ascandone commented Jun 23, 2024 •

edited

Loading

ascandone commented Jun 25, 2024

ascandone commented Jul 5, 2024 •

edited

Loading

lpil left a comment

lpil Jul 13, 2024

ascandone Mar 8, 2025

lpil Mar 16, 2025

lpil Jul 13, 2024

lpil Jul 13, 2024

lpil Mar 16, 2025

ascandone commented Jul 30, 2024

lpil commented Aug 20, 2024

ascandone commented Aug 30, 2024

ascandone commented Sep 8, 2024 •

edited

Loading

ascandone commented Mar 14, 2025

lpil left a comment

lpil Mar 16, 2025

lpil Mar 16, 2025

lpil Mar 16, 2025

lpil Mar 16, 2025

lpil Mar 16, 2025

lpil Mar 16, 2025

lpil Mar 16, 2025

lpil Mar 16, 2025

lpil Mar 16, 2025

lpil Mar 16, 2025

	fn inlay_hints_refresh(&mut self) {
	fn send_inlay_hints_refresh_request(&mut self) {

Lsp/inlay hints on pipes and functions #3290

Are you sure you want to change the base?

Lsp/inlay hints on pipes and functions #3290

Conversation

ascandone commented Jun 18, 2024 • edited Loading

How to activate hints

Vscode

Sublime text

Nvim

Future development

Credits

ascandone commented Jun 21, 2024 • edited Loading

lpil commented Jun 23, 2024 • edited Loading

ascandone commented Jun 23, 2024 • edited Loading

ascandone commented Jun 25, 2024

ascandone commented Jul 5, 2024 • edited Loading

lpil left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ascandone commented Jul 30, 2024

lpil commented Aug 20, 2024

ascandone commented Aug 30, 2024

ascandone commented Sep 8, 2024 • edited Loading

ascandone commented Mar 14, 2025

lpil left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ascandone commented Jun 18, 2024 •

edited

Loading

ascandone commented Jun 21, 2024 •

edited

Loading

lpil commented Jun 23, 2024 •

edited

Loading

ascandone commented Jun 23, 2024 •

edited

Loading

ascandone commented Jul 5, 2024 •

edited

Loading

ascandone commented Sep 8, 2024 •

edited

Loading