phpcbf - phpcs

Ignorar fragmentos de código en PHP_CodeSniffer

Question

¿Es posible ignorar algunas partes del código de un archivo php cuando es analizado por PHP_CodeSniffer ?

Answer 1

Puede usar la combinación: @codingStandardsIgnoreStart y @codingStandardsIgnoreEnd o puede usar @codingStandardsIgnoreLine .

Ejemplo:

<?php

command1();
// @codingStandardsIgnoreStart
command2(); // this line will be ignored by Codesniffer
command3(); // this one too
command4(); // this one too
// @codingStandardsIgnoreEnd

command6();

// @codingStandardsIgnoreLine
command7(); // this line will be ignored by Codesniffer

Answer 2

Sí, es posible con las anotaciones @codingStandardsIgnoreStart y @codingStandardsIgnoreEnd

<?php
some_code();
// @codingStandardsIgnoreStart
this_will_be_ignored();
// @codingStandardsIgnoreEnd
some_other_code();

También se describe en la documentación.

Answer 3

Antes de la versión 3.2.0, PHP_CodeSniffer usaba una sintaxis diferente para ignorar partes del código del archivo. Vea las respuestas de Anti Veeranna y Martin Vseticka . La sintaxis antigua se eliminará en la versión 4.0

PHP_CodeSniffer ahora usa // phpcs:disable y // phpcs:enable comentarios para ignorar partes de archivos y // phpcs:ignore para ignorar una línea.

Ahora, también es posible deshabilitar o habilitar solo códigos de mensajes de error específicos, sniffs, categorías de sniffs o estándares de codificación completos. Debe especificarlos después de los comentarios. Si es necesario, puede agregar una nota explicando por qué se están deshabilitando y reactivando los sniffs usando el separador -- .

<?php

/* Example: Ignoring parts of file for all sniffs */
$xmlPackage = new XMLPackage;
// phpcs:disable
$xmlPackage[''error_code''] = get_default_error_code_value();
$xmlPackage->send();
// phpcs:enable

/* Example: Ignoring parts of file for only specific sniffs */
// phpcs:disable Generic.Commenting.Todo.Found
$xmlPackage = new XMLPackage;
$xmlPackage[''error_code''] = get_default_error_code_value();
// TODO: Add an error message here.
$xmlPackage->send();
// phpcs:enable

/* Example: Ignoring next line */
// phpcs:ignore
$foo = [1,2,3];
bar($foo, false);

/* Example: Ignoring current line */
$foo = [1,2,3]; // phpcs:ignore
bar($foo, false);

/* Example: Ignoring one line for only specific sniffs */
// phpcs:ignore Squiz.Arrays.ArrayDeclaration.SingleLineNotAllowed
$foo = [1,2,3];
bar($foo, false);

/* Example: Optional note */ 
// phpcs:disable PEAR,Squiz.Arrays -- this isn''t our code
$foo = [1,2,3];
bar($foo,true);
// phpcs:enable PEAR.Functions.FunctionCallSignature -- check function calls again
bar($foo,false);
// phpcs:enable -- this is out code again, so turn everything back on

Para más detalles vea la documentación de PHP_CodeSniffer .