Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/elm-tooling/elm-vim
How to setup Vim tooling for working with Elm
https://github.com/elm-tooling/elm-vim
elm hacktoberfest vim vim-plugins vimrc
Last synced: about 21 hours ago
JSON representation
How to setup Vim tooling for working with Elm
- Host: GitHub
- URL: https://github.com/elm-tooling/elm-vim
- Owner: elm-tooling
- Created: 2019-06-20T14:55:27.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-03-10T23:01:07.000Z (over 3 years ago)
- Last Synced: 2024-04-14T06:52:45.852Z (7 months ago)
- Topics: elm, hacktoberfest, vim, vim-plugins, vimrc
- Language: Vim script
- Homepage:
- Size: 48.8 KB
- Stars: 70
- Watchers: 5
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# elm-vim
Instructions to get started with [Elm](https://elm-lang.org) tooling in [Vim](https://www.vim.org).
- [Setup](#setup)
- [Configuration examples](#configuration-examples)
- [FAQ](#faq)
## Setup
### Language Server
Install [`elm-language-server`](https://github.com/elm-tooling/elm-language-server) and its [dependencies](https://github.com/elm-tooling/elm-language-server#requirements). It provides most features, e.g. diagnostics (`elm make`), linting, jump to definition, formatting ([`elm-format`](https://github.com/avh4/elm-format)) and more. It is a standalone implementation of the language server protocol (LSP). There exist multiple language server client implementations (e.g. CoC or ale).
* **CoC.nvim _(recommended)_:** Install [`CoC`](https://github.com/neoclide/coc.nvim). Look into [elm-language-server README](https://github.com/elm-tooling/elm-language-server#cocnvim) or [`CoC` wiki](https://github.com/neoclide/coc.nvim/wiki/Language-servers#elm) for setup and usage instructions.
* **ale:** Install [`ale`](https://github.com/dense-analysis/ale) and use `elm_ls` linter. See [`elm-language-server` README](https://github.com/elm-tooling/elm-language-server#ale), [`ale` README](https://github.com/dense-analysis/ale#usage) and [`ale` docs](https://github.com/dense-analysis/ale/blob/master/doc/ale-elm.txt) for usage instructions.
* **LanguageClient-neovim:** Install [`LanguageClient-neovim`](https://github.com/autozimu/LanguageClient-neovim) and see [elm-language-server README](https://github.com/elm-tooling/elm-language-server#languageclient).
### Syntax highlighting
If you have Vim> 8.2 patch 929 or neovim, Elm syntax is already [included in Vim](https://github.com/vim/vim/blob/master/runtime/syntax/elm.vim)!
(Alternatively install [`elm-vim-syntax`](https://github.com/andys8/vim-elm-syntax) to add syntax highlighting and indentation.)
### Code formatting
[`elm-format`](https://github.com/avh4/elm-format) is used by `elm-language-server` to format code. An alternative is [`ale`](https://github.com/dense-analysis/ale)'s [`elm-format` fixer](https://github.com/w0rp/ale/blob/8768a309b8ef1c2e819dcb6f4630f73acab59792/doc/ale-elm.txt#L6-L29).
[`vim-sleuth`](https://github.com/tpope/vim-sleuth) will set `shiftwidth` and `expandtab` according to your current file (or other similar files in your project). It is a great addition to `elm-format` and a Elm syntax.
### Snippets
`elm-language-server` provides snippets (e.g. with `CoC`).
An alternative is to install [`Ultisnips`](https://github.com/SirVer/ultisnips) for snippet functionality. Install [`honza/vim-snippets`](https://github.com/honza/vim-snippets) which contains [`elm.snippets`](https://github.com/honza/vim-snippets/blob/master/snippets/elm.snippets)
### Tests
Install [`vim-test`](https://github.com/janko/vim-test) to run tests. It contains [`elmtest.vim`](https://github.com/janko/vim-test/blob/master/autoload/test/elm/elmtest.vim). `:TestFile` will execute `elm-test`.
### Tagbar
Install [`majutsushi/tagbar`](https://github.com/majutsushi/tagbar) and configure content displayed in the tagbar.
```vim
let g:tagbar_type_elm = {
\ 'kinds' : [
\ 'f:function:0:0',
\ 'm:modules:0:0',
\ 'i:imports:1:0',
\ 't:types:1:0',
\ 'a:type aliases:0:0',
\ 'c:type constructors:0:0',
\ 'p:ports:0:0',
\ 's:functions:0:0',
\ ]
\}
```
## Configuration examples
There is an [example configuration](./vim-config-example/README.md) to showcase a small Vim setup for Elm.
### User configurations
It's a good idea to take a look how others are configuring their environments. Here are some examples:
- [`andys8/dotfiles`](https://github.com/andys8/dotfiles)
- [`Augustin82/vim`](https://github.com/Augustin82/vim)
- [`antoine-atmire/vim-elmc`](https://github.com/antoine-atmire/vim-elmc)
- [`pehota/dotfiles`](https://github.com/pehota/dotfiles/blob/master/vimrc)
- [`hulufei/dotfiles`](https://github.com/hulufei/dotfiles)
- [`Miaxos/Home-`](https://github.com/Miaxos/Home-/blob/master/.vimrc)
- [`leojpod/dotfiles`](https://github.com/leojpod/dotfiles)
## FAQ
Frequently asked questions. Feel free to contribute.
### "How do I configure CoC and set up keybindings?"
Start with the official [`CoC example configuration`](https://github.com/neoclide/coc.nvim#example-vim-configuration). Then start to look into our [example configuration](./vim-config-example/README.md) and [user configurations](#user-configurations). It'll take some time and tweaking until you find a configuration that's perfect for you.
### "How can I format files on save with CoC?"
Add `"coc.preferences.formatOnSaveFiletypes": ["elm"]` to `coc-settings.json`.
### "CoC or the language server is not working. How can I debug?"
With CoC you can use `:CocInfo` to see all client/server messages or `:CocOpenLog` to show the log. Set [`elmLS.trace.server`](https://github.com/elm-tooling/elm-language-client-vscode#extension-settings) to `verbose`. Make sure you're using a valid elm project with an `elm.json` file or verify behavior with [`elm-spa-example`](https://github.com/rtfeldman/elm-spa-example/).
### "CoC shows only first lines of error message in floating window"
CoC uses floating windows to display diagnostics (error messages). By default only the first 8 lines are shown.
- Raise maximum number of error lines displayed with [`diagnostic.maxWindowHeight`](https://github.com/neoclide/coc.nvim/blob/2bd1385d9d443948d06d5bce82cadfdac185fcc1/doc/coc.txt#L379)
- [Disable floating window](https://github.com/neoclide/coc.nvim/wiki/F.A.Q#how-could-i-disable-floating-window) and use `diagnostic.messageTarget` `"echo"` instead
- Look into how to [scroll inside the floating window](https://github.com/elm-tooling/elm-vim/issues/3).
### "How can I disable a linter rule?"
Add a `elm-analyse.json` config file like this and add [check names](https://stil4m.github.io/elm-analyse/#/messages).
We're not using elm-analyse anymore, but this should still work for most rules.
```json
{
"checks": {
"UnusedTypeAlias": false
}
}
```
### "What about `ElmCast/elm-vim` and `Zaptic/elm-vim`?"
`ElmCast/elm-vim` is an older vim plugin people used before there existed a language server implementation. We're grateful it existed in the past, but the plugin [seems to be unmaintained](https://github.com/ElmCast/elm-vim/issues/189) and isn't necessary anymore.
[`Zaptic/elm-vim`](https://github.com/Zaptic/elm-vim) is a maintained fork. It can be a simple alternative to the `elm-language-server` with fewer features and easier setup.