PHP_CodeSniffer
3.7.2
Aviso
Este repositório foi abandonado. Seu sucessor é phpcsstandards/php_codesniffer
Consulte a edição nº 3932 para obter mais informações.
Php_codesniffer é um conjunto de dois scripts PHP; O script phpcs principal que tokeniza os arquivos PHP, JavaScript e CSS para detectar violações de um padrão de codificação definido e um segundo script phpcbf para corrigir automaticamente violações padrão de codificação. PHP_Codesniffer é uma ferramenta de desenvolvimento essencial que garante que seu código permaneça limpo e consistente.
PHP_CODESNIFFER requer o PHP versão 5.4.0 ou maior, embora os sniffs individuais possam ter requisitos adicionais, como aplicativos e scripts externos. Consulte a página Manual de Opções de Configuração para obter uma lista desses requisitos.
Se você estiver usando o php_codesniffer como parte de uma equipe ou estiver executando -o em um servidor de CI, convém definir as configurações do seu projeto usando um arquivo de configuração.
A maneira mais fácil de começar com o php_codesniffer é baixar os arquivos PHAR para cada um dos comandos:
# Download using curl curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcbf.phar # Or download using wget wget https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar wget https://squizlabs.github.io/PHP_CodeSniffer/phpcbf.phar # Then test the downloaded PHARs php phpcs.phar -h php phpcbf.phar -h
Se você usar o Composer, pode instalar o PHP_Codesniffer em todo o sistema com o seguinte comando:
O compositor global exige "squizlabs/php_codesniffer =*" "
Certifique -se de ter o compositor Bin Dir em seu caminho. O valor padrão é ~/.composer/vendor/bin/ , mas você pode verificar o valor que precisa usar executando composer global config bin-dir --absolute .
Ou alternativamente, inclua uma dependência para squizlabs/php_codesniffer no seu arquivo composer.json . Por exemplo:
{"requer-dev": {"squizlabs/php_codesniffer": "3.*"}
}Você poderá executar o PHP_Codesniffer no diretório BIN do fornecedor:
./vendor/bin/phpcs -h ./vendor/bin/phpcbf -h
Se você usar o Phive, pode instalar o php_codesniffer como uma ferramenta de projeto usando os seguintes comandos:
phive install phpcs phive install phpcbf
Você poderá executar o PHP_Codesniffer no diretório das ferramentas:
./tools/phpcs -h ./tools/phpcbf -h
Se você usar a Pear, pode instalar o php_codesniffer usando o instalador de pêra. Isso disponibilizará os comandos phpcs e phpcbf imediatamente para uso. Para instalar o php_codesniffer usando o instalador de pêra, primeiro verifique se você instalou a pêra e execute o seguinte comando:
Instalação de pêra php_codesniffer
Você também pode baixar a fonte php_codesniffer e executar os comandos phpcs e phpcbf diretamente do clone Git:
clone git https://github.com/squizlabs/php_codesniffer.gitcd php_codesniffer PHP BIN/PHPCS -H php bin/phpcbf -h
O padrão de codificação padrão usado por php_codesniffer é o padrão de codificação de pêra. Para verificar um arquivo no padrão de codificação de pêra, basta especificar a localização do arquivo:
phpcs /path/to/code/myfile.php
Ou, se você deseja verificar um diretório inteiro, pode especificar o local do diretório em vez de um arquivo.
PHPCS/PATH/TO/Code-Directory
Se você deseja verificar seu código no padrão de codificação do PSR-12, use o argumento da linha de comando --standard :
PHPCS-Standard = PSR12/PATH/TO/Code-Directory
Se o php_codesniffer encontrar algum erro padrão de codificação, um relatório será mostrado após a execução do comando.
Informações completas de uso e relatórios de exemplo estão disponíveis na página de uso.
A documentação para php_codesniffer está disponível no wiki do GitHub.
Relatórios de bugs e solicitações de recursos podem ser enviados no rastreador de problemas do GitHub.
Consulte Contribuindo.md para obter informações.
Php_codesniffer usa um formato de número de versão MAJOR.MINOR.PATCH .
A versão MAJOR é incrementada quando:
São feitas alterações incompatíveis com phpcbf phpcs .
Alterações incompatíveis com as costas são feitas no formato ruleset.xml , ou
Alterações incompatíveis com as costas são feitas na API usada pelos desenvolvedores de sniff, ou
tipos de token php_codesniffer personalizados são removidos ou
Os farnosos existentes são removidos de php_codesniffer
A versão MINOR é incrementada quando:
Novos recursos compatíveis com versões anteriores são adicionadas aos comandos phpcs e phpcbf , ou
Alterações compatíveis com versões anteriores são feitas no formato ruleset.xml , ou
Alterações compatíveis com as costas são feitas na API usada pelos desenvolvedores de sniff, ou
Novos cheirar são adicionados a um padrão incluído, ou
Os farnosos existentes são removidos de um padrão incluído
NOTA: As alterações compatíveis com as costas na API usadas pelos desenvolvedores de Sniff permitirão que um cheiro existente continue em execução sem produzir erros fatais, mas pode não resultar no Sniff relatando os mesmos erros do que foi anteriormente sem as mudanças necessárias.
A versão PATCH é incrementada quando:
As correções de bug compatíveis com as costas são feitas
NOTA: Como existe php_codesniffer para relatar e corrigir problemas, a maioria dos bugs é o resultado da codificação de erros padrão relatados incorretamente ou codificando erros padrão não sendo relatados quando deveriam ser. Isso significa que as mensagens produzidas por php_codesniffer e as correções que faz, provavelmente serão diferentes entre as versões do patch.
