gleam-lang/gleam

LSP: Show an error message on an invalid named module

Open

#3,972 opened on Dec 9, 2024

View on GitHub
 (5 comments) (0 reactions) (0 assignees)Rust (21,417 stars) (960 forks)batch import
good first issuehelp wanted

Description

Hi!

Currently, when the LSP opens a Gleam file whose name is incorrect (something like my-module.gleam for instance), nothing happens. It could be nice to let the LSP indicates it as a bug (because gleam build will fail) with a message like "my-module is not a valid name for a Gleam module. You should switch to my_module instead."

Contributor guide

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.
half day
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
Rust programmingUnderstanding of LSP
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
55
Research direction
The issue suggests adding a diagnostic for invalid module names in the Gleam LSP. Look into the LSP crate's codebase, particularly the file where diagnostics are emitted (e.g., `lsp` or `ls` crate). Check how existing diagnostics are implemented, such as for syntax errors. The goal is to add a check for module name validity and emit an error with a suggestion like 'my module' instead of 'my module'. Review existing tests and documentation for adding new diagnostic types.