プリザンターのサーバスクリプトをVSCodeでデバッグする

概要

Pleasanterのサーバスクリプト をビジュアルにデバッグしたい!と思う貴方は必見です。
デバッグするためにはVisual Studio Code(以降VSCode)が必要になります。
VSCodeからリモートデバッグをします。

制限事項

デバッグ中はデバッガが接続するまでスクリプトが途中で停止しテーブルを利用できません。
本番環境では使用しないでください。

前提条件

1. プリザンターは2021/10/31リリースのver.1.2.14.0以上が必要です
2. プリザンターが稼働するサーバのポート9222が開いている必要があります。
3. デバッグを行うPCにVSCodeがインストールされている必要があります。

準備

Visual Studio Codeを起動し、.vscodeフォルダ内にlaunch.jsonを配置します。

launch.json

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Attach to ClearScript V8 on port 9222",
            "type": "node",
            "request": "attach",
            "protocol": "inspector",
            "address": "192.168.1.101",
            "port": 9222
        }
    ]
}

• デバッグするプリザンターが動作する環境への接続情報です
• 必要に応じてaddressを対象のサーバのアドレスに変更します
• ローカルPC上にプリザンターがある場合にはlocalhostを指定します。

操作手順

1. ブラウザでプリザンターにアクセスしデバッグする「サーバスクリプト」の内容の先頭行に、//debug//を記述し保存します。
2. デバッグする「テーブル」を開きます。
3. サーバスクリプトがデバッグモードで待機状態となり画面の応答が無い状態になります。
4. VSCodeでRun → Start Debuggingを選びます。
5. 対象のソースコードが読み込まれ、デバッグが可能となります。

動作イメージ

対象ソースが読みこまれてブレイクしているところ。

グローバル変数やマウスホバーで変数の中身も見えます