Configurar Visual Studio Code + Laradock + xDebug

Este artigo serve para explicar como utilizar o xDebug com o Laradock no Visual Studio Code.

Viusal Studio Code

Visual Studio Code é um editor de código redefinido e otimizado para criar e depurar aplicações modernas para a web. O Visual Studio Code é gratuito e está disponível para a tua plataforma favorita — Linux, macOS e Windows.

Laradock

Laradock é um ambiente de desenvolvimento PHP completo para Docker.

Suporta uma variedade de serviços comuns, todos pré-configurados para fornecer um ambiente de desenvolvimento de PHP pronto.

xDebug

xDebug é uma extensão do PHP para auxiliar na depuração e desenvolvimento.

Editar o ficheiro .env na pasta do Laradock

  • nano .env

Editar os ficheiros de configuração do xDebug

  • nano workspace/xdebug.ini
xdebug.remote_host=host.docker.internal
xdebug.remote_connect_back=1
xdebug.remote_port=9000
xdebug.idekey=VSCODE
xdebug.remote_autostart=1
xdebug.remote_enable=1
xdebug.cli_color=1
xdebug.profiler_enable=1
xdebug.profiler_output_dir="~/xdebug/vscode/tmp/profiling"
xdebug.remote_handler=dbgp
xdebug.remote_mode=req
xdebug.var_display_max_children=-1
xdebug.var_display_max_data=-1
xdebug.var_display_max_depth=-1

Rebuild e reiniciar os containers workspace e php-fpm

  • docker-compose build workspace php-fpm

Activar o xDebug no Visual Studio Code

  • No menu do Visual Studio Code, clicar Run e de seguida Add Configuration
{
"name": "Listen for XDebug",
"type": "php",
"request": "launch",
"port": 9000,
"log": true,
"pathMappings": {
"/var/www": "${workspaceRoot}",
},
"ignore": [
"**/vendor/**/*.php"
]
}

Start/Stop xDebug

Ao instalar o xDebug, este fica ativo para ser executado no startup por padrão.

Para controlar o comportamento do xDebug (no container php-fpm), podes executar os seguintes comandos da pasta raiz Laradock, (no mesmo prompt em que executas docker-compose):

Parar o xDebug de iniciar por defeito: ./php-fpm/xdebug stop.
Iniciar o xDebug por defeito: ./php-fpm/xdebug start.
Ver o estado do xDebug: ./php-fpm/xdebug status.

Está pronto, agora podes começar a usar xDebug no Visual Studio Code.

Full Stack Web Developer