PHP_CodeSniffer
3.7.2
Advertencia
Este repositorio ha sido abandonado. Su sucesor es phpcsstandards/php_codesniffer
Consulte el número 3932 para obtener más información.
Php_codesniffer es un conjunto de dos scripts php; El script phpcs principal que toca los archivos PHP, JavaScript y CSS para detectar violaciones de un estándar de codificación definido y un segundo script phpcbf para corregir automáticamente las violaciones estándar de codificación. PHP_CODESNIFFER es una herramienta de desarrollo esencial que garantiza que su código permanezca limpio y consistente.
PHP_CODESNIFFER requiere PHP versión 5.4.0 o más, aunque los sniffs individuales pueden tener requisitos adicionales, como aplicaciones externas y scripts. Consulte la página Manual de opciones de configuración para obtener una lista de estos requisitos.
Si está utilizando php_codesniffer como parte de un equipo, o lo está ejecutando en un servidor CI, es posible que desee configurar la configuración de su proyecto utilizando un archivo de configuración.
La forma más fácil de comenzar con php_codesniffer es descargar los archivos PHAR para cada uno de los 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
Si usa compositor, puede instalar PhP_CodesNiffer en todo el sistema con el siguiente comando:
Composer Global requiere "squizlabs/php_codesniffer =*"
Asegúrese de tener el directorio de contenedor compositor en su camino. El valor predeterminado es ~/.composer/vendor/bin/ , pero puede verificar el valor que debe usar ejecutando composer global config bin-dir --absolute .
O alternativamente, incluya una dependencia de squizlabs/php_codesniffer en su archivo composer.json . Por ejemplo:
{"Request-dev": {"squizlabs/php_codesniffer": "3.*"}
}Luego podrá ejecutar php_codesniffer desde el directorio de bin de proveedor:
./vendor/bin/phpcs -h ./vendor/bin/phpcbf -h
Si usa Phive, puede instalar php_codesniffer como una herramienta de proyecto utilizando los siguientes comandos:
Phive Instalar PHPCS Phive Instalar PHPCBF
Luego podrá ejecutar php_codesniffer desde el directorio de herramientas:
./tools/phpcs -h ./tools/phpcbf -h
Si usa Pear, puede instalar php_codesniffer usando el instalador de pera. Esto hará que los comandos phpcs y phpcbf estén disponibles de inmediato para su uso. Para instalar php_codesniffer utilizando el instalador de pera, primero asegúrese de haber instalado la pera y luego ejecute el siguiente comando:
Pear install php_codesniffer
También puede descargar la fuente PHP_CODESNIFFER y ejecutar los comandos phpcs y phpcbf directamente desde el clon Git:
Git clone https://github.com/squizlabs/php_codesniffer.gitcd php_codesniffer PHP Bin/PhPCS -H Php bin/phpcbf -h
El estándar de codificación predeterminado utilizado por php_codesniffer es el estándar de codificación de pera. Para verificar un archivo contra el estándar de codificación de Pear, simplemente especifique la ubicación del archivo:
phpcs /path/to/code/myfile.php
O si desea verificar un directorio completo, puede especificar la ubicación del directorio en lugar de un archivo.
phpcs/rath/to/code-directory
Si desea verificar su código con el estándar de codificación PSR-12, use el argumento de la línea de comandos --standard :
PHPCS-Standard = PSR12/Path/TO/Code-Directory
Si PhP_CodesNiffer encuentra algún error estándar de codificación, se mostrará un informe después de ejecutar el comando.
La información de uso completo y los informes de ejemplo están disponibles en la página de uso.
La documentación para php_codesniffer está disponible en el wiki GitHub.
Los informes de errores y las solicitudes de funciones se pueden enviar en el rastreador de problemas de GitHub.
Ver contribuyente.md para obtener información.
PHP_CODESNIFFER utiliza un formato de número de versión MAJOR.MINOR.PATCH .
La versión MAJOR se incrementa cuando:
Se realizan cambios con incompatibles hacia atrás en cómo se utilizan los comandos phpcs o phpcbf , o
Los cambios incompatibles hacia atrás se realizan en el formato ruleset.xml , o
Se realizan cambios incompatibles hacia atrás a la API utilizada por los desarrolladores de Sniff, o
Los tipos de token PHP_CODESNIFFER personalizados se eliminan, o
Los sniffs existentes se eliminan de php_codesniffer por completo
La versión MINOR se incrementa cuando:
Se agregan nuevas características compatibles con el revés a los comandos phpcs y phpcbf , o
Los cambios compatibles con versiones hacia atrás se realizan en el formato ruleset.xml , o
Se realizan cambios compatibles con la API utilizado por los desarrolladores de Sniff, o
Se agregan nuevos sniffs a un estándar incluido, o
Los sniffs existentes se eliminan de un estándar incluido
Nota: Los cambios compatibles con hacia atrás en la API utilizado por los desarrolladores de Sniff permitirán que un olfato existente continúe funcionando sin producir errores fatales, pero puede no dar como resultado el sniffe que informa los mismos errores que anteriormente sin se requerían cambios.
La versión PATCH se incrementa cuando:
Se realizan correcciones de errores compatibles con hacia atrás
Nota: Como existe PHP_CODESNIFFER para informar y solucionar problemas, la mayoría de los errores son el resultado de la codificación de errores estándar que se informan incorrectamente o codifican errores estándar que no se informan cuando deberían ser. Esto significa que los mensajes producidos por php_codesniffer, y las correcciones que hace, es probable que sean diferentes entre las versiones de parche.
