デバッガー

[Stable: 2 - 安定]

Node.js にはコマンドラインデバッグユーティリティが含まれています。Node.js デバッガークライアントは、フル機能のデバッガーではありませんが、簡単なステップ実行と検査が可能です。

それを使用するには、デバッグするスクリプトへのパスを続けてinspect引数を付けて Node.js を起動します。

bash

$ node inspect myscript.js
< デバッガーがws://127.0.0.1:9229/621111f9-ffcb-4e82-b718-48a145fa5db8でリッスンしています
< ヘルプについては、https://nodejs.org/en/docs/inspector を参照してください
<
127.0.0.1:9229に接続しています... 成功
< デバッガーがアタッチされました。
<
 成功
myscript.js:2で開始時にブレーク
  1 // myscript.js
> 2 global.x = 5;
  3 setTimeout(() => {
  4   debugger;
debug>

デバッガーは自動的に最初の実行可能な行でブレークします。代わりに最初のブレークポイント（debuggerステートメントで指定）まで実行するには、NODE_INSPECT_RESUME_ON_START環境変数を1に設定します。

bash

$ cat myscript.js
// myscript.js
global.x = 5;
setTimeout(() => {
  debugger;
  console.log('world');
}, 1000);
console.log('hello');
$ NODE_INSPECT_RESUME_ON_START=1 node inspect myscript.js
< デバッガーがws://127.0.0.1:9229/f1ed133e-7876-495b-83ae-c32c6fc319c2でリッスンしています
< ヘルプについては、https://nodejs.org/en/docs/inspector を参照してください
<
127.0.0.1:9229に接続しています... 成功
< デバッガーがアタッチされました。
<
< hello
<
myscript.js:4でブレーク
  2 global.x = 5;
  3 setTimeout(() => {
> 4   debugger;
  5   console.log('world');
  6 }, 1000);
debug> next
myscript.js:5でブレーク
  3 setTimeout(() => {
  4   debugger;
> 5   console.log('world');
  6 }, 1000);
  7 console.log('hello');
debug> repl
デバッグreplを終了するにはCtrl+Cを押してください
> x
5
> 2 + 2
4
debug> next
< world
<
myscript.js:6でブレーク
  4   debugger;
  5   console.log('world');
> 6 }, 1000);
  7 console.log('hello');
  8
debug> .exit
$

replコマンドを使用すると、コードをリモートで評価できます。nextコマンドは次の行にステップします。利用可能な他のコマンドを確認するには、helpと入力します。

コマンドを入力せずにEnterを押すと、前のデバッガーコマンドが繰り返されます。

ウォッチャー

デバッグ中に式や変数の値を監視することができます。ブレークポイントごとに、ウォッチャーリストの各式が現在のコンテキストで評価され、ブレークポイントのソースコードリストの直前に表示されます。

式の監視を開始するには、watch('my_expression')と入力します。watchersコマンドは、アクティブなウォッチャーを表示します。ウォッチャーを削除するには、unwatch('my_expression')と入力します。

コマンドリファレンス

ステップ実行

cont, c: 実行を継続
next, n: 次のステップへ
step, s: ステップイン
out, o: ステップアウト
pause: 実行中のコードを一時停止（開発者ツールのポーズボタンのようなもの）

ブレークポイント

setBreakpoint(), sb(): 現在の行にブレークポイントを設定
setBreakpoint(line), sb(line): 特定の行にブレークポイントを設定
setBreakpoint('fn()'), sb(...): 関数の本体の最初の文にブレークポイントを設定
setBreakpoint('script.js', 1), sb(...): script.jsの最初の行にブレークポイントを設定
setBreakpoint('script.js', 1, 'num < 4'), sb(...): num < 4がtrueと評価された場合にのみ中断するscript.jsの最初の行に条件付きブレークポイントを設定
clearBreakpoint('script.js', 1), cb(...): script.jsの 1 行目のブレークポイントをクリア

まだロードされていないファイル（モジュール）にブレークポイントを設定することもできます。

bash

$ node inspect main.js
< Debugger listening on ws://127.0.0.1:9229/48a5b28a-550c-471b-b5e1-d13dd7165df9
< For help, see: https://nodejs.org/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>

与えられた式が true と評価された場合にのみ中断する条件付きブレークポイントを設定することもできます。

bash

$ node inspect main.js
< Debugger listening on ws://127.0.0.1:9229/ce24daa8-3816-44d4-b8ab-8273c8a66d35
< For help, see: https://nodejs.org/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>

情報

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 インスペクター統合

V8 インスペクター統合により、デバッグとプロファイリングのために Chrome DevTools を Node.js インスタンスにアタッチできます。Chrome DevTools Protocolを使用します。

V8 インスペクターは、Node.js アプリケーションの起動時に--inspectフラグを渡すことで有効にできます。また、そのフラグでカスタムポートを指定することもできます。たとえば、--inspect=9222はポート 9222 での DevTools 接続を受け入れます。

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

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

したがって、--inspect、--inspect-wait、および--inspect-brkのどれを選択するかを決定する際には、コードをすぐに実行開始させたいか、実行前にデバッガーがアタッチされるのを待機させたいか、またはステップバイステップデバッグのために最初の行で中断させたいかを考慮してください。

bash

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

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

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

Chrome DevTools は、worker threadsのデバッグをまだサポートしていません。ndbを使用してデバッグできます。

デバッガー ​

ウォッチャー ​

コマンドリファレンス ​

ステップ実行 ​

ブレークポイント ​

情報 ​

実行制御 ​

その他 ​

高度な使い方 ​

Node.js 向けの V8 インスペクター統合 ​

デバッガー

ウォッチャー

コマンドリファレンス

ステップ実行

ブレークポイント

情報

実行制御

その他

高度な使い方

Node.js 向けの V8 インスペクター統合