Add syntax highlighting and LSP (erlang_lsp) for Erlang #7093

codeadict · 2024-01-30T16:19:21Z

This pull request implements support for the Erlang Language.

It adds:

tree-sitter-erlang grammar
highlights (Licensed under Apache-2 from WhatsApp which is compatible with Zed licensing model), folds and indents
Erlang file icon based on the official one
erlang_ls support

Fixes #4939, possibly a duplicate of #7085 with more features. Suppose @wingyplus wants to join efforts here.

To complete (out of scope for this PR):

Support for the ELP language server from WhatsApp. CC @robertoaloi
Better indentation handling, need something like indentNextLinePattern in VS Code

Screenshots:

Outline:

Release Notes:

Added Erlang Support (Add syntax highlighting and LSP (erlang_lsp) for Erlang #7093).

cla-bot · 2024-01-30T16:19:23Z

We require contributors to sign our Contributor License Agreement, and we don't have @codeadict on file. You can sign our CLA at https://zed.dev/cla. Once you've signed, post a comment here that says '@cla-bot check'.

cla-bot · 2024-01-30T16:19:48Z

We require contributors to sign our Contributor License Agreement, and we don't have @codeadict on file. You can sign our CLA at https://zed.dev/cla. Once you've signed, post a comment here that says '@cla-bot check'.

wingyplus · 2024-01-31T05:08:12Z

crates/zed/src/languages/erlang/highlights.scm

+  "undef"
+  "unit"
+  "when"
+  "xor"] @keyword


Do we need to move and, or, not, and xor to @keyword.operator since it's the same as andalso and orelse?

and, or, xor, and not are boolean operators and do not control flow. orelse and andalso are control operators. For the highlighter they look the same but they are semantically different which I think makes sense to differentiate :

codeadict · 2024-01-31T15:43:04Z

This is ready for review now. Have tested it with a few big Erlang projects and is working great.

SomeoneToIgnore

Great scm files, thank you for creating a PR.

There are a few style nits and one odd "gitmodules": "vcs", file association removal, which does not look right.
Let's fix all together and merge this?

assets/icons/file_icons/file_types.json

crates/zed/Cargo.toml

SomeoneToIgnore · 2024-02-01T13:10:37Z

One other thing I'm interested about: I have tried to run the branch, with zero Erlang experience before.
I've installed erlang via brew and erl seem to work, cloned https://github.com/erlang/otp and tried to run Zed in its root.
And in the stderr, I see

[2024-02-01T15:06:03+02:00 ERROR project] failed to start language server "erlang_ls": No such file or directory (os error 2)
[2024-02-01T15:06:03+02:00 ERROR project] server stderr: Some("")

and no erlang-related entries in Zed's LSP logs.
I have ~/Library/Application Support/Zed/languages/erlang_ls directory, but it's empty.

What am I doing wrong? If nothing seems so, could you try removing that language directory locally, and recheck that part?

wingyplus · 2024-02-01T14:29:17Z

One other thing I'm interested about: I have tried to run the branch, with zero Erlang experience before. I've installed erlang via brew and erl seem to work, cloned https://github.com/erlang/otp and tried to run Zed in its root. And in the stderr, I see
[2024-02-01T15:06:03+02:00 ERROR project] failed to start language server "erlang_ls": No such file or directory (os error 2)
[2024-02-01T15:06:03+02:00 ERROR project] server stderr: Some("")
and no erlang-related entries in Zed's LSP logs. I have ~/Library/Application Support/Zed/languages/erlang_ls directory, but it's empty.

What am I doing wrong? If nothing seems so, could you try removing that language directory locally, and recheck that part?

@SomeoneToIgnore As far as I know, the adaper didn't download the erlang_ls for you (see from https://github.com/zed-industries/zed/pull/7093/files#diff-20bc59f7eda9211db28f8a2d600c59bb7b2b6fa816c68d9a929a7b2e4f661a7dR32). So the erlang_ls binary needs to present in your PATH.

SomeoneToIgnore · 2024-02-01T14:43:03Z

Oh, I see that https://github.com/erlang-ls/erlang_ls/releases/tag/0.50.0 does not have any mac binaries, so that's why, most probably: Zed does not have the code to download LSP server binaries elsewhere.
Thank you for the explanation!

wingyplus · 2024-02-01T14:52:48Z

crates/zed/src/languages/erlang/highlights.scm

+(callback fun: (atom) @function)
+
+;; wild attribute
+(wild_attribute name: (attr_name name: (atom) @keyword))


I found a bit of weird highlighting for wild_attribute node. It got highlighted as an atom (string.special.symbol) like screenshot below.

You can see that -dialyzer should be highlight as same as -record and friends. After moving the wild_attribute node to under atom at line 229, it works.

I'm not sure if it's the right fix. My tree-sitter knowledge is limited.

Submit a fix at codeadict#1. 🙇

I think the problem here is that dialyzer is not defined as a keyword and acts as an atom

I would not put primitives so high in the file and rather move the wild attributes to override them. I have done that and here is the result:

codeadict · 2024-02-01T16:02:02Z

Thanks for the help @wingyplus and @SomeoneToIgnore . I'll rebase with main now and fix the conflicts. You need to clone erlang_ls and run make, then make install to have it in the path. I'll submit a patch to Erlang_ls to release OSX binaries , when that is done I will submit another PR here to fetch the LS

Fixes by moving all primitive types to the top of file. Signed-off-by: Thanabodee Charoenpiriyakij <[email protected]>

Signed-off-by: Thanabodee Charoenpiriyakij <[email protected]>

wingyplus · 2024-02-01T16:51:51Z

LGTM! 👌

SomeoneToIgnore

Awesome to see such cooperative desire to bring this in, so let's do that.
Good luck with the macOs langserver releases!

codeadict · 2024-02-01T18:03:06Z

Thank you @SomeoneToIgnore and @wingyplus for the help. More things to come for Erlang soon...

robertoaloi · 2024-02-03T16:47:00Z

Thanks for the heads up @codeadict . Anything you'd need from us to get WhatsApp's ELP integration rolling?

eproxus · 2024-03-13T09:33:37Z

I've used the Erlang support for a while, and it works really well so far! I have a few comments on the syntax highlighting though (not sure what the root cause is, so just posting here hoping someone can at least explain it) 🙂

Module names, function definitions, function names, atoms and "keys" (atoms as keys in maps, for example) are all highlighted as atom which makes it not very useful
Macros and variables are both highlighted as var which also makes it harder to distinguish between them

Technically in Erlang module and function names are atoms, but in terms of syntax highlighting it is not very useful. Would it be possible to further specify subtypes or enhance this in someway? Other languages have e.g. special types for both function definitions and calls which makes them highlight very nicely.

Here's an example where pretty much only two colors are used (not counting the arity integer):

With some themes (such as Ayu Dark) they are even set to the same color (!).

wingyplus · 2024-03-26T06:15:09Z

Hi @eproxus, sorry for a bit late. I think we can modify the highlight query to support the function. I remember I have been doing this before this PR opened. So I will find the time in this week to make it better. 🙇‍♂️

eproxus · 2024-04-15T09:10:51Z

@wingyplus Do you know if it is possible with tree sitter and Zed to highlight all the differences mentioned?

Module names
Function definitions
Function calls
1. Internal (local calls)
2. External (fully qualified calls, e.g. module:function(...), even to the same module)
Atoms as map keys

codeadict · 2024-05-08T19:30:59Z

@eproxus - I have been out for a while, busy with work. I saw your message on the Erlang Slack, I'll be looking into highlighting the differences you mentioned. Will also add support for the ELP LS that has semantic highlighting support and can help with these things too.

eproxus · 2024-05-14T10:02:11Z

@codeadict Not stress ☺️ Let me know if you need help with testing.

Yozhig · 2024-06-17T14:04:56Z

crates/zed/src/languages/erlang/highlights.scm

+;;
+
+
+;; First match wins in this file


Seems like in zed topmost queries have lower priority. I.e. (atom) @string.special.symbol in this file overrides color for (call expr: (atom) @function)

codeadict force-pushed the erlang_syntax_highlighting branch from 8943758 to 3f9366e Compare January 30, 2024 16:29

cla-bot bot added the cla-signed The user has signed the Contributor License Agreement label Jan 30, 2024

codeadict mentioned this pull request Jan 30, 2024

Erlang support #4939

Closed

1 task

codeadict force-pushed the erlang_syntax_highlighting branch from 7c5f3ec to 31587bf Compare January 30, 2024 20:56

codeadict mentioned this pull request Jan 30, 2024

Erlang syntax highlight #7085

Closed

wingyplus reviewed Jan 31, 2024

View reviewed changes

codeadict force-pushed the erlang_syntax_highlighting branch from 31587bf to 21c7f82 Compare January 31, 2024 14:09

codeadict force-pushed the erlang_syntax_highlighting branch 2 times, most recently from 0d2dda2 to 64052a0 Compare January 31, 2024 21:50

SomeoneToIgnore reviewed Feb 1, 2024

View reviewed changes

assets/icons/file_icons/file_types.json Show resolved Hide resolved

crates/zed/Cargo.toml Show resolved Hide resolved

wingyplus reviewed Feb 1, 2024

View reviewed changes

wingyplus mentioned this pull request Feb 1, 2024

Fix #7093 code suggestions codeadict/zed#1

Merged

codeadict and others added 8 commits February 1, 2024 11:05

Add syntax highlighting and LSP (erlang_lsp) for Erlang

6826429

Document tree sitter and lsp used for Erlang

e1749a8

Comment cleanup

5cb5b91

Do not indent inside comments

e433810

Add Erlang Outline

9941b5f

Fix wild_attribute not highlight as a keyword

5f7ec9a

Fixes by moving all primitive types to the top of file. Signed-off-by: Thanabodee Charoenpiriyakij <[email protected]>

Fix dependencies order in crates/zed/Cargo.toml

ba18e8d

Signed-off-by: Thanabodee Charoenpiriyakij <[email protected]>

Bring back gitmodules and re-order again

a3491ec

Signed-off-by: Thanabodee Charoenpiriyakij <[email protected]>

codeadict force-pushed the erlang_syntax_highlighting branch from ce0530b to a3491ec Compare February 1, 2024 16:05

Fix wild module attribute highlighting

a4ea452

codeadict requested review from SomeoneToIgnore and wingyplus February 1, 2024 16:35

codeadict mentioned this pull request Feb 1, 2024

OSX binary releases erlang-ls/erlang_ls#1495

Open

SomeoneToIgnore approved these changes Feb 1, 2024

View reviewed changes

SomeoneToIgnore merged commit 97be0a9 into zed-industries:main Feb 1, 2024
5 checks passed

Yozhig reviewed Jun 17, 2024

View reviewed changes

This comment was marked as off-topic.

Sign in to view

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add syntax highlighting and LSP (erlang_lsp) for Erlang #7093

Add syntax highlighting and LSP (erlang_lsp) for Erlang #7093

codeadict commented Jan 30, 2024 •

edited

Loading

cla-bot bot commented Jan 30, 2024

cla-bot bot commented Jan 30, 2024

wingyplus Jan 31, 2024

codeadict Jan 31, 2024

codeadict commented Jan 31, 2024 •

edited

Loading

SomeoneToIgnore left a comment

SomeoneToIgnore commented Feb 1, 2024 •

edited

Loading

wingyplus commented Feb 1, 2024

SomeoneToIgnore commented Feb 1, 2024

wingyplus Feb 1, 2024

wingyplus Feb 1, 2024

codeadict Feb 1, 2024

codeadict Feb 1, 2024

codeadict commented Feb 1, 2024

wingyplus commented Feb 1, 2024

SomeoneToIgnore left a comment

codeadict commented Feb 1, 2024

robertoaloi commented Feb 3, 2024

eproxus commented Mar 13, 2024 •

edited

Loading

wingyplus commented Mar 26, 2024

eproxus commented Apr 15, 2024 •

edited

Loading

codeadict commented May 8, 2024

eproxus commented May 14, 2024

Yozhig Jun 17, 2024

This comment was marked as off-topic.

Add syntax highlighting and LSP (erlang_lsp) for Erlang #7093

Add syntax highlighting and LSP (erlang_lsp) for Erlang #7093

Conversation

codeadict commented Jan 30, 2024 • edited Loading

cla-bot bot commented Jan 30, 2024

cla-bot bot commented Jan 30, 2024

wingyplus Jan 31, 2024

Choose a reason for hiding this comment

codeadict Jan 31, 2024

Choose a reason for hiding this comment

codeadict commented Jan 31, 2024 • edited Loading

SomeoneToIgnore left a comment

Choose a reason for hiding this comment

SomeoneToIgnore commented Feb 1, 2024 • edited Loading

wingyplus commented Feb 1, 2024

SomeoneToIgnore commented Feb 1, 2024

wingyplus Feb 1, 2024

Choose a reason for hiding this comment

wingyplus Feb 1, 2024

Choose a reason for hiding this comment

codeadict Feb 1, 2024

Choose a reason for hiding this comment

codeadict Feb 1, 2024

Choose a reason for hiding this comment

codeadict commented Feb 1, 2024

wingyplus commented Feb 1, 2024

SomeoneToIgnore left a comment

Choose a reason for hiding this comment

codeadict commented Feb 1, 2024

robertoaloi commented Feb 3, 2024

eproxus commented Mar 13, 2024 • edited Loading

wingyplus commented Mar 26, 2024

eproxus commented Apr 15, 2024 • edited Loading

codeadict commented May 8, 2024

eproxus commented May 14, 2024

Yozhig Jun 17, 2024

Choose a reason for hiding this comment

This comment was marked as off-topic.

codeadict commented Jan 30, 2024 •

edited

Loading

codeadict commented Jan 31, 2024 •

edited

Loading

SomeoneToIgnore commented Feb 1, 2024 •

edited

Loading

eproxus commented Mar 13, 2024 •

edited

Loading

eproxus commented Apr 15, 2024 •

edited

Loading