Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add instructions for Vim Ex command setup #528

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -244,6 +244,22 @@ The default behavior of `elm-format`-approved plugins is to format Elm files on
```
let g:elm_format_autosave = 1
```


### Vim Ex Command - pluginless alternative
1. Add the following to your `~/.vimrc`:

```vim
command ElmFormat :silent %!elm-format --stdin " defines a custom :ElmFormat ex command
nnoremap ef :ElmFormat<cr> " bind the command to <leader> e f
autocmd FileType elm autocmd BufWritePre <buffer> :ElmFormat " runs :ElmFormat on save
```

or without the named command:

```vim
autocmd FileType elm autocmd BufWritePre <buffer> :silent %!elm-format --stdin " runs elm-format on save
```


### Visual Studio Code installation
Expand Down