You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: DEVELOPMENT.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -26,7 +26,7 @@ It's easiest to test ElixirLS with [VSCode extension](https://github.com/elixir-
26
26
27
27
### Local release
28
28
29
-
You can run a local release of language server and debugger with launch scripts from `scripts` directory with `ELS_LOCAL=1` environment variable. This will make the install script use source, lockfile and config from the local ElixirLS directory.
29
+
You can run a local release of language server and debug adapter with launch scripts from `scripts` directory with `ELS_LOCAL=1` environment variable. This will make the install script use source, lockfile and config from the local ElixirLS directory.
| Kate |[built-in LSP Client plugin](https://kate-editor.org/post/2020/2020-01-01-kate-lsp-client-status/)| Does not support debugger|
40
-
| Neovim |[coc.nvim](https://github.com/neoclide/coc.nvim)| Does not support debugger|
41
-
| Neovim |[nvim-dap](https://github.com/mfussenegger/nvim-dap)| Supports debugger only |
42
-
| Neovim |[nvim-lspconfig](https://github.com/neovim/nvim-lspconfig)| Does not support debugger|
39
+
| Kate |[built-in LSP Client plugin](https://kate-editor.org/post/2020/2020-01-01-kate-lsp-client-status/)| Does not support debug adapter|
40
+
| Neovim |[coc.nvim](https://github.com/neoclide/coc.nvim)| Does not support debug adapter|
41
+
| Neovim |[nvim-dap](https://github.com/mfussenegger/nvim-dap)| Supports debug adapter only |
42
+
| Neovim |[nvim-lspconfig](https://github.com/neovim/nvim-lspconfig)| Does not support debug adapter|
43
43
| Nova |[nova-elixir-ls](https://github.com/raulchedrese/nova-elixir-ls)||
44
-
| Sublime Text |[LSP-elixir](https://github.com/sublimelsp/LSP-elixir)| Does not support debugger|
45
-
| Vim/Neovim |[ALE](https://github.com/w0rp/ale)| Does not support debugger or @spec suggestions |
46
-
| Vim/Neovim |[elixir-lsp/coc-elixir](https://github.com/elixir-lsp/coc-elixir)| Does not support debugger|
47
-
| Vim/Neovim |[vim-lsp](https://github.com/prabirshrestha/vim-lsp)| Does not support debugger|
44
+
| Sublime Text |[LSP-elixir](https://github.com/sublimelsp/LSP-elixir)| Does not support debug adapter|
45
+
| Vim/Neovim |[ALE](https://github.com/w0rp/ale)| Does not support debug adapter or @spec suggestions |
46
+
| Vim/Neovim |[elixir-lsp/coc-elixir](https://github.com/elixir-lsp/coc-elixir)| Does not support debug adapter|
47
+
| Vim/Neovim |[vim-lsp](https://github.com/prabirshrestha/vim-lsp)| Does not support debug adapter|
48
48
| VS Code |[elixir-lsp/vscode-elixir-ls](https://github.com/elixir-lsp/vscode-elixir-ls)| Supports all ElixirLS features |
49
49
50
50
Please feel free to create and publish your own client packages and add them to this list!
@@ -125,7 +125,7 @@ It is generally recommended to install Elixir and Erlang via [ASDF](https://gith
125
125
126
126
## Debugger support
127
127
128
-
ElixirLS provides debugger support adhering to the [Debug Adapter Protocol](https://microsoft.github.io/debug-adapter-protocol/), which is closely related to the Language Server Protocol.
128
+
ElixirLS provides debug adapter support adhering to the [Debug Adapter Protocol](https://microsoft.github.io/debug-adapter-protocol/), which is closely related to the Language Server Protocol.
129
129
130
130
When debugging in Elixir or Erlang, only modules that have been "interpreted" (using `:int.ni/1` or `:int.i/1`) will accept breakpoints or show up in stack traces. The debugger in ElixirLS automatically interprets all modules in the Mix project and its dependencies before launching the Mix task. Therefore, you can set breakpoints anywhere in your project or dependency modules.
131
131
@@ -175,7 +175,7 @@ To debug Phoenix applications using ElixirLS, you can use the following launch c
175
175
}
176
176
```
177
177
178
-
Please make sure that `startApps` is not set to `true`. To clarify, `startApps` is a configuration option in the ElixirLS debugger. It controls whether or not to start the applications in the Mix project before running the task. In the case of Phoenix applications, setting `startApps` to `true` can interfere with the application's normal startup process and cause issues.
178
+
Please make sure that `startApps` is not set to `true`. To clarify, `startApps` is a configuration option in the ElixirLS debug adapter. It controls whether or not to start the applications in the Mix project before running the task. In the case of Phoenix applications, setting `startApps` to `true` can interfere with the application's normal startup process and cause issues.
179
179
180
180
If you are running tests in the Phoenix application, you may need to set `startApps` to true. This will ensure that the necessary applications are started before the tests run.
181
181
@@ -242,9 +242,9 @@ If a breakpoint is set on the line with `some_function()`, the last bound value
242
242
243
243
Additionally, although all bound variables are accessible in the expression evaluator, the evaluator doesn't support accessing module attributes (because these are determined at compile time).
244
244
245
-
### Connecting to debugger
245
+
### Connecting to debug adapter
246
246
247
-
It may be useful to connect to a running debugger node via OTP distribution. This enables inspecting the running application and remotely triggering debugged functions. In order to do so, set `ELS_ELIXIR_OPTS` in the launch configuration and pass in the appropriate node `name/sname` and `cookie`.
247
+
It may be useful to connect to a running debug adapter node via OTP distribution. This enables inspecting the running application and remotely triggering debugged functions. In order to do so, set `ELS_ELIXIR_OPTS` in the launch configuration and pass in the appropriate node `name/sname` and `cookie`.
248
248
249
249
```json
250
250
{
@@ -326,9 +326,9 @@ Below is a list of configuration options supported by the ElixirLS language serv
326
326
<dt>elixirLS.languageServerOverridePath</dt><dd>Absolute path to an alternative ElixirLS release that will override the packaged release</dd>
327
327
</dl>
328
328
329
-
## Debugger configuration options
329
+
## Debug Adapter configuration options
330
330
331
-
Below is a list of configuration options supported by the ElixirLS Debugger. Configuration options can be supplied via the debugger launch configuration. Please refer to your editor's documentation on how to configure debugger adapters.
331
+
Below is a list of configuration options supported by the ElixirLS Debug Adapter. Configuration options can be supplied via launch configuration. Please refer to your editor's documentation on how to configure debug adapters.
332
332
333
333
<dl>
334
334
<dt>startApps</dt><dd>Run `mix app.start` before launching the debugger. Some tasks (such as Phoenix tests) expect apps to already be running before the test files are required. Defaults to `false`.</dd>
@@ -441,7 +441,7 @@ When launching ElixirLS from an IDE that is itself launched from a graphical she
441
441
442
442
To ensure that the correct environment is set up, you can create a setup script at `$XDG_CONFIG_HOME/elixir_ls/setup.sh` (for Unix-based systems) or `%APPDATA%\elixir_ls\setup.bat` (for Windows).
443
443
444
-
In the setup script, the environment variable `ELS_MODE` is available and set to either `debugger` or `language_server` to help you decide what to do.
444
+
In the setup script, the environment variable `ELS_MODE` is available and set to either `debug_adapter` or `language_server` to help you decide what to do.
445
445
446
446
Note: The setup script must not read from `stdin` or write to `stdout`. On Unix, Linux, and macOS
447
447
this might be accomplished by adding `>/dev/null` at the end of any line that produces
0 commit comments