Correct settings for XDebug + VSCode + Lando (+3.0)

.lando.yml

# Lando version is at least +3.0 
name: drupal-nine
recipe: drupal9
services:
  appserver:
    webroot: web
    xdebug: debug
    config:
      php: .vscode/php.ini

launch.json

{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "Listen for XDebug (9003)",
      "type": "php",
      "request": "launch",
      "port": 9003,
      "log": true,
      "pathMappings": {
        "/app/": "${workspaceRoot}/",
      }
    }
  ]
}

php.ini

[PHP]

; Xdebug
xdebug.max_nesting_level = 256
xdebug.show_exception_trace = 0
xdebug.collect_params = 0
xdebug.mode = debug
xdebug.start_with_request = yes
xdebug.client_host = ${LANDO_HOST_IP}
; xdebug.log = /tmp/xdebug.log

; Remote settings
xdebug.remote_enable = 1
xdebug.remote_autostart = 1
xdebug.remote_host = ${LANDO_HOST_IP}
; xdebug.remote_connect_back = 1
; xdebug.remote_log = /tmp/xdebug_remote.log

It's not necessary to duplicate Lando's default php.ini, since the custom php.ini is loaded additionally to any existing PHP configuration.

Totally right, thank you for your comment @smk. I've update php.ini with XDebug settings only.

Thank you!

Code needs an update for Lando v2+ version.

Please read this official documentation instead.

NB:
For Unix users, there is often a known issue with port - preventing XDebug to work in VSCode.
You simply need to manually open your port 9000.

Just updated this gist with new correct settings for all of those files with new Lando +3.0 version.

Most important change to underline is that Lando now uses XDebug 3 and the port has changed from 9000 to 9003 by default (see this issue) - so launch.json file has been updated accordingly.

Hope that helps others!

Good luck debugging!

Are people using the Xdebug extension for VSCode to debug php? And if so, which one?

I am seeing 3 different extensions in the VSCode extensions marketplace named "PHP Debug" and the description "Debug support for PHP with Xdebug" - I have been trying to use Felix Becker's version because it has the most downloads but I cannot get it to work. (I get an error saying port 9003 is refusing connections but I don't even have my firewall on my mac turned on) At this point I am wondering if the extensions are the problem

@karlkaebnick I do have Xdebug working with Lando and VSCode with this gist's settings.

PHP Debug is the VScode extension I use.

On some system, you have to open the port 9003 for debugging session to work, as follow for instance:

sudo iptables -A INPUT -p tcp -d 0/0 -s 0/0 --dport 9003 -j ACCEPT

See the Known issues on Lando documentation for reference.

Official guide: https://docs.lando.dev/guides/lando-with-vscode.html (based off of this gist).

Thanks @chrishappy but unless I'm wrong, the same link was already provided in the previous comment.

Ah yes. I didn't realize that link was also to the official guide. Maybe someone else would also be confused?