Отладка в VSCode

Это руководство показывает, как настроить отладку VSCode как для вашего собственного проекта Electron, так и для родной базы кода Electron.

Отладка вашего приложения Electron​

Основной процесс​

1. Откройте проект Electron в VSCode.​

$ git clone git@github.com:electron/electron-quick-start.git
$ code electron-quick-start

2. Добавьте файл .vscode/launch.json с следующей конфигурацией:​

{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "Debug Main Process",
      "type": "node",
      "request": "launch",
      "cwd": "${workspaceFolder}",
      "runtimeExecutable": "${workspaceFolder}/node_modules/.bin/electron",
      "windows": {
        "runtimeExecutable": "${workspaceFolder}/node_modules/.bin/electron.cmd"
      },
      "args" : ["."],
      "outputCapture": "std"
    }
  ]
}

3. Отладка​

Установите несколько точек останова в main.js, и начните отладку в Представлении отладки. Вы должны достигать точек останова.

Вот предварительно настроенный проект, который вы можете загрузить и непосредственно отладить в VSCode: https://github.com/octref/vscode-electron-debug/tree/master/electron-quick-start

Отладка кодовой базы Electron​

Если вы хотите собрать Electron из исходного кода и изменить родную кодовую базу Electron, этот раздел поможет вам в тестировании ваших изменений.

Для тех, кто не уверен, где получить этот код или как его собрать, Инструменты сборки Electron автоматизируют и объяснят большую часть этого процесса. Если вы хотите вручную настроить среду, вы можете вместо этого использовать эти инструкции по сборке.

Windows (C++)​

1. Откройте проект Electron в VSCode.​

$ git clone git@github.com:electron/electron-quick-start.git
$ code electron-quick-start

2. Добавьте файл .vscode/launch.json с следующей конфигурацией:​

{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "(Windows) Launch",
      "type": "cppvsdbg",
      "request": "launch",
      "program": "${workspaceFolder}\\out\\your-executable-location\\electron.exe",
      "args": ["your-electron-project-path"],
      "stopAtEntry": false,
      "cwd": "${workspaceFolder}",
      "environment": [
          {"name": "ELECTRON_ENABLE_LOGGING", "value": "true"},
          {"name": "ELECTRON_ENABLE_STACK_DUMPING", "value": "true"},
          {"name": "ELECTRON_RUN_AS_NODE", "value": ""},
      ],
      "externalConsole": false,
      "sourceFileMap": {
          "o:\\": "${workspaceFolder}",
      },
    },
  ]
}

Примечания к конфигурации

• cppvsdbg требует включения встроенного расширения C/C++.
• ${workspaceFolder} — это полный путь к каталогу src Chromium.
• your-executable-location будет одним из следующих, в зависимости от нескольких факторов:
  • Testing: Если вы используете стандартные настройки Инструментов сборки Electron или стандартные инструкции при сборке из исходного кода.
  • Release: Если вы создали сборку Release, а не Testing.
  • your-directory-name: Если вы изменили это во время процесса сборки от значений по умолчанию, это будет то, что вы указали.
• Массив строк args "your-electron-project-path" должен содержать абсолютный путь к каталогу или файлу main.js проекта Electron, который вы используете для тестирования. В этом примере это должен быть путь к electron-quick-start.

3. Отладка​

Установите несколько точек останова в файлах .cc по вашему выбору в родном коде Electron C++, и начните отладку в Представлении отладки.