aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFlorian Fischer <florian.fischer@muhq.space>2021-07-13 11:36:21 +0200
committerFlorian Fischer <florian.fischer@muhq.space>2021-07-13 11:36:21 +0200
commit8576ccbb3548102c112900cc8430147017b38b91 (patch)
tree1f3673b0f5c20f3314a0da977ed031d5c458165c /README.md
parent18f22bf4e26933e320634ace56896039897aaa56 (diff)
downloadvis-lspc-8576ccbb3548102c112900cc8430147017b38b91.tar.gz
vis-lspc-8576ccbb3548102c112900cc8430147017b38b91.zip
update README
add new bindings, commands and configuration options
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 19 insertions, 1 deletions
diff --git a/README.md b/README.md
index eb548dd..b93e763 100644
--- a/README.md
+++ b/README.md
@@ -12,6 +12,7 @@ vis-lspc currently supports:
* `textDocument/typeDefinition`
* `textDocument/implementation`
* `textDocument/hover`
+* `[textDocument/rename]`
* `[Diagnostics]`
## Whats not working
@@ -54,8 +55,15 @@ vis-lspc is in a early state, but if you are brave there are some default key bi
Normal mode:
<F2> - start a language server for win.syntax
<F3> - open win.file with a running language server
- <C-]> - jump to the definition of the symbol under the main cursor
+ <C-]> | <gd> - jump to the definition of the symbol under the main cursor
+ <gD> - jump to declaration
+ <gd> - jump to definition
+ <gi> - jump to implementation
+ <gr> - show references
+ < D> - jump to type definition
<C-t> - go back in the jump history
+ < e> - show diagnostics of current line
+ <K> - hover over current position
Normal and Insert mode:
<C- > - get completions
@@ -80,6 +88,13 @@ vis-lspc is in a early state, but if you are brave there are some default key bi
lspc-back - navigate back in the goto history
+ # workspace edits
+ lspc-rename <new name> - rename the identifier under the cursor to <new name>
+
+ # development support
+ lspc-hover - hover over the current line
+ lspc-show-diagnostics - show the available diagnostics of the current line
+
### Available configuration fields
The module table returned by `require('plugins/vis-lspc')` can be use to configure
@@ -92,7 +107,10 @@ Available fields are:
* `log_file = 'vis-lspc.log'` - file vis-lspc writes all log messages to
* `autostart = true` - try to start a language server in WIN_OPEN
* `menu_cmd = 'fzf' or 'vis-menu'` - program to prompt for user choices
+* `confirm_cmd = 'vis-menu'` - program to prompt for user confirmation
* `ls_map` - a table mapping vis syntax names to language server configurations
+* `highlight_diagnostics = false` - highlight available diagnostics
+* `diagnostic_style = 'back:#e3514f'` - style used to highlight diagnostics
#### Configure your own Language Server