Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sidorares/node-vim-debugger
node.js step by step debugging from vim
https://github.com/sidorares/node-vim-debugger
Last synced: 1 day ago
JSON representation
node.js step by step debugging from vim
- Host: GitHub
- URL: https://github.com/sidorares/node-vim-debugger
- Owner: sidorares
- Created: 2013-07-13T23:33:21.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2018-01-23T15:02:00.000Z (almost 7 years ago)
- Last Synced: 2025-01-04T12:48:45.349Z (9 days ago)
- Language: JavaScript
- Homepage:
- Size: 43 KB
- Stars: 562
- Watchers: 24
- Forks: 32
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-github-star - node-vim-debugger
- awesome-list - node-vim-debugger
README
[](https://flattr.com/submit/auto?user_id=sidorares&url=https://github.com/sidorares/node-vim-debugger&title=node-vim-debugger&language=&tags=github&category=software)
node-vim-debugger
=================
[](https://gitter.im/sidorares/node-vim-debugger?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
Node.js debugger client and vim driver. Step-by-step debugging from vim.
### install
```sh
npm install -g vimdebug
```
### usage
A debugger, agent and vim session will have to be launched. These can either all be started individually:
1) start your program with debugger enabled
```sh
node --debug-brk yourprogram.js
```
2) start agent
```sh
node-vim-inspector
```
3) connect vim to agent:
```sh
vim -nb
# or if you have vim already running, type `:nbs` in command mode
```
Alternatively, launch `node-vim-inspector` with a path to your script to do step 1&2 at once:
```sh
node-vim-inspector yourprogram.js
```
Or even give it the name of the window manager you're using for it to also launch a new vim session. Currently supported WMs are tmux and i3.
```sh
node-vim-inspector --windowmanager=tmux yourprogram.js
# or:
node --debug-brk yourprogram.js
node-vim-inspector --windowmanager=tmux
```
to run all inside vim using [ConqueShell](https://github.com/lrvick/Conque-Shell) (+coffeescript support) see [here](https://gist.github.com/coderofsalvation/0aabf454888b8e5da213)
### keys
- CTRL+c - continue
- CTRL+i - step in
- CTRL+o - step over
- CTRL+n - step next
- CTRL+u - move one stack frame up
- CTRL+d - move one stack frame down
- CTRL+p - set breakpoint at current location
## configuration
The default configuration is as follows:
```json
{
"vim": {
"keys": {
"break" : "C-p",
"continue" : "C-c",
"down" : "C-d",
"in" : "C-i",
"next" : "C-n",
"out" : "C-o",
"up" : "C-u"
}
},
"agent": {
"port": 3219
},
"debugger": {
"port": 5858
},
"windowmanager": ""
}
```
Any of these settings can be overridden either from the command line, e.g. `--vim.keys.break="C-b"`, a `.vimdebugrc` json file selectively overriding properties or environment variables in the form of `export vimdebug_vim__keys__break="C-a"`.
The `.vimdebugrc` can be placed either in the current working directory, any directory above the current or the current user's home directory. In case there are multiple they will override each other in this order.
## agent
Settings for the vim-debug netbeans agent.
### agent.port
Port the agent uses to establish a connection.
## debugger
Settings for the spawn debugger. Only relevant when the debugger spawn from the `node-vim-inspector` client, e.g. it is called with the path of a NodeJS program to debug.
### debugger.port
Port to spawn the debugger on.
## vim
Settings used by the vim client.
### vim.keys
Key mappings inside vim to manipulate the debugger.
#### vim.keys.break
Add a breakpoint at current line and column.
#### vim.keys.continue
Resume program execution until the next breakpoint is encountered, or the program terminates.
#### vim.keys.down
Move down one stack frame.
#### vim.keys.in
Step inside the current statement's execution.
#### vim.keys.next
Step to the next statement.
#### vim.keys.out
Step out of the current statement.
#### vim.keys.up
Move up one stack frame.
### Links
- [V8 Debugger protocol wire format](https://code.google.com/p/v8/wiki/DebuggerProtocol)
- [debugger documentation (deprecated)](http://nodejs.org/api/debugger.html)
- [node-inspector](https://github.com/node-inspector/node-inspector)
- [webkit-agent](https://github.com/c4milo/node-webkit-agent)
- [node-cli-debugger](https://github.com/sidorares/node-cli-debugger)
- [debugger protocol node client](https://github.com/sidorares/v8-debugger-protocol)
- [node-vim](https://github.com/moll/vim-node) - node-related vim scripts
- ['readline-vim'](https://github.com/thlorenz/readline-vim) - vim keybindings for node readline
- [ndb](https://github.com/smtlaissezfaire/ndb)
- [node-profiler](https://github.com/bnoordhuis/node-profiler)
- [v8.log processor](https://github.com/sidorares/node-tick)