gleam-lang/gleam

LSP: Inlay hints for multiline pipelines

Open

#3,291 opened on Jun 18, 2024

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Rust (21,417 stars) (960 forks)batch import
help wanted

Description

It would be nice to have inlay hints showing the type of each line in a pipeline expression (that span across multiple lines)

This is the way this is shown in Rust: Screenshot 2024-06-18 at 18 25 21

I have a working POC in this PR

Open questions

  1. in a a |> f() |> ... |> g() expression, should we show a's type? (Rust shows it)
    1. should we show it even if the value if a simple literal (e.g. string or int)?
    2. should we show it even if the value is a variable whose type is a type with the same name? (e.g. html: Html)

Previous attempts

https://github.com/gleam-lang/gleam/issues/2319, https://github.com/gleam-lang/gleam/pull/2393, https://github.com/gleam-lang/gleam/pull/2525

Contributor guide

Tech stack
rust
Domain
developer experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
needs maintainer response
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Gleam compiler internalsRustLSP protocolPipeline type inference
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Review the POC in PR #3290. Understand how pipeline expressions are parsed and type checked in the compiler. Explore the existing inlay hints implementation for other expressions. Address the open questions about showing variable types and edge cases. Discuss with maintainers on preferred behavior.