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 (960 forks)batch import
good first issuehelp wanted

Repository metrics

Stars
 (21,417 stars)
PR merge metrics
 (Avg merge 10d 19h) (69 merged PRs in 30d)

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

Research direction
Look at the LSP diagnostics code to understand how module names are validated and add a check for invalid module names.
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.
2
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Rust
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70