pyclewn-nodedbg は、Vim 上で Node.js スクリプトのデバッグを行うための、 Pyclewn 用の追加クラスです.
Vim と Node.js は古いバージョンでなければ対応できてるとは思いますが、 Pyclewn は Python3 用 が必要ですので注意してください.
clewn/* を Pyclewn の python ディレクトリ($HOME/lib/python/clewn 等) へコピーし、
patch/* をそれぞれのファイルへ適用します
($HOME/lib/python/clewn/vim.py $HOME/.vim/autostart/pyclewn.vim 等).
foo.js スクリプトのデバッグ.
$ node --debug-brk foo.js
$ pyclewn --nodedbg -e gvim
または
$ node --debug-brk foo.js
:Pyclewn nodedbg
foo.js の 5 行目に breakpoint をセットし、continue する.
:Cbreak foo.js:5
:Ccontinue
変数 bar の表示.
:Cprint bar
<C-B> による breakpoint セットや <S-C> による continue 等のキーマップ有効化.
:Cmapkeys
変数一覧 (Scope Variables) ウィンドウの表示.
:Cdbgvar
変数一覧ウィンドウのオブジェクトなどの展開は、
ウィンドウの該当行へカーソルを移動し <S-X> を押下.
Node.js の debugger へ再接続(このときブレイクポイントも復元).
:Cattach
その他の有効なコマンドの表示.
:Chelp
現状では、
nodedbg からNode.jsのスクリプトを直接起動することには対応してません.
また、Node.js の debugger へ接続するときは、localhost:5858 固定です.
Cbreak foo.js:10 のような breakpoint 追加コマンドの実行時に、
対象のスクリプトファイル (foo.js) が Node.js 側で読み込まれていない場合、
breakpoint の追加は追加されますが、実際にファイルが読み込まれるまでは、
画面に反映されません.
また、ファイル読み込みから breakpoint の設定までに時間差があるので、
スクリプトの内容によっては停止しないこともあります.
ファイル末尾を超える位置にブレイクポイントが設定されたとき (まだ実行されていない関数内にブレイクポイントを設定しようとしたときなどで、 Node.js の debugger がブレイクポイントの位置を変更することがあり、 ファイル末尾を超えることがある)、 ブレイクポイントや停止時の位置が表示されない.
Node.js の debugger へ接続できないときに、
適切なエラーメッセージが表示されません.
(Node.js debugger connection closed. とは表示されます).
Cprint の表示などにいわゆる全角文字がふくまれていると、
それ以後 pyclewn の console の表示がくずれます.
Cdbgvar による表示はまだ結構おかしいのです.
また、このウィンドウでも日本語とかを表示すると表示がくずれます.
まだそれほど(というか殆ど)使い込んでないので、 他にもいろいろあるんじゃないかと思います.
Node.js の --debug オプションや、v8 debugger protocolの扱いについて、
Node Inspector と
DebuggerProtocol
を参考にさせていただきました.
Pyclewn のクラス拡張が利用できたため、 わりとお手軽に、Vim 上での Node.js 用 Debugger UI が作成できました.
ありがとうございました.
- Cdbgvar コマンドによる変数一覧表示(まだあまりうまく動かない版).
- デバッグ対象のプロセスがリクエストを受け付けなくなることへの対応.
- "deque index out of range" で切断されることへの対応(たぶん).
- continue コマンドが実行されないときがあるのを修正.
- ブレイクポイントが設定されていない位置で clear を実行するとエラーになるのを修正.
- Node.js の debugger への再接続時に、 breakpoint を復元するようにした.
- ロード前のスクリプトファイルへの breakpoint 設定に部分的に対応.
Copyright (c) 2013 hankei6km (MIT License)
-
clewn/nodedbg.pyは Pyclewn の simple.py を元に作成しました. -
clewn/nodeclient.pyの一部のメソッドは、 Node-Inspector の lib/client.js と lib/protocol.js 内のコードを元に作成しました.