Skip to content

Commit a3c903d

Browse files
chore(build): auto-generate vimdoc [skip ci]
1 parent c4e1db5 commit a3c903d

File tree

1 file changed

+42
-5
lines changed

1 file changed

+42
-5
lines changed

doc/elixir-tools.nvim.txt

Lines changed: 42 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Table of Contents *elixir-tools.nvim-table-of-contents*
1212
- Minimal Setup |elixir-tools.nvim-getting-started-minimal-setup|
1313
- Advanced Setup |elixir-tools.nvim-getting-started-advanced-setup|
1414
4. Features |elixir-tools.nvim-features|
15+
- Commands |elixir-tools.nvim-features-commands|
1516
- Next LS |elixir-tools.nvim-features-next-ls|
1617
- Credo Language Server |elixir-tools.nvim-features-credo-language-server|
1718
- ElixirLS |elixir-tools.nvim-features-elixirls|
@@ -179,22 +180,58 @@ some personal configuration.
179180
4. Features *elixir-tools.nvim-features*
180181

181182

183+
COMMANDS *elixir-tools.nvim-features-commands*
184+
185+
186+
*elixir-tools.nvim-:Elixir-]*
187+
188+
189+
:Elixir {command} [{subcommand}] The main elixir-tools command
190+
>vim
191+
:Elixir nextls uninstall
192+
<
193+
FULL LIST ~
194+
195+
196+
197+
---------------------------------------------------------------------------------
198+
Command Subcommand Description
199+
--------- ------------ ----------------------------------------------------------
200+
nextls uninstall Removes the nextls executable from the default location:
201+
~/.cache/elixir-tools/nextls/bin/nextls
202+
203+
---------------------------------------------------------------------------------
204+
182205
NEXT LS *elixir-tools.nvim-features-next-ls*
183206

184207

185208
**Note** Next LS is **disabled** by default. Once it reaches feature parity
186209
with ElixirLS, it will switch to enabled by default.
187210

188-
**Note** Next LS integration utilizes `Mix.install/2`, so you must be running
189-
Elixir >= 1.12
190-
191-
**Note** Next LS creates a `.elixir-tools` directory in your project root.
192-
You’ll want to add that to your gitignore.
211+
**Note** Next LS creates a `.elixir-tools` directory in your project root, but
212+
it’s automatically ignored by git.
193213
The language server for Elixir that just works.
194214

195215
Youcan read more about it at https://www.elixir-tools.dev/next-ls.
196216

197217

218+
AUTOMATIC INSTALLATION ~
219+
220+
Next LS is distributed as pre-compiled binaries, which are available from the
221+
Next LS GitHub releases page. elixir-tools.nvim will prompt you to install it
222+
if it is not found, and then will consequently download it from GitHub.
223+
224+
If you are using a package manager like Mason
225+
<https://github.com/williamboman/mason.nvim>, you can set the `cmd` property of
226+
the `nextls` setup table and it will not prompt you to install and use it from
227+
there.
228+
229+
230+
COMMANDS ~
231+
232+
Next LS command are available as subcommands of the `:Elixir` command
233+
234+
198235
CREDO LANGUAGE SERVER *elixir-tools.nvim-features-credo-language-server*
199236

200237

0 commit comments

Comments
 (0)