gleam-lang/gleam

LSP: Rename modules

Closed

#4,370 opened on Mar 18, 2025

View on GitHubContributor guide
 (7 comments) (3 reactions) (0 assignees)Rust (960 forks)batch import
help wanted

Repository metrics

Stars
 (21,417 stars)
PR merge metrics
 (PR metrics pending)

Description

Given a file called foo.gleam, (module name foo), and lots of other modules that have import foo and also call foo.stuff().

When foo.gleam gets renamed, we can give the user a choice to auto-rename all references and imports.

We may also want to have a rename module code action when on top of a module reference or import, which would need to also rename the file.

Contributor guide

Research direction
Investigate the current LSP implementation in the Gleam compiler, specifically the 'gleam lsp' crate. Look at how existing code actions (like 'Rename Symbol') are implemented, especially the handling of file system changes. The issue mentions that renaming a module should also update all imports and file references. Start by examining the 'rename' module in the LSP and understand how module references are tracked. Additionally, review the comments on the issue for any implementation suggestions or concerns.
Tech stack
rust
Domain
developer experiencetooling
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-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
LSP protocol basicsGleam module systemRustCode actions in LSP
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40