Search code examples
govisual-studio-coderevel

Is it possible to debug go revel framework from Visual Studio Code?


I'm trying to debug a revel app with visual studio but I can't get it to work.

I've seen this question how to debug revel framework(golang) application in visual studio code(vscode) but no answers yet...

I've tried with this config:

{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "Launch",
      "type": "go",
      "request": "launch",
      "mode": "debug",
      "remotePath": "",
      "port": 2345,
      "host": "127.0.0.1",
      "program": "~/code/go/bin/revel",
      "env": {},
      "args": [],
      "showLog": true
    }
  ]
}

But I'm getting this error: Failed to continue: "The program attribute must point to valid directory, .go file or executable."

I think it must be the rebel binary the one to be run here, but I don't know how to pass the app path, should it go in "args"?


Solution

  • Yes it's possible.

    1. Suppose that the GOPATH is C:\Work\golang
    2. Revel project name is myapp, thus the location of the project (workspace) will be C:\Work\golang\src\myapp.
    3. Make some changes to the controllers etc...
    4. Run the application with revel run myapp, then press CTRL+C to exit. This step is necessary to generate corresponding go files. The generated file, i.e. the main package will be available under ${workspaceRoot}/app/tmp/main.go
    5. Configure launch.json as follows:

      {
          "version": "0.2.0",
          "configurations": [
              {
                  "name": "Launch",
                  "type": "go",
                  "request": "launch",
                  "mode": "debug",
                  "remotePath": "",
                  "port": 2345,
                  "host": "127.0.0.1",
                  "env": {},
                  "showLog": true,
                  "program": "${workspaceRoot}/app/tmp/",
                  "args": ["-importPath", "myapp", "-srcPath", "c:\\work\\golang\\src",  "-runMode", "dev"]
              }
          ]
      }
      
    6. The important parts are program and args parameters, while the other parameters are unmodified.

    7. Set breakpoint and start the delve debugger...

    Debug revel application

    EDIT:

    1. Setting args parameter to ["-importPath", "myapp", "-srcPath", "${workspaceRoot}/..", "-runMode", "dev"] also work, and I think this should work in other platforms (Mac, Linux) too.
    2. The error message is related to delve issue. See https://github.com/Microsoft/vscode-go/issues/986