gleam-lang/gleam

LSP code action: turn (wrong) C-style type definition into a single constructor type

Open

#3,479 opened on Aug 2, 2024

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

Description

Now that the compiler can recognize that when the user is creating this type

pub type User {
  name: String
}

they actually need to define it like this

pub type User {
  User(
    name: String,
  )
}

it would make sense to offer a code action on hover to do that automatically.

Contributor guide

Tech stack
rust
Domain
tooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic knowledge of Gleam syntaxFamiliarity with RustUnderstanding of LSP code actions
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
Look into the Gleam compiler's LSP module, specifically where existing code actions are implemented (e.g., in `lsp/src/code action.rs`). The compiler already recognizes the erroneous C style type definition, so you need to add a code action that transforms it into the correct single constructor type. Review other code actions for patterns, such as import suggestions. The issue mentions offering the action on hover, but consider implementing it as a code action available on the type definition that can then be triggered via the lightbulb. Check linked PRs or comments for any existing experiments.