{"id":13476098,"url":"https://github.com/sidorares/node-vim-debugger","last_synced_at":"2025-04-04T23:10:08.198Z","repository":{"id":9502295,"uuid":"11395719","full_name":"sidorares/node-vim-debugger","owner":"sidorares","description":"node.js step by step debugging from vim","archived":false,"fork":false,"pushed_at":"2018-01-23T15:02:00.000Z","size":44,"stargazers_count":560,"open_issues_count":17,"forks_count":31,"subscribers_count":23,"default_branch":"master","last_synced_at":"2025-03-28T22:14:37.629Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sidorares.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-07-13T23:33:21.000Z","updated_at":"2025-03-10T13:39:42.000Z","dependencies_parsed_at":"2022-08-25T21:41:28.371Z","dependency_job_id":null,"html_url":"https://github.com/sidorares/node-vim-debugger","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sidorares%2Fnode-vim-debugger","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sidorares%2Fnode-vim-debugger/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sidorares%2Fnode-vim-debugger/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sidorares%2Fnode-vim-debugger/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sidorares","download_url":"https://codeload.github.com/sidorares/node-vim-debugger/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247261612,"owners_count":20910108,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-07-31T16:01:26.574Z","updated_at":"2025-04-04T23:10:08.177Z","avatar_url":"https://github.com/sidorares.png","language":"JavaScript","funding_links":[],"categories":["JavaScript","Tutoriais"],"sub_categories":[],"readme":"[![Flattr this git repo](http://api.flattr.com/button/flattr-badge-large.png)](https://flattr.com/submit/auto?user_id=sidorares\u0026url=https://github.com/sidorares/node-vim-debugger\u0026title=node-vim-debugger\u0026language=\u0026tags=github\u0026category=software)\n\nnode-vim-debugger\n=================\n[![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/sidorares/node-vim-debugger?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge\u0026utm_content=badge)\n\nNode.js debugger client and vim driver. Step-by-step debugging from vim.\n\n![vimdebug](https://cloud.githubusercontent.com/assets/173025/3963425/7c2322b0-277b-11e4-8bd0-506fe8f9ba8a.gif)\n\n### install\n\n```sh\nnpm install -g vimdebug\n```\n\n### usage\n\nA debugger, agent and vim session will have to be launched. These can either all be started individually:\n\n1) start your program with debugger enabled\n\n```sh\nnode --debug-brk yourprogram.js\n```\n\n2) start agent\n\n```sh\nnode-vim-inspector\n```\n\n3) connect vim to agent:\n\n```sh\nvim -nb\n# or if you have vim already running, type `:nbs` in command mode\n```\n\nAlternatively, launch `node-vim-inspector` with a path to your script to do step 1\u00262 at once:\n\n```sh\nnode-vim-inspector yourprogram.js\n```\n\nOr 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.\n\n```sh\nnode-vim-inspector --windowmanager=tmux yourprogram.js\n# or:\nnode --debug-brk yourprogram.js\nnode-vim-inspector --windowmanager=tmux\n```\n\nto run all inside vim using [ConqueShell](https://github.com/lrvick/Conque-Shell) (+coffeescript support) see [here](https://gist.github.com/coderofsalvation/0aabf454888b8e5da213)\n\n### keys\n\n  - \u003ckbd\u003eCTRL\u003c/kbd\u003e+\u003ckbd\u003ec\u003c/kbd\u003e - continue\n  - \u003ckbd\u003eCTRL\u003c/kbd\u003e+\u003ckbd\u003ei\u003c/kbd\u003e - step in\n  - \u003ckbd\u003eCTRL\u003c/kbd\u003e+\u003ckbd\u003eo\u003c/kbd\u003e - step over\n  - \u003ckbd\u003eCTRL\u003c/kbd\u003e+\u003ckbd\u003en\u003c/kbd\u003e - step next\n  - \u003ckbd\u003eCTRL\u003c/kbd\u003e+\u003ckbd\u003eu\u003c/kbd\u003e - move one stack frame up\n  - \u003ckbd\u003eCTRL\u003c/kbd\u003e+\u003ckbd\u003ed\u003c/kbd\u003e - move one stack frame down\n  - \u003ckbd\u003eCTRL\u003c/kbd\u003e+\u003ckbd\u003ep\u003c/kbd\u003e - set breakpoint at current location\n\n## configuration\n\nThe default configuration is as follows:\n\n```json\n{\n  \"vim\": {\n    \"keys\": {\n      \"break\"    : \"C-p\",\n      \"continue\" : \"C-c\",\n      \"down\"     : \"C-d\",\n      \"in\"       : \"C-i\",\n      \"next\"     : \"C-n\",\n      \"out\"      : \"C-o\",\n      \"up\"       : \"C-u\"\n    }\n  },\n  \"agent\": {\n    \"port\": 3219\n  },\n  \"debugger\": {\n    \"port\": 5858\n  },\n  \"windowmanager\": \"\"\n}\n```\n\nAny 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\"`.\n\nThe `.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.\n\n## agent\n\nSettings for the vim-debug netbeans agent.\n\n### agent.port\n\nPort the agent uses to establish a connection.\n\n## debugger\n\nSettings 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.\n\n### debugger.port\n\nPort to spawn the debugger on.\n\n## vim\n\nSettings used by the vim client.\n\n### vim.keys\n\nKey mappings inside vim to manipulate the debugger.\n\n#### vim.keys.break\n\nAdd a breakpoint at current line and column.\n\n#### vim.keys.continue\n\nResume program execution until the next breakpoint is encountered, or the program terminates.\n\n#### vim.keys.down\n\nMove down one stack frame.\n\n#### vim.keys.in\n\nStep inside the current statement's execution.\n\n#### vim.keys.next\n\nStep to the next statement.\n\n#### vim.keys.out\n\nStep out of the current statement.\n\n#### vim.keys.up\n\nMove up one stack frame.\n\n### Links\n\n  - [V8 Debugger protocol wire format](https://code.google.com/p/v8/wiki/DebuggerProtocol)\n  - [debugger documentation (deprecated)](http://nodejs.org/api/debugger.html)\n  - [node-inspector](https://github.com/node-inspector/node-inspector)\n  - [webkit-agent](https://github.com/c4milo/node-webkit-agent)\n  - [node-cli-debugger](https://github.com/sidorares/node-cli-debugger)\n  - [debugger protocol node client](https://github.com/sidorares/v8-debugger-protocol)\n  - [node-vim](https://github.com/moll/vim-node) - node-related vim scripts\n  - ['readline-vim'](https://github.com/thlorenz/readline-vim) - vim keybindings for node readline\n  - [ndb](https://github.com/smtlaissezfaire/ndb)\n  - [node-profiler](https://github.com/bnoordhuis/node-profiler)\n  - [v8.log processor](https://github.com/sidorares/node-tick)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsidorares%2Fnode-vim-debugger","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsidorares%2Fnode-vim-debugger","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsidorares%2Fnode-vim-debugger/lists"}