如何在VS Code中断点调试flutter pub run build_runner build命令

前置准备 #

你已经基于build_runner开发完成自定义代码生成器，且本地可正常执行flutter pub run build_runner build命令。

操作步骤 #

• 打开VS Code左侧「运行和调试」面板，点击「创建launch.json文件」，环境选择「Dart」
• 在生成的launch.json文件中，替换configurations数组内容为以下配置：

{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "调试build_runner",
      "type": "dart",
      "request": "launch",
      "program": "flutter",
      "args": [
        "pub",
        "run",
        "build_runner",
        "build",
        // 可按需添加其他参数，比如删除冲突输出
        // "--delete-conflicting-outputs"
      ],
      "cwd": "${workspaceFolder}"
    }
  ]
}

• 打开你编写的代码生成器对应dart文件，在需要调试的代码行左侧点击，打上红色断点标记
• 回到「运行和调试」面板，顶部下拉选择刚才创建的「调试build_runner」配置，点击绿色启动按钮即可启动调试
• 程序运行到断点位置会自动暂停，此时你可以查看变量值、执行单步调试、查看调用栈等常规调试操作

常见问题排查 #

如果断点没有命中，可尝试以下操作：

• 运行flutter pub get刷新项目依赖，确保修改后的代码生成器已被加载
• 在args数组中添加--delete-conflicting-outputs参数，清除之前的构建缓存
• 确认你的代码生成器在pubspec.yaml中为本地路径依赖，避免拉取到远程缓存的版本

内容的提问来源于stack exchange，提问作者Jens