Skip to content

Commit ecb4669

Browse files
authored
Merge pull request #885 from VimspectorUpdateBot/auto/update-vim-docs
[Auto] Update vim docs
2 parents 3c994f5 + 1796247 commit ecb4669

File tree

1 file changed

+28
-67
lines changed

1 file changed

+28
-67
lines changed

doc/vimspector.txt

Lines changed: 28 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -316,8 +316,6 @@ runtime dependencies). They are categorised by their level of support:
316316
--------------------------------------------------------------------------------------------------------------------------------------------------------------
317317
| Node.js | Supported | '--force-enable-node' | vscode-js-debug | Node >= 18 |
318318
--------------------------------------------------------------------------------------------------------------------------------------------------------------
319-
| Node.js (legacy) | Supported | '--force-enable-node_legacy' | vscode-node-debug2 | 6 < Node < 12, Npm |
320-
--------------------------------------------------------------------------------------------------------------------------------------------------------------
321319
| Javascript | Supported | '--force-enable-chrome' | debugger-for-chrome | Chrome |
322320
--------------------------------------------------------------------------------------------------------------------------------------------------------------
323321
| Javascript | Supported | '--force-enable-firefox' | vscode-firefox-debug | Firefox |
@@ -2509,42 +2507,6 @@ multiple debug sessions. For a user, that shouldn't change anything (other than
25092507
perhaps a slightly confusing stack trace). But it does make things more
25102508
complicated and so there may be subtle bugs.
25112509

2512-
- Node.js (legacy)
2513-
2514-
**NOTE**: This configuration uses the _deprecated_ legacy debug adapter and
2515-
will be removed in future. Please update your configurations to use the
2516-
'js-debug' adapter. You _may_ be able to just change the adapter name.
2517-
2518-
Requires:
2519-
2520-
- 'install_gadget.py --force-enable-node'
2521-
2522-
- For installation, a Node.js environment that is < node 12. I believe this
2523-
is an incompatibility with gulp. Advice, use nvm [57] with 'nvm install
2524-
--lts 10; nvm use --lts 10; ./install_gadget.py --force-enable-node ...'
2525-
2526-
- Options described here:
2527-
https://code.visualstudio.com/docs/nodejs/nodejs-debugging
2528-
2529-
- Example: 'support/test/node/simple'
2530-
>
2531-
{
2532-
"configurations": {
2533-
"run": {
2534-
"adapter": "vscode-node",
2535-
"filetypes": [ "javascript", "typescript" ], // optional
2536-
"configuration": {
2537-
"request": "launch",
2538-
"protocol": "auto",
2539-
"stopOnEntry": true,
2540-
"console": "integratedTerminal",
2541-
"program": "${workspaceRoot}/simple.js",
2542-
"cwd": "${workspaceRoot}"
2543-
}
2544-
}
2545-
}
2546-
}
2547-
<
25482510
- Chrome/Firefox
25492511

25502512
This uses the chrome/firefox debugger (they are very similar), see https://mark
@@ -2588,20 +2550,20 @@ It allows you to debug scripts running inside chrome from within Vim.
25882550
*vimspector-java*
25892551
Java ~
25902552

2591-
Vimspector works well with the java debug server [58], which runs as a jdt.ls
2553+
Vimspector works well with the java debug server [57], which runs as a jdt.ls
25922554
(Java Language Server) plugin, rather than a standalone debug adapter.
25932555

25942556
Vimspector is not in the business of running language servers, only debug
25952557
adapters, so this means that you need a compatible Language Server Protocol
2596-
editor plugin to use Java. I recommend YouCompleteMe [59], which has full
2558+
editor plugin to use Java. I recommend YouCompleteMe [58], which has full
25972559
support for jdt.ls, and most importantly a trivial way to load the debug
25982560
adapter and to use it with Vimspector.
25992561

26002562
-------------------------------------------------------------------------------
26012563
*vimspector-hot-code-replace*
26022564
Hot code replace ~
26032565

2604-
When using the java debug server [58], Vimspector supports the hot code replace
2566+
When using the java debug server [57], Vimspector supports the hot code replace
26052567
custom feature. By default, when the underlying class files change, vimspector
26062568
asks the user if they wish to reload these classes at runtime.
26072569

@@ -2620,7 +2582,7 @@ This behaviour can be customised:
26202582
*vimspector-usage-with-youcompleteme*
26212583
Usage with YouCompleteMe ~
26222584

2623-
- Set up YCM for java [59].
2585+
- Set up YCM for java [58].
26242586

26252587
- Get Vimspector to download the java debug plugin: 'install_gadget.py
26262588
--force-enable-java <other options...>' or ':VimspectorInstall
@@ -2685,24 +2647,24 @@ If you see "Unable to get DAP port - is JDT.LS initialized?", try running
26852647
':YcmCompleter ExecuteCommand vscode.java.startDebugSession' and note the
26862648
output. If you see an error like 'ResponseFailedException: Request failed:
26872649
-32601: No delegateCommandHandler for vscode.java.startDebugSession', make sure
2688-
that: _Your YCM jdt.ls is actually working, see the YCM docs [60] for
2650+
that: _Your YCM jdt.ls is actually working, see the YCM docs [59] for
26892651
troubleshooting_ The YCM jdt.ls has had time to initialize before you start the
26902652
debugger * That 'g:ycm_java_jdtls_extension_path' is set in '.vimrc' or prior
26912653
to YCM starting
26922654

2693-
For the launch arguments, see the vscode document [61].
2655+
For the launch arguments, see the vscode document [60].
26942656

26952657
-------------------------------------------------------------------------------
26962658
*vimspector-other-lsp-clients*
26972659
Other LSP clients ~
26982660

2699-
See this issue [62] for more background.
2661+
See this issue [61] for more background.
27002662

27012663
-------------------------------------------------------------------------------
27022664
*vimspector-lua*
27032665
Lua ~
27042666

2705-
Lua is supported through local-lua-debugger-vscode [63]. This debugger uses
2667+
Lua is supported through local-lua-debugger-vscode [62]. This debugger uses
27062668
stdio to communicate with the running process, so calls to 'io.read' will cause
27072669
problems.
27082670

@@ -2760,7 +2722,7 @@ problems.
27602722
Other servers ~
27612723

27622724
- Java - vscode-javac. This works, but is not as functional as Java Debug
2763-
Server. Take a look at this comment [64] for instructions.
2725+
Server. Take a look at this comment [63] for instructions.
27642726

27652727
- See also the wiki [15] which has community-contributed plugin files for
27662728
some languages.
@@ -3017,7 +2979,7 @@ Pre-launch building strategies ~
30172979
In many cases you will want to rebuild your project before starting a new
30182980
debugging session. Vimspector is not a task manager and implementing this
30192981
functionality is out of the scope of this project. However, there are some
3020-
strategies described in the community wiki [65] to achieve similar
2982+
strategies described in the community wiki [64] to achieve similar
30212983
functionality.
30222984

30232985
-------------------------------------------------------------------------------
@@ -3173,7 +3135,7 @@ FAQ ~
31733135
additional language support
31743136

31753137
2. How do I stop it starting a new Terminal.app on macOS? See this comment
3176-
[66]
3138+
[65]
31773139

31783140
3. Can I specify answers to the annoying questions about exception
31793141
breakpoints in my '.vimspector.json' ? Yes, see here [26].
@@ -3210,26 +3172,26 @@ FAQ ~
32103172

32113173
4. Do I _have_ to put a '.vimspector.json' in the root of every project? No,
32123174
you can use 'g:vimspector_adapters' and 'g:vimspector_configurations' or
3213-
put all of your adapter and debug configs in a single directory [67] if
3175+
put all of your adapter and debug configs in a single directory [66] if
32143176
you want to, but note the caveat that '${workspaceRoot}' won't be
32153177
calculated correctly in that case. The vimsepctor author uses this a lot
3216-
[68]
3178+
[67]
32173179

32183180
5. I'm confused about remote debugging configuration, can you explain it?
32193181
eh... kind of. Reference: https://puremourning.github.io/vimspector/confi
32203182
guration.html#remote-debugging-support. Some explanations here too: https
32213183
://github.com/puremourning/vimspector/issues/478#issuecomment-943515093
32223184

32233185
6. I'm trying to debug a Django (django?) project and it's not working. Can
3224-
you help? sure, check this link which has a working example [69]. Or
3186+
you help? sure, check this link which has a working example [68]. Or
32253187
google it.
32263188

32273189
7. Can vimspector build my code before debugging it? Can I deploy it to a
32283190
remote host before debugging it? No, not really. Vimspector is just a
32293191
debugger, not a task system or build automation system - there are other
32303192
tools for that. There is however a hack you can use - you can use a
32313193
'shell' variable to execute a command and just discard the output. Other
3232-
options are discussed in this issue [70]
3194+
options are discussed in this issue [69]
32333195

32343196
8. It's annoying to manually type in the PID when attaching. Do you have a
32353197
PID picker? There's no PID picker in vimspector at the moment, but you
@@ -3350,19 +3312,18 @@ References ~
33503312
[54] https://github.com/microsoft/vscode-js-debug
33513313
[55] https://github.com/microsoft/vscode-js-debug/blob/main/OPTIONS.md
33523314
[56] https://github.com/microsoft/vscode-js-debug/blob/main/src/common/contributionUtils.ts#L61
3353-
[57] https://github.com/nvm-sh/nvm
3354-
[58] https://github.com/Microsoft/java-debug
3355-
[59] https://github.com/ycm-core/YouCompleteMe#java-semantic-completion
3356-
[60] https://github.com/ycm-core/YouCompleteMe#troubleshooting
3357-
[61] https://code.visualstudio.com/docs/java/java-debugging
3358-
[62] https://github.com/puremourning/vimspector/issues/3
3359-
[63] https://github.com/tomblind/local-lua-debugger-vscode
3360-
[64] https://github.com/puremourning/vimspector/issues/3#issuecomment-576916076
3361-
[65] https://github.com/puremourning/vimspector/wiki/Pre-launch-building-strategies
3362-
[66] https://github.com/puremourning/vimspector/issues/90#issuecomment-577857322
3363-
[67] https://puremourning.github.io/vimspector/configuration.html#debug-configurations
3364-
[68] https://github.com/puremourning/.vim-mac/tree/master/vimspector-conf
3365-
[69] https://www.reddit.com/r/neovim/comments/mz4ari/how_to_set_up_vimspector_for_django_debugging/
3366-
[70] https://github.com/puremourning/vimspector/issues/227
3315+
[57] https://github.com/Microsoft/java-debug
3316+
[58] https://github.com/ycm-core/YouCompleteMe#java-semantic-completion
3317+
[59] https://github.com/ycm-core/YouCompleteMe#troubleshooting
3318+
[60] https://code.visualstudio.com/docs/java/java-debugging
3319+
[61] https://github.com/puremourning/vimspector/issues/3
3320+
[62] https://github.com/tomblind/local-lua-debugger-vscode
3321+
[63] https://github.com/puremourning/vimspector/issues/3#issuecomment-576916076
3322+
[64] https://github.com/puremourning/vimspector/wiki/Pre-launch-building-strategies
3323+
[65] https://github.com/puremourning/vimspector/issues/90#issuecomment-577857322
3324+
[66] https://puremourning.github.io/vimspector/configuration.html#debug-configurations
3325+
[67] https://github.com/puremourning/.vim-mac/tree/master/vimspector-conf
3326+
[68] https://www.reddit.com/r/neovim/comments/mz4ari/how_to_set_up_vimspector_for_django_debugging/
3327+
[69] https://github.com/puremourning/vimspector/issues/227
33673328

33683329
vim: ft=help

0 commit comments

Comments
 (0)