NPL Debug：VS Code NPL HTTP Debugger插件使用指南

NPL Debug是专门为Visual Studio Code设计的NPL HTTP Debugger插件，支持步骤执行、继续运行、设置断点等功能。如果您想开发新的调试适配器，这里提供了详细的参考资料。

在附加模式下使用NPL Debug

1. 在VS Code中安装NPL Debug插件。
2. 在当前工作空间目录中运行启用HTTP调试的NPL程序。
3. 切换到调试视图，点击齿轮下拉菜单。
4. 选择调试环境"NPL Debug Attach"。
5. 按下绿色的'播放'按钮开始调试。

您可以为打开源文件指定额外的搜索路径。您的launch.json文件可能如下所示，${workspaceFolder}默认始终添加到搜索路径中。

{
  "type": "NPL",
  "request": "attach",
  "name": "NPL Http Attach",
  "port": 8099,
  "trace": false,
  "searchpath": [
    "${workspaceFolder}/npl_packages/main",
    "${workspaceFolder}/npl_packages/paracraft"
  ]
}

VS Code支持多调试会话，因此您可以同时安装Chrome调试器并启动它，从而在同一个VS Code IDE中调试前端和后端代码。

参数说明：

• port：目标运行应用程序上的NPL HTTP调试器端口。
• searchpath：当命中断点时，调试器应查找相应源代码的位置。
• trace：向调试控制台输出更多信息。

使用启动模式

附加模式适合高级用户，因为当调试器未附加时，应用程序可以全速运行，并且可以多次附加和分离到同一个运行应用程序。

对于希望调试首次加载的脚本的用户，我们也提供了启动模式。不同之处在于不再需要手动启动NPL运行时，而是必须在launch.json中指定runtimeExecutable、bootstrapper等，如下所示。

{
    "type": "NPL",
    "request": "launch",
    "name": "Launch NPL",
    "runtimeExecutable": "D:\\lxzsrc\\ParaCraftSDK\\redist\\paraengineclient.exe",
    "bootstrapper": "script/apps/Aries/main_loop.lua",
    "cmdlineParams": "mc=true noupdate=true",
    "port": 8099,
    "searchpath": [
      "${workspaceFolder}/npl_packages/main",
      "${workspaceFolder}/npl_packages/paracraft"
    ],
    "exitAppOnStop": true,
    "trace": false
}

参数说明：

• runtimeExecutable：如果未指定或为"npl"，我们将在环境路径变量中搜索已安装的NPL运行时可执行文件。在Linux或Mac下，通常是/usr/local/bin/npl。
• bootstrapper：相对于工作目录的主要NPL脚本文件，例如main_loop.lua。如果这是current_open_file，则将使用当前在编辑器中打开的文件。
• cmdlineParams：除bootstrapper和port之外的附加命令行参数。
• exitAppOnStop：当用户停止调试时是否退出应用程序。

构建和调试

git clone https://github.com/tatfook/vscode-npl-debug.git
cd vscode-npl-debug
npm install

• 在VS Code中打开项目文件夹。
• 在调试面板中，选择Extension Server，按F5构建并在另一个VS Code窗口中启动NPL Debug。在该窗口中：
  • 在当前工作空间目录中运行启用HTTP调试的NPL程序。
  • 切换到调试视图，点击齿轮下拉菜单。
  • 选择调试环境"NPL Debug Attach"（在launch.json中添加debugServer:4711）。
  • 按F5开始调试。

或者在launch.json中：

{
  "type": "NPL",
  "request": "launch",
  "name": "NPL Sample",
  "port": 8099,
  "debugServer": 4711,
  "trace": true,
  "program": "${workspaceFolder}/readme.md",
  "stopOnEntry": true
}

非常重要的是要在端口4711上启用debugServer，否则您无法调试NPL适配器。如果您不调试服务器，应删除debugServer行。更多信息，请仔细阅读此文档。

发布扩展

请参考此文档。我们需要注册一个令牌并创建一个名为tatfook的发布者。

npm install -g vsce
vsce package
vsce publish minor