Setting up Zed for Elixir development 💧

$ brew install --cask zed  && zed

That's it; you have Zed installed; now let's configure it for Elixir development!

One of the most important tools, at least for me, is the language server, which helps with auto-complete, lint validations, and formatting. Currently, elixir has three options, elixir-ls, lexical, and next-ls. All three are great, and each one has your strength and weakness, I know that there are plans to have a new one that has the goal to be a join of those three to have a LS to rule them all, looking forward to it 😃.

But until this day doesn't come, I personally prefer ElixirLS, that comes as default on Zed; in my experience, it tends to be more stable when working with large projects, but that's me, you may find that prefers lexical or next-ls, this last one for example allows you to setup credo warnings to be shown in the code, which is pretty cool.

To setup a language server, use the shortcut cmd + shift + P and type and select the option zed: open settings, and add the following code:

"languages": {

  "Elixir": {

    "language_servers": ["elixir-ls"] // <- `next-ls` or `lexical`

  }

}

Then, you can setup the specifics based on what language server you prefer, for ElixirLS, I like to turn off dialyzer when developing and let CIs like CircleCI or Github Actions to run that for me when I push the branch, to do so, you can add lsp config like below:

"lsp": {

  "elixir-ls": {

    "settings": {

      "dialyzerEnabled": false

    }

  }

}

Pretty easy, right? Now, let's set up the second most important tool for me: code formatting. And here is where I think vscode is better, again, maybe is because I used to work on large projects, but the format on save on zed has some latency, which on vscode is inexistent, but maybe I'm doing something wrong, happy to chat with you guys about it on comments. But here is the snippet we need to add to enable auto format on zed:

"languages": {

  "Elixir": {

    "format_on_save": {

      "external": {

        "command": "mix",

        "arguments": ["format", "--stdin-filename", "{buffer_path}", "-"]

      }

    }

  }

}

At this stage, you have the minimum requirement to start developing in elixir on Zed; now let's go into specifics, HEEX:

"languages": {

  "HEEX": {

    "format_on_save": {

      "external": {

        "command": "mix",

        "arguments": ["format", "--stdin-filename", "{buffer_path}", "-"]

      }

    },

    "language_servers": [

      "elixir-ls",

      "tailwindcss-language-server",

      "emmet-language-server"

    ]

  }

}

In the snippet above, we're setting up heex to format using mix format, elixir-ls, for elixir code that may be inside of the heex files, tailwindcss-language-server, to have tailwind classes auto-complete, and emmet-language-server, to have auto-complete for HTML (i.e. div.flex to be converted to <div class="flex"></div>).

One caveat about Emmet, you may need to do a workaround to make it work as expected. First, use cmd + shift + P, and select option zed: extensions, and install Emmet extension. Once you install it, open and edit the file ~/Library/Application\ Support/Zed/extensions/installed/emmet/extension.toml to reference heex extension:

[language_servers.emmet-language-server]

language = "HTML"

languages = ["HTML", "PHP", "ERB", "JavaScript", "TSX", "CSS", "HEEX"]



[language_servers.emmet-language-server.language_ids]

HEEX = "heex"

Well, that's pretty much it; thank you for reading this! I hope this was useful for you. If you like it or have suggestions on how I can improve this post, please leave a comment; I'll be glad to know that this is being helpful 😄.

Here's the gist having my Zed config, where I'm going to keep updating when learning more about it.

Cheers!