Usando o VS Code

Esse capitulo serve apenas para ajudar quem pretende utilizar o VS Code para desenvolver. As dicas são validas para as versões entre:

• VS Code 1.28.1, em outubro de 2018
• VS Code 1.59.0, em junho de 2021

Provavelmente deve funcionar com versões mais recentes

Extensões

O Vs Code puro não é muito para o desenvolvimento PHP é recomendável instalar as extensões

Extensões para PHP

• PHP Debug - Necessário para o funcionamento com XDebug
• PHP Extension Pack
• PHP Intelephense
• PHP IntelliSense
• PHP DocBlocker - ajuda no momento de documentar métodos

Com essas extensão terá autocomplete do código entre outras opções.

• Leitura complementar Plugins de PHP para VS Code, Vitor Nunes, novembro de 2018 no Medium
• DevMedia - Visual Studio Code - Saiba como usar os melhores recursos. Vídeo YouTube
• Como Configurar o VSCode para PHP?, Canal Code Easy no YouTube

Extensões de auxilio no desenvolvimento

• Todo Tree - Mostra todos os pontos do código com as tarefas TODO e FIXME
• Material Icon Theme
• Git Graph - Faz o gráfico das branchs de um projeto
• Eclipse Keymap - deixa o Vs Code com as mesma teclas de atalho do eclipse

Configurando XDebug

Como o PHP 7.2.X ou superior o recomendado é usar o XDebug 3.X

Configurando XDebug 3.x

A versão 3.x do XDebug trouxe algumas alterações nas configurações do php.ini e também nas configurações no VS Code. Lembrando que a versão 3.x do XDebug só funciona no PHP 7.2 ou superior.

Tenha o XDebug 3.x instalado e configurado

Adicionar as seguintes linhas:

xdebug.mode = debug
xdebug.start_with_request = yes

Feito isso a configuração do php.ini estará pronta.

No VS Code, deve ser alterada a configuração da porta, de 9000 para 9003:

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Listen for XDebug",
            "type": "php",
            "request": "launch",
            "port": 9003
        }
    ]
}

Realizadas essas configurações, o modo Debug do VS Code deve funcionar normalmente.

Referências para dúvidas quanto ao upgrade da versão 2 para a 3 do XDebug:

• https://xdebug.org/docs/upgrade_guide
• https://www.youtube.com/watch?v=MDUAxMPYQPA&t=459s

Configurando XDebug 2.x

pré-requisito ter o XDebug instalado e configurado.

No VS Code:

1. Instalar a extensão PHP Extension Pack (Felix Becker), que contém o IntelliSense e o Debugger. Reiniciar o VS Code.
2. Clicar no ícone Debug, na lateral esquerda (CTRL+SHIFT+D)
3. Clicar no ícone de Configuração ("Configure or Fix 'launch.json'). Escolher a opção PHP, que vai gerar o arquivo launch.json dentro da pasta .vscode do projeto. Atenção: existe diferença da configuração do launch.json de um um servidor local, para um servidor remoto
4. "No Configurations" ficará "Listen for XDebug"
5. Veja abaixo Como usar o XDebug no VsCode

Dica by José Barbosa de Macedo Junior

Exemplo do arquivo launch.json - acesso local

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Listen for XDebug",
            "type": "php",
            "request": "launch",
            "port": 9000
        }
    ]
}

Exemplo do arquivo launch.json - acesso REMOTO

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Listen for XDebug",
            "type": "php",
            "request": "launch",
            "port": 9000,
            "log": true,
            "pathMappings": {
                "/var/www/html": "${workspaceFolder}/src"
            }
        }
    ]
}

Explicando alguns parâmetros

• log : true - irá mostrar no console tudo que está acontecendo.
• pathMappings - server para mapear os arquivos locais com os arquivos no servidor remoto. Também utilize quando Utilizar o Docker. ${workspaceRoot}/src

https://code.visualstudio.com/docs/editor/variables-reference

Como usar o XDebug no VsCode

1. Em um código PHP, clicar ao lado do número de qualquer linha para adicionar o breakpoint.
2. Só teclar F5 para iniciar o debug do código. (a barra status vai mudar de azul para laranja). Caminho alternativo: clicar no ícone de Debug depois no play verde
3. Acessar sua aplicação via URL

Dica by José Barbosa de Macedo Junior

Links de referencia

• https://imasters.com.br/devsecops/como-usar-o-xdebug-dentro-de-um-container-docker
• https://github.com/felixfbecker/vscode-php-debug/issues/240
• https://tsayao.com.br/735/docker-mysql-nginx-php-com-debug-visual-studio-code-e-intellij-idea-php-storm/
• https://marketplace.visualstudio.com/items?itemName=felixfbecker.php-debug