Update README.md
This commit is contained in:
Ben Jackson
parent
ba0c11392d
commit
cde2723da7
1 changed files with 214 additions and 13 deletions
227
README.md
227
README.md
|
|
@ -2,9 +2,21 @@
|
|||
|
||||
# Status
|
||||
|
||||
This is a work in progress. It barely functions.
|
||||
The plugin is a capable, if basic, debugger for c++ and python on the author's
|
||||
computer. I think the concept is well and truly proven and it is worth
|
||||
completing.
|
||||
|
||||
# About
|
||||
If you are insanely curious and wish to try it out, it's probably best to find
|
||||
me in #vim or the YCM gitter channel. It's probably too early.
|
||||
|
||||
In order to use it you have to currently:
|
||||
|
||||
- Write an undocumented configuration file that contains essentially
|
||||
undocumented parameters.
|
||||
- Use an undocumented API via things like `:call vimsepctor#Launch()`.
|
||||
- etc.
|
||||
|
||||
# Background
|
||||
|
||||
The motivation is that debugging in Vim is a pretty horrible experience,
|
||||
particularly if you use multiple languages. With pyclewn no more and the
|
||||
|
|
@ -16,35 +28,224 @@ debuggers from clients.
|
|||
|
||||
The aim of this project is to provide a simple but effective debugging
|
||||
experience in Vim for multiple languages, by leveraging the debug adapters that
|
||||
are being built for VScode.
|
||||
are being built for Visual Studio Code.
|
||||
|
||||
The ability to do remote debugging is a must. This is key to my workflow, so
|
||||
baking it in to the debugging experience is a top bill goal for the project.
|
||||
|
||||
# Features
|
||||
# Demo
|
||||
|
||||
None yet.
|
||||
## C Debugging
|
||||
|
||||
|
||||
|
||||
# Python Debugging
|
||||
|
||||
|
||||
|
||||
# Features and Usage
|
||||
|
||||
## Launch and attach by PID:
|
||||
|
||||
* Create `vimspector.json`. See [below](#supported-languages).
|
||||
* `:call vimsepctor#Launch()` and select a configuration.
|
||||
|
||||
## Breakpoints
|
||||
|
||||
* Use `vimspector#ToggleBreakpoint()` to set/disable/delete a line breakpoint.
|
||||
* Use `vimspector#AddFunctionBreakpoint( '<name>' )` to add a function
|
||||
breakpoint.
|
||||
|
||||
## Stepping
|
||||
|
||||
* Step in/out, finish, continue, pause etc. using the WinBar.
|
||||
* If you really want to, the API is `vimspector#StepInto()` etc.
|
||||
|
||||
## Variables and scopes
|
||||
|
||||
* Current scope shows values of locals.
|
||||
* Use `<CR>` to expand/collapse (+, -).
|
||||
* When changing the stack frame the locals window updates.
|
||||
|
||||
## Watches
|
||||
|
||||
* Add watches to the variables window with
|
||||
`:call vimspector#AddWatch( '<expr>' )`
|
||||
* Expand result with `<CR>`.
|
||||
* Delete with `<DEL>`.
|
||||
|
||||
## Stack Trraces
|
||||
|
||||
* In the threads window, use `<CR>` to expand/collapse.
|
||||
* Use `<CR>` on a stack frame to jump to it.
|
||||
|
||||
## Program Output:
|
||||
|
||||
* In the outputs window use the WinBar to select the output channel.
|
||||
* The debugee prints to the stdout channel.
|
||||
* Other channels may be useful for debugging.
|
||||
|
||||
# Supported Languages
|
||||
|
||||
None yet.
|
||||
Current tested with the following debug adapters.
|
||||
|
||||
# Demo
|
||||
Note, there is no support for installing the extension. Use VSCode to do that by
|
||||
installing it in the UI. The default extension directory is something like
|
||||
`$HOME/.vscode/extensions`.
|
||||
|
||||
Well there is a proof of concept, showing some of the features and the use of
|
||||
different debug adapters and languages (c++ and Python):
|
||||
Note, the launch configurations below are reverse-engineered from the
|
||||
extensions. Typically they are documented in the extension's `package.json`, but
|
||||
not always (or not completely).
|
||||
|
||||
* [vimspector proof of concept](https://cdn.pbrd.co/images/HmhkG6S.gif)
|
||||
* C++: [vscode-cpptools](https://github.com/Microsoft/vscode-cpptools)
|
||||
|
||||
Yes, it's buggy right now, and the UI is all placeholder, but it shows that
|
||||
there is some potential, I think.
|
||||
```
|
||||
{
|
||||
"adapters": {
|
||||
"cppdbg": {
|
||||
"name": "cppdbg",
|
||||
"command": [ "<path to extension>/debugAdapters/OpenDebugAD7" ],
|
||||
"attach": {
|
||||
"pidProperty": "processId",
|
||||
"pidSelect": "ask"
|
||||
}
|
||||
},
|
||||
....
|
||||
},
|
||||
"configurations": {
|
||||
"<name>: Launch": {
|
||||
"adapter": "cppdbg",
|
||||
"configuration": {
|
||||
"name": "<name>",
|
||||
"type": "cppdbg",
|
||||
"request": "launch",
|
||||
"program": "<path to binary>",
|
||||
"args": [ ... ],
|
||||
"cwd": "<working directory>",
|
||||
"environment": [ ... ],
|
||||
"externalConsole": true,
|
||||
"MIMode": "lldb"
|
||||
}
|
||||
},
|
||||
"<name>: Attach": {
|
||||
"adapter": "cppdbg",
|
||||
"configuration": {
|
||||
"name": "<name>: Attach",
|
||||
"type": "cppdbg",
|
||||
"request": "attach",
|
||||
"program": "<path to binary>",
|
||||
"MIMode": "lldb"
|
||||
}
|
||||
}
|
||||
...
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
* C++: [code=debug ](https://github.com/WebFreak001/code-debug)
|
||||
|
||||
```
|
||||
{
|
||||
"adapters": {
|
||||
"lldb-mi": {
|
||||
"name": "lldb-mi",
|
||||
"command": [
|
||||
"node",
|
||||
"<path to extension>/out/src/lldb.js"
|
||||
],
|
||||
"attach": {
|
||||
"pidProperty": "target",
|
||||
"pidSelect": "ask"
|
||||
}
|
||||
}
|
||||
...
|
||||
},
|
||||
"configurations": {
|
||||
"<name>: Launch": {
|
||||
"adapter": "lldb-mi",
|
||||
"configuration": {
|
||||
"request": "attach",
|
||||
"cwd": "<working directory>",
|
||||
"program": "<path to binary>",
|
||||
"args": [ ... ],
|
||||
"environment": [ ... ],
|
||||
"lldbmipath": "<path to a working lldb-mi>"
|
||||
}
|
||||
},
|
||||
"<name>: Attach": {
|
||||
"adapter": "lldb-mi",
|
||||
"configuration": {
|
||||
"request": "attach",
|
||||
"cwd": "<working directory>",
|
||||
"executable": "<path to binary>",
|
||||
"lldbmipath": "<path to a working lldb-mi>"
|
||||
}
|
||||
}
|
||||
...
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
* Python: [vscode-python](https://github.com/Microsoft/vscode-python)
|
||||
|
||||
```
|
||||
{
|
||||
"adapters": {
|
||||
"python": {
|
||||
"name": "python",
|
||||
"command": [
|
||||
"node",
|
||||
"<path to extension>/out/client/debugger/Main.js"
|
||||
]
|
||||
}
|
||||
...
|
||||
},
|
||||
"configurations": {
|
||||
"<name>: Launch": {
|
||||
"adapter": "python",
|
||||
"configuration": {
|
||||
"name": "<name>: Launch",
|
||||
"type": "python",
|
||||
"request": "launch",
|
||||
"cwd": "<working directory>",
|
||||
"stopOnEntry": true,
|
||||
"console": "externalTerminal",
|
||||
"debugOptions": [],
|
||||
"program": "<path to main python file>"
|
||||
}
|
||||
}
|
||||
...
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Also the mock debugger, but that isn't actually useful.
|
||||
|
||||
# Unsupported
|
||||
|
||||
Known not to work:
|
||||
|
||||
* CodeLLDB. This doesn't work because it requires unique logic to launch the
|
||||
server, and it uses TCP/IP rather than standard streams.
|
||||
* Java Debug Server. This doesn't work (yet) because it runs as a jdt.ls plugin.
|
||||
Support for this may be added in conjunction with [ycmd][], but this
|
||||
architecture is incredibly complex and vastly different from any other.
|
||||
* C-sharp. The license appears to require that it is only used with Visual
|
||||
Studio Code.
|
||||
|
||||
# FAQ
|
||||
|
||||
1. Q: Does it work? A: Not yet.
|
||||
1. Q: Does it work? A: Yeah, sort of. It's _incredibly_ buggy and unpolished.
|
||||
2. Q: Does it work with <insert language here>? A: Probably, but it won't
|
||||
necessarily be easy to work out what to put in the `.vimspector.json`. As you
|
||||
can see above, some of the servers aren't really editor agnostic, and require
|
||||
very-specific unique handling.
|
||||
|
||||
# License
|
||||
|
||||
[Apache 2.0](http://www.apache.org/licenses/LICENSE-2.0)
|
||||
|
||||
Copyright © 2018 Ben Jackson
|
||||
|
||||
[ycmd]: https://github.com/Valloric/ycmd
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue