fix: Update VS Code debugger script

[liamdawson]

Fix the debugger script to fix #1369, while still supporting the fix for #535.

• I have read the contribution documentation for this project.
• I agree to follow the code of conduct that this project follows, as appropriate.
• The changes are appropriately documented (if applicable).
• The changes have sufficient test coverage (if applicable).
• The testsuite passes successfully on my local machine (if applicable).

Summarize your changes:

Given the environment in #1369, this change supports running the debugger script, without breaking changes for users relying on the previous path structure. (Assuming it worked previously?)

[chetbox]

The current documentation is incorrect because the script is expected to be run from a different location. This change means the script can be run from either location, which is great!

For those wondering, for now, you can debug the main (and renderer!) process with this configuration:

{
  "version": "0.2.0",
  "configurations": [
    {
      "type": "node",
      "request": "launch",
      "name": "Electron: Main",
      "runtimeExecutable": "${workspaceFolder}/node_modules/@electron-forge/cli/script/vscode.sh",
      "windows": {
        "runtimeExecutable": "${workspaceFolder}/node_modules/@electron-forge/cli/script/vscode.cmd"
      },
      "runtimeArgs": ["--remote-debugging-port=9223"],
      "cwd": "${workspaceFolder}",
      "timeout": 60000
    },
    {
      "name": "Electron: Renderer: App",
      "type": "chrome",
      "request": "attach",
      "port": 9223,
      "webRoot": "${workspaceFolder}",
      "timeout": 120000,
      "url": "http://localhost:3000/app"
    }
  ],
  "compounds": [
    {
      "name": "Electron: All",
      "configurations": ["Electron: Main", "Electron: Renderer: App"]
    }
  ]
}

Edit: Tested on macOS only.

As an aside, how does one contribute a change to the electron-forge documentation? I think this is one for @MarshallOfSound.

[zachcowell]

@chetbox , I was seeking a solution to have the VS Code debugger working for both main and renderer processes and was able to get it working by modifying your config. I am using electron-forge with the webpack template

{
  "version": "0.2.0",
  "configurations": [
    {
      "type": "node",
      "request": "launch",
      "name": "Electron: Main",
      "runtimeExecutable": "${workspaceFolder}/node_modules/.bin/electron-forge-vscode-nix",
      "windows": {
        "runtimeExecutable": "${workspaceFolder}/node_modules/.bin/electron-forge-vscode-win.cmd"
      },
      "runtimeArgs": ["--remote-debugging-port=9223"],
      "cwd": "${workspaceFolder}"
    },
    {
      "name": "Electron: Renderer: App",
      "type": "chrome",
      "request": "attach",
      "port": 9223,
      "webRoot": "${workspaceFolder}",
      "timeout": 120000,
      "url": "http://localhost:3000/main_window"
    }
  ],
  "compounds": [
    {
      "name": "Electron: All",
      "configurations": ["Electron: Main", "Electron: Renderer: App"]
    }
  ]
}

[stephendpmurphy]

Can confirm that the temporary solution by @chetbox worked for me on Linux 👍

[arsinclair]

Looks good to me, as it handles both the old and new way. I think it can be merged.

[arsinclair]

As an aside, how does one contribute a change to the electron-forge documentation?

@chetbox, it is in the electron-forge-docs repo, and there's already a PR to update the docs: electron-forge/electron-forge-docs#4.

[taylorhadden]

What's the holdup for this being merged in? Debugging on Mac is currently broken…

[gaziqbal]

Should this issue be closed? I ended up with the following workaround in my launch.json

{
    "version": "0.2.0",
    "configurations": [
        {
            "type": "node",
            "request": "launch",
            "name": "Electron: Main",
            "runtimeExecutable": "node",
            // LTS version - as installed via NVM
            "runtimeVersion": "18.15.0",
            "runtimeArgs": [
                "node_modules/@electron-forge/cli/dist/electron-forge-start",
                "--enable-logging",
                "--vscode",
                "--",
                // Delimited by ~ as expected by the electron-forge-start script.
                "~--remote-debugging-port=9223~"
            ],
            "cwd": "${workspaceFolder}"
        },
        {
            "name": "Electron: Renderer",
            "type": "chrome",
            "request": "attach",
            "port": 9223,
            "webRoot": "${workspaceFolder}",
            "timeout": 30000,
            "url": "http://localhost:3000/main_window"
        },
    ],
    "compounds": [
        {
            "name": "Electron: All",
            "configurations": [
                "Electron: Main",
                "Electron: Renderer"
            ]
        }
    ]
}

[arsinclair]

Why was this closed?