Skip to content

Commit

Permalink
Neovim support (#31)
Browse files Browse the repository at this point in the history
Summary:
`elp` works well with Neovim. `mason.nvim` is a very popular Neovim plugin for installing LSPs and linters, so I'd assume pretty much anyone using Neovim for programming has it installed. `mason.nvim` has `elp` in its registry so the installation is trivial.

Pull Request resolved: #31

Reviewed By: robertoaloi

Differential Revision: D57716927

Pulled By: alanz

fbshipit-source-id: b166fd4b695714087c3874c2f5b009c509ea6a58
  • Loading branch information
mkuratczyk authored and facebook-github-bot committed May 23, 2024
1 parent f061fb5 commit 0ef4c22
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions website/docs/get-started/editors/neovim.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
sidebar_position: 4
---

# Neovim

![screenshot](/img/neovim.png)

The ELP project can be used as a [language server](https://microsoft.github.io/language-server-protocol/overviews/lsp/overview/) in Neovim.

The easiest way to install the ELP server is to use [mason.nvim](https://github.com/williamboman/mason.nvim), a package manager
focused on language servers, linters and similar tools. If you use Neovim for programming, you likely already have `mason.nvim` installed. It is also included in all the most popular "batteries included" configurations/distributions of Neovim such [kickstart.nvim](https://github.com/nvim-lua/kickstart.nvim), [LazyVim](https://github.com/LazyVim/LazyVim), [NVChad](https://nvchad.com/) and others.

With `mason.nvim` installed, you can install the ELP server by running the following command:
```
:MasonInstall elp
```
from within Neovim.

Alternatively you can run `:Mason` and browse the list of available packages, then press `i` when `elp` is highlighted.

## Updating ELP

You can update all packages managed by `mason.nvim` by running `:Mason` and pressing `U`.

## Troubleshooting

`:LspInfo` shows the current status of the LSP client.

`:LspLog` opens the log file for the LSP client, which can be useful for debugging.


Binary file added website/static/img/neovim.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 0ef4c22

Please sign in to comment.