jyapayne/vimspector
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

adding docs

Browse source
This commit is contained in:
dsych 2021-02-02 20:53:31 -05:00 • committed by Ben Jackson
commit 47680565c4
1 changed files with 17 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

22
README.md
View file

@ -50,6 +50,7 @@ For detailed explanatin of the `.vimspector.json` format, see the
* [Run to Cursor](#run-to-cursor) * [Run to Cursor](#run-to-cursor)
* [Stepping](#stepping) * [Stepping](#stepping)
* [Variables and scopes](#variables-and-scopes) * [Variables and scopes](#variables-and-scopes)
* [Variable/selection hover evaluation](#variable-eval)
* [Watches](#watches) * [Watches](#watches)
* [Watch autocompletion](#watch-autocompletion) * [Watch autocompletion](#watch-autocompletion)
* [Stack Traces](#stack-traces) * [Stack Traces](#stack-traces)
@ -102,7 +103,7 @@ language that Visual Studio Code supports (but see caveats).
The [Vimspector website][website] has an overview of the UI, along with basic The [Vimspector website][website] has an overview of the UI, along with basic
instructions for configuration and setup. instructions for configuration and setup.
But for now, here's a (rather old) screenshot of Vimsepctor debugging Vim: But for now, here's a (rather old) screenshot of Vimspector debugging Vim:
![vimspector-vim-screenshot](https://puremourning.github.io/vimspector-web/img/vimspector-overview.png) ![vimspector-vim-screenshot](https://puremourning.github.io/vimspector-web/img/vimspector-overview.png)
@ -249,7 +250,7 @@ neovim doesn't implement some features Vimspector relies on:
the output window's current output. the output window's current output.
* Prompt Buffers - used to send commands in the Console and add Watches. * Prompt Buffers - used to send commands in the Console and add Watches.
(*Note*: prompt buffers are available in neovim nightly) (*Note*: prompt buffers are available in neovim nightly)
* Balloons - used to display the values of variables when debugging. * Tooltips - used to display the values of variables when debugging.
Workarounds are in place as follows: Workarounds are in place as follows:
@ -258,9 +259,9 @@ Workarounds are in place as follows:
[`:VimspectorReset`](#closing-debugger) [`:VimspectorReset`](#closing-debugger)
* Prompt Buffers - There are [`:VimspectorEval`](#console) * Prompt Buffers - There are [`:VimspectorEval`](#console)
and [`:VimspectorWatch`](#watches) and [`:VimspectorWatch`](#watches)
* Functions - There are
There is no workaroud for the lack of balloons; you'll just have to use [`:call vimspector#ShowTooltip()`](#variable-eval) and
`:VimspectorEval` or `:VimspectorWatch`, or switch to Vim. [`:call vimspector#ShowTooltipForSelection()`](#variable-eval)
## Windows differences ## Windows differences
@ -890,6 +891,17 @@ breakpoint when it is hit.
Scopes and variables are represented by the buffer `vimspector.Variables`. Scopes and variables are represented by the buffer `vimspector.Variables`.
## Variable/selection hover evaluation
All rules for `Variables and scopes` apply plus the following:
* With mouse enabled, hover over a variable and get the value it evaluates to.
* Use your mouse to hightlight a expression (e.g. a + b) and the result of the expression.
* Call `vimspector#ShowTooltip()` or `vimspector#ShowTooltipForSelection()` to evaluate expressions without mouse (the only way to use this feature in nvim).
* Use regular nagivation keys to chose the current selection and `<Esc>` (or leave the tooltip window) to close the tooltip.
Note: using a selection evaluation might lead to undesired consequences, since **the expression is actually executed**. E.g. `c = a + b;` once this entire line is evaluated, value of `c` becomes the sum of `a` and `b`.
## Watches ## Watches
The watch window is used to inspect variables and expressions. Expressions are The watch window is used to inspect variables and expressions. Expressions are