Node.js v25.0.0 ドキュメンテーション

ステップ実行#

• cont, c: 実行を継続
• next, n: ステップネクスト (次の行へ)
• step, s: ステップイン (関数の中へ)
• out, o: ステップアウト (関数から出る)
• pause: 実行中のコードを一時停止 (開発者ツールの pause ボタンと同様)

ブレークポイント#

• setBreakpoint(), sb(): 現在の行にブレークポイントを設定
• setBreakpoint(line), sb(line): 指定した行にブレークポイントを設定
• setBreakpoint('fn()'), sb(...): 関数のボディの最初の文にブレークポイントを設定
• setBreakpoint('script.js', 1), sb(...): script.js の1行目にブレークポイントを設定
• setBreakpoint('script.js', 1, 'num < 4'), sb(...): script.js の1行目に条件付きブレークポイントを設定。num < 4 が true と評価されたときのみ中断します
• clearBreakpoint('script.js', 1), cb(...): script.js の1行目のブレークポイントを解除

まだ読み込まれていないファイル (モジュール) にブレークポイントを設定することも可能です。

$ node inspect main.js
< Debugger listening on ws://127.0.0.1:9229/48a5b28a-550c-471b-b5e1-d13dd7165df9
< For help, see: https://node.dokyumento.jp/en/docs/inspector
<
connecting to 127.0.0.1:9229 ... ok
< Debugger attached.
<
Break on start in main.js:1
> 1 const mod = require('./mod.js');
  2 mod.hello();
  3 mod.hello();
debug> setBreakpoint('mod.js', 22)
Warning: script 'mod.js' was not loaded yet.
debug> c
break in mod.js:22
 20 // USE OR OTHER DEALINGS IN THE SOFTWARE.
 21
>22 exports.hello = function() {
 23   return 'hello from module';
 24 };
debug> copy

指定した式が true と評価されたときのみ中断する条件付きブレークポイントを設定することも可能です。

$ node inspect main.js
< Debugger listening on ws://127.0.0.1:9229/ce24daa8-3816-44d4-b8ab-8273c8a66d35
< For help, see: https://node.dokyumento.jp/en/docs/inspector
<
connecting to 127.0.0.1:9229 ... ok
< Debugger attached.
Break on start in main.js:7
  5 }
  6
> 7 addOne(10);
  8 addOne(-1);
  9
debug> setBreakpoint('main.js', 4, 'num < 0')
  1 'use strict';
  2
  3 function addOne(num) {
> 4   return num + 1;
  5 }
  6
  7 addOne(10);
  8 addOne(-1);
  9
debug> cont
break in main.js:4
  2
  3 function addOne(num) {
> 4   return num + 1;
  5 }
  6
debug> exec('num')
-1
debug> copy

情報#

• backtrace, bt: 現在の実行フレームのバックトレースを表示
• list(5): スクリプトのソースコードを5行のコンテキスト (前後5行) と共に一覧表示
• watch(expr): 監視リストに式を追加
• unwatch(expr): 監視リストから式を削除
• unwatch(index): 監視リストから指定したインデックスの式を削除
• watchers: すべてのウォッチャーとその値を一覧表示 (各ブレークポイントで自動的に表示される)
• repl: デバッグ中のスクリプトのコンテキストで評価を行うためのデバッガーの REPL を開く
• exec expr, p expr: デバッグ中のスクリプトのコンテキストで式を実行し、その値を表示
• profile: CPU プロファイリングセッションを開始
• profileEnd: 現在の CPU プロファイリングセッションを停止
• profiles: 完了したすべての CPU プロファイリングセッションを一覧表示
• profiles[n].save(filepath = 'node.cpuprofile'): CPU プロファイリングセッションを JSON としてディスクに保存
• takeHeapSnapshot(filepath = 'node.heapsnapshot'): ヒープスナップショットを取得し、JSON としてディスクに保存

実行制御#

• run: スクリプトを実行 (デバッガー開始時に自動的に実行される)
• restart: スクリプトを再起動
• kill: スクリプトを強制終了

その他#

• scripts: 読み込まれたすべてのスクリプトを一覧表示
• version: V8 のバージョンを表示

Node.js の V8 Inspector 統合#

V8 Inspector 統合により、デバッグとプロファイリングのために Chrome DevTools を Node.js インスタンスに接続できます。これは Chrome DevTools Protocol を使用します。

V8 Inspector は、Node.js アプリケーションを起動する際に --inspect フラグを渡すことで有効にできます。このフラグでカスタムポートを指定することも可能で、例えば --inspect=9222 はポート 9222 で DevTools 接続を受け付けます。

--inspect フラグを使用すると、デバッガーが接続される前にコードが即座に実行されます。これは、デバッグを開始する前にコードが実行され始めることを意味し、最初からデバッグしたい場合には理想的ではないかもしれません。

このような場合、2つの代替手段があります。

1. --inspect-wait フラグ: このフラグは、コードを実行する前にデバッガーが接続されるのを待ちます。これにより、実行の最初からデバッグを開始できます。
2. --inspect-brk フラグ: --inspect とは異なり、このフラグはデバッガーが接続されるとすぐにコードの最初の行で中断します。これは、デバッグ前にコードが実行されることなく、最初からコードをステップバイステップでデバッグしたい場合に便利です。

したがって、--inspect、--inspect-wait、--inspect-brk のどれを選ぶかは、コードを即座に実行開始したいか、実行前にデバッガーの接続を待ちたいか、あるいはステップバイステップのデバッグのために最初の行で中断したいかに応じて検討してください。

$ node --inspect index.js
Debugger listening on ws://127.0.0.1:9229/dc9010dd-f8b8-4ac5-a510-c1a114ec7d29
For help, see: https://node.dokyumento.jp/en/docs/inspector copy

(上記の例では、URL の末尾にある UUID dc9010dd-f8b8-4ac5-a510-c1a114ec7d29 はその場で生成され、デバッグセッションごとに異なります。)

Chrome ブラウザが 66.0.3345.0 より古い場合は、上記の URL で js_app.html の代わりに inspector.html を使用してください。

Chrome DevTools は、まだワーカースレッドのデバッグをサポートしていません。ndb を使うとそれらをデバッグできます。