The Gleam Language Server reference is in error for Helix

[Pierre-Thibault]

The Gleam Language Server reference is incorrect, saying that Helix does not need configuration.

I had to add this in the configuration ( languages.toml) to make the formatter work:

[[language]]
name = "gleam"
formatter = { command = "gleam", args = ["format", "--stdin"] }
scope = "source.gleam"
file-types = ["gleam"]
language-servers = ["gleam"]
auto-format = true

Otherwise, no formatter is recognized.

Can you please fix the documentation?

My system:

gleam 1.5.1
helix 24.7

[lpil]

Thank you, but is not correct configuration, as any editor that supports LSP should not be using the command line API for formatting. Helix can use the language server for formatting.

[Pierre-Thibault]

The LSP and the formatter in Helix are two different things.

With my config (the config listed in the first message of this thread):

$ hx --health gleam
Configured language servers:
  ✓ gleam: /nix/store/mygy7lkm3sgcj3a0myva1is6ih9fqh6j-gleam-1.5.1/bin/gleam
  ✓ typos-lsp: /etc/profiles/per-user/pierre/bin/typos-lsp
Configured debug adapter: None
Configured formatter: gleam
Binary for formatter: /nix/store/mygy7lkm3sgcj3a0myva1is6ih9fqh6j-gleam-1.5.1/bin/gleam
Highlight queries: ✓
Textobject queries: ✓
Indent queries: ✘

But, if I removed my config:

$ hx --health gleam
Configured language servers:
  ✓ gleam: /nix/store/mygy7lkm3sgcj3a0myva1is6ih9fqh6j-gleam-1.5.1/bin/gleam
Configured debug adapter: None
Configured formatter: None
Highlight queries: ✓
Textobject queries: ✓
Indent queries: ✘

What do you suggest?

[lpil]

Helix has fallback support for CLI based formatters for when no LS is available for a language, or when the LS for a language does not support formatting.
The Gleam LS is how formatting is done within text editors for Gleam, including Helix.

This is configured by default in Helix. If you have problems with this try running Helix without any custom configuration.

[Pierre-Thibault]

If I remove my custom configuration my renaming helix to helix_ in ~/.config, I no longer have a Gleam formatter:

$ mv helix helix_
$ hx --health gleam
Configured language servers:
  ✓ gleam: /nix/store/mygy7lkm3sgcj3a0myva1is6ih9fqh6j-gleam-1.5.1/bin/gleam
Configured debug adapter: None
Configured formatter: None
Highlight queries: ✓
Textobject queries: ✓
Indent queries: ✘
mv helix_ helix

If I restore my custom configuration, my Gleam formatter is back:

$ mv helix_ helix
$ hx --health gleam
Configured language servers:
  ✓ gleam: /nix/store/mygy7lkm3sgcj3a0myva1is6ih9fqh6j-gleam-1.5.1/bin/gleam
  ✓ typos-lsp: /etc/profiles/per-user/pierre/bin/typos-lsp
Configured debug adapter: None
Configured formatter: gleam
Binary for formatter: /nix/store/mygy7lkm3sgcj3a0myva1is6ih9fqh6j-gleam-1.5.1/bin/gleam
Highlight queries: ✓
Textobject queries: ✓
Indent queries: ✘

There is no Gleam formatter by default with Helix. The LS is found automatically but not its formatter.

While the LSP supports formatting, it seems Helix does not use the capability by default. So, we need a configuration.

What do you think?

[lpil]

Again, that formatter configuration is only for when no LS is available. You have a LS, so the formatter is not required.

Helix will format Gleam out-of-the-box using the LS. It would be very strange for the Helix maintainers to disable Gleam formatting but enable all other LS features.

[Pierre-Thibault]

You are right. Even if no custom configuration is present, the formatter is still working. 😃

I thought I had no formatter, since no custom one was listed.

I guess we can close the issue then. Or maybe, add a note in the documentation that the formatter is working even if no custom formatter is listed to avoid any future confusion?