diff options
Diffstat (limited to 'docs/getting_started')
| -rw-r--r-- | docs/getting_started/setup_your_environment.md | 39 |
1 files changed, 38 insertions, 1 deletions
diff --git a/docs/getting_started/setup_your_environment.md b/docs/getting_started/setup_your_environment.md index aa351e10f..7ef83932c 100644 --- a/docs/getting_started/setup_your_environment.md +++ b/docs/getting_started/setup_your_environment.md @@ -106,7 +106,10 @@ on YouTrack. Vim works fairly well for Deno/TypeScript if you install [CoC](https://github.com/neoclide/coc.nvim) (intellisense engine and language -server protocol). +server protocol) or [ALE](https://github.com/dense-analysis/ale) (syntax checker +and language server protocol client). + +##### CoC After CoC is installed, from inside Vim, run`:CocInstall coc-tsserver` and `:CocInstall coc-deno`. To get autocompletion working for Deno type definitions @@ -114,6 +117,40 @@ run `:CocCommand deno.types`. Optionally restart the CoC server `:CocRestart`. From now on, things like `gd` (go to definition) and `gr` (goto/find references) should work. +##### ALE + +ALE integrates with Deno's LSP out of the box and should not require any extra +configuration. However, if your Deno executable is not located in `$PATH`, has a +different name than `deno` or you want to use unstable features/APIs, you need +to override ALE's default values. See +[`:help ale-typescript`](https://github.com/dense-analysis/ale/blob/master/doc/ale-typescript.txt). + +ALE provides support for autocompletion, refactoring, going to definition, +finding references and more, however, key bindings need to be configured +manually. Copy the snippet below into your `vimrc`/`init.vim` for basic +configuration or consult the +[official documentation](https://github.com/dense-analysis/ale#table-of-contents) +for a more in-depth look at how to configure ALE. + +ALE can fix linter issues by running `deno fmt`. To instruct ALE to use the Deno +formatter the `ale_linter` setting needs to be set either on a per buffer basis +(`let b:ale_linter = ['deno']`) or globally for all TypeScript files +(`let g:ale_fixers={'typescript': ['deno']}`) + +```vim +" Use ALE autocompletion with Vim's 'omnifunc' setting (press <C-x><C-o> in insert mode) +autocmd FileType typescript set omnifunc=ale#completion#OmniFunc + +" Make sure to use map instead of noremap when using a <Plug>(...) expression as the {rhs} +nmap gr <Plug>(ale_rename) +nmap gR <Plug>(ale_find_reference) +nmap gd <Plug>(ale_go_to_definition) +nmap gD <Plug>(ale_go_to_type_definition) + +let g:ale_fixers = {'typescript': ['deno']} +let g:ale_fix_on_save = 1 " run deno fmt when saving a buffer +``` + #### Emacs Emacs works pretty well for a TypeScript project targeted to Deno by using a |