Local Lua Debugger for Visual Studio Code 使用指南

Local Lua Debugger for Visual Studio Code 使用指南

local-lua-debugger-vscodeLocal Lua Debugger for VSCode项目地址:https://gitcode.com/gh_mirrors/lo/local-lua-debugger-vscode

项目介绍

Local Lua Debugger是一款专为Visual Studio Code设计的简易Lua调试器，它无需任何额外依赖即可工作，简化了开发者在VSCode中调试Lua脚本的过程。自版本0.3.0起，对于那些使用源码映射（如Typescript转Lua）的项目，配置scriptFiles选项变得必要，以便在启动时而非运行时解析断点，提高调试效率。

项目快速启动

要迅速开始使用Local Lua Debugger，首先确保已安装Visual Studio Code。之后，遵循以下步骤：

安装插件

1. 打开Visual Studio Code。
2. 转到扩展市场，搜索“Local Lua Debugger”。
3. 选择由Tom Blind发布的插件并点击安装。
4. 安装完成后重启VSCode。

配置调试环境

编辑.vscode/launch.json文件，添加或修改如下配置以适合你的项目，例如，用于直接执行Lua脚本的基本配置：

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Lua Debug",
            "type": "lua-local",
            "request": "launch",
            "program": "${workspaceFolder}/your_script.lua", // 更换为你的脚本路径
            "args": [], // 添加命令行参数，如果需要的话
            "ignorePatterns": ["^/ignore/path"]
        }
    ]
}

然后，你可以通过点击侧边栏的调试按钮或按F5，选择“Lua Debug”配置来启动调试会话。

应用案例和最佳实践

在Defold游戏引擎中的使用

对于Defold项目，配置需调整为支持引擎特定的需求：

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Debug Defold",
            "type": "lua-local",
            "request": "launch",
            "program": ["dmengine"],
            "args": ["/build/default/game.projectc"],
            "scriptRoots": ["."]
        }
    ]
}

并在游戏中使用环境变量检测调试器的存在来启动调试。

与TypeScriptToLua集成

当你将TypeScript转换为Lua时，确保启用源码映射，并配置scriptFiles来正确设置断点：

{
    "scriptFiles": ["**/*.lua"] // 确保在tsconfig.json中启用sourceMap
}

典型生态项目

Local Lua Debugger广泛应用于多种场景，从简单的个人项目到复杂的框架如Defold或Solar2D/Corona SDK。这些项目利用其简单性和灵活性，在各自的生态系统内实现高效调试。

在Corona SDK中配置示例：

{
    "name": "Debug Corona",
    "type": "lua-local",
    "request": "launch",
    "windows": {
        "program": ["C:\\Program Files (x86)\\Corona Labs\\Corona\\Corona Simulator.exe"],
        "args": ["/no-console", "/debug", "${workspaceFolder}/main.lua"]
    },
    "osx": {
        "program": ["/Applications/Corona/CoronaSimulator.app/Contents/MacOS/CoronaSimulator"],
        "args": ["-no-console", "YES", "-debug", "1", "-project", "${workspaceFolder}/main.lua"]
    }
}

记住，调试成功的关键在于正确配置launch.json，以及理解你的Lua执行环境的特性和需求。利用环境变量检查和条件性加载调试器逻辑，可以在自定义环境中灵活地控制调试行为。

local-lua-debugger-vscodeLocal Lua Debugger for VSCode项目地址:https://gitcode.com/gh_mirrors/lo/local-lua-debugger-vscode