Skip to content

Commit

Permalink
doc: update output examples in debugger.md
Browse files Browse the repository at this point in the history
PR-URL: #10944
Reviewed-By: Josh Gavant <joshgavant@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
  • Loading branch information
vsemozhetbyt authored and joshgav committed Feb 10, 2017
1 parent 05be623 commit ca8c30a
Showing 1 changed file with 34 additions and 28 deletions.
62 changes: 34 additions & 28 deletions doc/api/debugger.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ will be displayed indicating successful launch of the debugger:

```txt
$ node debug myscript.js
< debugger listening on port 5858
connecting... ok
< Debugger listening on 127.0.0.1:5858
connecting to 127.0.0.1:5858 ... ok
break in /home/indutny/Code/git/indutny/myscript.js:1
1 x = 5;
> 1 global.x = 5;
2 setTimeout(() => {
3 debugger;
debug>
Expand All @@ -28,37 +28,37 @@ enable a breakpoint at that position in the code:

```js
// myscript.js
x = 5;
global.x = 5;
setTimeout(() => {
debugger;
console.log('world');
}, 1000);
console.log('hello');
```

Once the debugger is run, a breakpoint will occur at line 4:
Once the debugger is run, a breakpoint will occur at line 3:

```txt
$ node debug myscript.js
< debugger listening on port 5858
connecting... ok
< Debugger listening on 127.0.0.1:5858
connecting to 127.0.0.1:5858 ... ok
break in /home/indutny/Code/git/indutny/myscript.js:1
1 x = 5;
> 1 global.x = 5;
2 setTimeout(() => {
3 debugger;
debug> cont
< hello
break in /home/indutny/Code/git/indutny/myscript.js:3
1 x = 5;
1 global.x = 5;
2 setTimeout(() => {
3 debugger;
> 3 debugger;
4 console.log('world');
5 }, 1000);
debug> next
break in /home/indutny/Code/git/indutny/myscript.js:4
2 setTimeout(() => {
3 debugger;
4 console.log('world');
> 4 console.log('world');
5 }, 1000);
6 console.log('hello');
debug> repl
Expand All @@ -68,11 +68,11 @@ Press Ctrl + C to leave debug repl
> 2+2
4
debug> next
< world
break in /home/indutny/Code/git/indutny/myscript.js:5
< world
3 debugger;
4 console.log('world');
5 }, 1000);
> 5 }, 1000);
6 console.log('hello');
7
debug> quit
Expand Down Expand Up @@ -121,24 +121,26 @@ is not loaded yet:

```txt
$ node debug test/fixtures/break-in-module/main.js
< debugger listening on port 5858
connecting to port 5858... ok
< Debugger listening on 127.0.0.1:5858
connecting to 127.0.0.1:5858 ... ok
break in test/fixtures/break-in-module/main.js:1
1 var mod = require('./mod.js');
> 1 const mod = require('./mod.js');
2 mod.hello();
3 mod.hello();
debug> setBreakpoint('mod.js', 23)
debug> setBreakpoint('mod.js', 2)
Warning: script 'mod.js' was not loaded yet.
1 var mod = require('./mod.js');
> 1 const mod = require('./mod.js');
2 mod.hello();
3 mod.hello();
4 debugger;
5
6 });
debug> c
break in test/fixtures/break-in-module/mod.js:23
21
22 exports.hello = () => {
23 return 'hello from module';
24 };
25
break in test/fixtures/break-in-module/mod.js:2
1 exports.hello = function() {
> 2 return 'hello from module';
3 };
4
debug>
```

Expand Down Expand Up @@ -169,7 +171,8 @@ breakpoint)

### TCP-based protocol

> Stability: 0 - Deprecated: Use [V8 Inspector Integration][] instead. The debug protocol used by the `--debug` flag was removed from V8.
> Stability: 0 - Deprecated: Use [V8 Inspector Integration][] instead.
The debug protocol used by the `--debug` flag was removed from V8.

An alternative way of enabling and accessing the debugger is to start
Node.js with the `--debug` command-line flag or by signaling an existing
Expand All @@ -188,8 +191,7 @@ localhost:5858
**NOTE: This is an experimental feature.**

V8 Inspector integration allows attaching Chrome DevTools to Node.js
instances for debugging and profiling.
It uses the [Chrome Debugging Protocol][].
instances for debugging and profiling. It uses the [Chrome Debugging Protocol][].

V8 Inspector can be enabled by passing the `--inspect` flag when starting a
Node.js application. It is also possible to supply a custom port with that flag,
Expand All @@ -203,9 +205,13 @@ $ node --inspect index.js
Debugger listening on port 9229.
Warning: This is an experimental feature and could change at any time.
To start debugging, open the following URL in Chrome:
chrome-devtools://devtools/remote/serve_file/@60cd6e859b9f557d2312f5bf532f6aec5f284980/inspector.html?experiments=true&v8only=true&ws=localhost:9229/node
chrome-devtools://devtools/bundled/inspector.html?experiments=true&v8only=true&ws=127.0.0.1:9229/dc9010dd-f8b8-4ac5-a510-c1a114ec7d29
```

(In the example above, the UUID dc9010dd-f8b8-4ac5-a510-c1a114ec7d29
at the end of the URL is generated on the fly, it varies in different
debugging sessions.)

[Chrome Debugging Protocol]: https://chromedevtools.github.io/debugger-protocol-viewer/
[TCP-based protocol]: #debugger_tcp_based_protocol
[V8 Inspector Integration]: #debugger_v8_inspector_integration_for_node_js

0 comments on commit ca8c30a

Please sign in to comment.