|
1 | 1 | # vim-rescript
|
2 | 2 |
|
3 |
| -**This is the official vim plugin for ReScript for vanilla VIM and vim-coc.** |
| 3 | +**This is the official vim plugin for ReScript.** |
4 | 4 |
|
5 | 5 | > If you are experiencing any troubles, open an issue or visit our [Forum](https://forum.rescript-lang.org) and ask for guidance.
|
6 | 6 |
|
7 |
| -See `:h rescript` for the detailed [helpfile](./doc/rescript.txt). |
8 |
| - |
9 |
| -## Requirements |
10 |
| - |
11 |
| -The plugin works with projects based on `bs-platform@8.3` or later |
12 |
| - |
13 | 7 | ## Features
|
14 | 8 |
|
| 9 | +**Supported Workflows:** |
| 10 | +- Plain VIM (without any third party plugins) |
| 11 | +- LSP + [coc-vim](https://github.com/neoclide/coc.nvim) |
| 12 | + |
15 | 13 | **Basics:**
|
16 | 14 | - Syntax highlighting for ReSript files
|
17 | 15 | - Filetype detection for `.res`, `.resi`
|
18 | 16 | - Basic automatic indentation
|
19 | 17 | - Includes LSP for coc-vim usage
|
20 | 18 |
|
21 | 19 | **Provided by vim-rescript commands:**
|
22 |
| -- Formatting `.res` files |
23 |
| -- Type Hinting for current cursor position |
24 |
| -- Build command |
25 |
| -- Display syntax error / build error diagnostics in VIM quickfix |
26 |
| -- Autocompletion w/ Vim's omnicomplete |
| 20 | +- Formatting `.res` files w/ syntax error diagnostics in VIM quickfix |
27 | 21 | - Convert existing `.re` /`.rei` files to `.res` /`.resi`
|
| 22 | +- Type hint for current cursor position |
| 23 | +- Jump to definition for current cursor position |
| 24 | +- Building the current projec w/ build diagnostics in VIM quickfix |
| 25 | +- Autocompletion w/ Vim's omnicomplete |
| 26 | + |
| 27 | +See `:h rescript` for the detailed [helpfile](./doc/rescript.txt). |
| 28 | + |
| 29 | +## Requirements |
| 30 | + |
| 31 | +The plugin works with projects based on `bs-platform@8.3` or later |
28 | 32 |
|
29 | 33 | ## Installation
|
30 | 34 |
|
@@ -115,7 +119,6 @@ set omnifunc=rescript#Complete
|
115 | 119 | set completeopt+=preview
|
116 | 120 | ```
|
117 | 121 |
|
118 |
| - |
119 | 122 | ## Credits
|
120 | 123 |
|
121 | 124 | - [amirales](https://github.com/amiralies): Started the plugin w/ syntax & indent functionality
|
0 commit comments