Como instalar e configurar o PHPSniffer no Visual Studio Code (VSCode)

 Olá pessoal, nesse post eu trago para vocês como instalar e configurar o PHPSniffer no Visual Studio Code (VsCode).


Como pré requisitos precisamos de:
  • Ter xampp instalado e startado: https://www.apachefriends.org/index.html
  • Ter o composer instalado: https://getcomposer.org/download/
  • Ter um editor de código: https://code.visualstudio.com
Para quem programa em PHP essa extensão é ótima para poder manter seu código bem estruturado e as normas da PSR.

Então ensinarei para vocês o passo a passo de como instalar e configurar para que ela funcione junto com seu código ou projeto.

Vamos abrir o vscode e ir até a parte de extensões:



Agora vamos digitar na barra de pesquisa PHP Sniffer, clicar e instalar a extensão que pertence ao desenvolvedor wongjn.



Depois de instalado, vamos precisar configurar algumas coisas dentro do vscode para que ele consiga reconhecer a extensão e as normas PSR que vamos utilizar para reorganizar e estruturar o código com as normas.

Para isso vamos até o site: https://github.com/squizlabs/PHP_CodeSniffer

Aqui vamos até a sessão composer que nos indica como baixar o projeto para configurar dentro de seu projeto.



Aqui vamos copiar esse código do composer porém, vamos retirar o global do comando para instalar ele apenas localmente no projeto. Ficando assim: 

composer require "squizlabs/php_codesniffer=*"

Abriremos o terminal do VsCode e vamos executar esse comando do composer para criar a dependência dentro do projeto.

Após executar o comando e o composer instalar todas dependências do PHPSniffer dentro do projeto, precisamos configurar o VSCode nas configurações.

Vamos apertar as teclas: CTRL+SHIFT+P

Digitar na barra que abriu open setting (json)


Após abrir o arquivo de configurações do vscode, vamos colocar dentro dele as seguintes linhas:

"files.watcherExclude": {
        "**/.git/objects/**": true,
        "**/.git/subtree-cache/**": true,
        "**/node_modules/*/**": true,
        "**/.hg/store/**": true,
        "**/vendor/*/**": true
    },
    "files.exclude": {
        "**/.classpath": true,
        "**/.project": true,
        "**/.settings": true,
        "**/.factorypath": true
    },
    "editor.formatOnSave": true,
    "php.validate.executablePath": "C:\\xampp\\php\\php.exe",
    "php.suggest.basic": false,
    "phpSniffer.run": "onSave",
    "phpSniffer.autoDetect": true,
    "phpSniffer.standard": "PSR12",
    "[php]": {
        "editor.defaultFormatter": "wongjn.php-sniffer"
    }


Lembrando que, dentro da chave "php.validate.executablePath" você tem que digitar o caminho completo que leva até seu executável do PHP.

Agora é só salvar e começar a usar o PSR dentro do seu projeto para que ele atenda as novas normas da linguagem.

Comentários

Postagens mais visitadas deste blog

Integrando o Framework Codeigniter 3 com o PHPUnit via composer

Comandos/atalhos úteis no Visual Studio Code (VsCode)

Integrando o XDebug com o PHPUnit