From caf6e8f7afbb4a295a77aac814c9782ac0658630 Mon Sep 17 00:00:00 2001 From: Lukasz Samson Date: Sun, 22 Oct 2023 23:10:21 +0200 Subject: [PATCH] update readme --- README.md | 4 ++++ guides/incomplete-installation.md | 31 +++++++++++++++++++++---------- 2 files changed, 25 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index ba3ae1a85..ded08d542 100644 --- a/README.md +++ b/README.md @@ -469,6 +469,10 @@ ElixirLS supports the following environment variables. +## Telemetry + +ElixirLS language server sends telemetry information to the client via [LSP Telemetry notification](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.18/specification/#telemetry_event), [DAP Output event](https://microsoft.github.io/debug-adapter-protocol/specification#Events_Output) and [DAP ErrorResponse](https://microsoft.github.io/debug-adapter-protocol/specification#Base_Protocol_ErrorResponse). Telemetry data include usage, performance, environment info and error reports. Please refer to your client and/or extension documentation on telemetry. + ## Acknowledgements and related projects ElixirLS isn't the first frontend-independent server for Elixir language support. The original was [Alchemist Server](https://github.com/tonini/alchemist-server/), which powers the [Alchemist](https://github.com/tonini/alchemist.el) plugin for Emacs. Another project, [Elixir Sense](https://github.com/elixir-lsp/elixir_sense), builds upon Alchemist and powers the [Elixir plugin for Atom](https://github.com/msaraiva/atom-elixir) as well as another VS Code plugin, [VSCode Elixir](https://github.com/fr1zle/vscode-elixir). ElixirLS uses Elixir Sense for several code insight features. Credit for those projects goes to their respective authors. diff --git a/guides/incomplete-installation.md b/guides/incomplete-installation.md index 708fd2e3f..82d4b0f16 100644 --- a/guides/incomplete-installation.md +++ b/guides/incomplete-installation.md @@ -1,23 +1,34 @@ +# Incomplete OTP installations + Incomplete installations is a frequent cause of ElixirLS failures. Generally this is resolved by: -* Installing elixir and erlang with ASDF https://github.com/asdf-vm/asdf + +* Installing elixir and erlang via [ASDF](https://github.com/asdf-vm/asdf) or [RTX](https://github.com/jdx/rtx) (recommended) -* Installing a full version of Erlang via the package manager +* Installing a full version of Erlang/OTP via the package manager ## dialyzer missing -On Ubuntu this is caused by the required `erlang-dialyzer` package not being -installed. For Ubuntu this can be fixed by running `sudo apt-get install erlang -erlang-dialyzer` or installing Elixir and Erlang via ASDF -https://github.com/asdf-vm/asdf +On *Ubuntu* this is caused by the required `erlang-dialyzer` package not being +installed. For Ubuntu this can be fixed by running + +```bash +sudo apt-get install erlang erlang-dialyzer +``` + +or installing Elixir and Erlang via [ASDF](https://github.com/asdf-vm/asdf) or [RTX](https://github.com/jdx/rtx) Relevant issue: https://github.com/elixir-lsp/vscode-elixir-ls/issues/134 ## edoc missing -On fedora this is caused by the required `erlang-edoc `package not being -installed. For fedora this can be fixed by running `sudo dnf install erlang -erlang-edoc` or installing Elixir and Erlang via ASDF -https://github.com/asdf-vm/asdf +On *Fedora* this is caused by the required `erlang-edoc` package not being +installed. For fedora this can be fixed by running + +```bash +sudo dnf install erlang erlang-edoc +``` + +or installing Elixir and Erlang via [ASDF](https://github.com/asdf-vm/asdf) or [RTX](https://github.com/jdx/rtx) Relevant issue: https://github.com/elixir-lsp/elixir-ls/issues/431