Comment puis-je supprimer PHPCS avertissements à l'aide de commentaires?

Mon TestMyClass.php a deux définitions de classes dans le même fichier (tests unitaires de la classe), et PHP Code Sniffer se plaint chaque classe doit être dans un fichier lui-même. Comment puis-je supprimer cette alerte?

class MyClassImpl implements MyInterface
{
    //...
}

class MyClassTest extends \PHPUnit_Framework_TestCase
{
    //...
}
InformationsquelleAutor gremo | 2013-04-16
  1. 73

    Vous pouvez obtenir PHP_CodeSniffer d'ignorer des fichiers spécifiques ou des lignes dans un fichier à l'aide de commentaires: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Advanced-Usage#ignoring-files-and-folders

    Dans ce cas, l'erreur sera généré sur votre deuxième définition de la classe, de sorte que vous auriez à vous écrire seconde définition comme ceci:

    //@codingStandardsIgnoreStart
class MyClassTest extends \PHPUnit_Framework_TestCase
{
    //@codingStandardsIgnoreEnd
    //...
}

    Mais vous pouvez aussi choisir de simplement ignorer l'ensemble du fichier si il n'est pas censé être vérifiée, soit à l'aide de @codingStandardsIgnoreFile commentaire ou en spécifiant les exclusions sur la ligne de commande (voir le lien précédent pour info).

    Si vous trouvez que vous faire beaucoup et vous ne voulez pas d'ajouter des commentaires dans votre code, vous pouvez également créer votre propre norme de codage. En supposant que vous utilisez le PSR2 norme maintenant, vous devez créer un fichier XML (par exemple, mystandard.xml) et inclure le contenu suivant:

    <?xml version="1.0"?>
<ruleset name="MyStandard">
 <description>My custom coding standard.</description>
 <rule ref="PSR2" />
 <rule ref="PSR1.Classes.ClassDeclaration.MultipleClasses">
   <severity>0</severity>
 </rule>
</ruleset>

    Puis exécutez PHP_CodeSniffer comme ceci: phpcs --standard=/path/to/mystandard.xml /path/to/code

    Avoir votre propre jeu de règles vous permet de faire beaucoup de choses, y compris la modification des messages d'erreur, la modification de la gravité ou de la nature d'un message, y compris les vérifications d'autres normes, et au niveau mondial ignorer les règles. Plus d'infos ici: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-ruleset.xml

    • +1 pour sauter les fichiers de test. Ou peut-être vous pouvez utiliser le PHPUnitStandard pour ceux-ci: -)
    • À partir de la documentation: Vous pouvez également ignorer une seule ligne à l'aide de la @codingStandardsIgnoreLine commentaire. Ce commentaire va ignorer la ligne que le commentaire est sur, et la ligne suivante.
    • Notez que la syntaxe a changé aujourd'hui. Le @codingStandards notation a été abandonné et remplacé par //phpcs:disable etc. Le lien ci-dessus fonctionne encore et traite de la nouvelle syntaxe.
    InformationsquelleAutor Greg Sherwood
  2. 7

    La @codingStandards syntaxe est obsolète depuis la version 3.2.0, utilisez phpcs à la place.

    Quelques exemples:

    //phpcs:disable
//phpcs:ignore
//phpcs:enable

    Voir cette page pour plus d'informations: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Advanced-Usage#ignoring-parts-of-a-file

    InformationsquelleAutor Will
  3. 0

    Ce qui a été légèrement modifié. Utilisation phpcs:ignoreFile pour phpcs 3.2.x

    /* phpcs:ignoreFile */

    De la squizlabs de la documentation liée par Ahmad:

    Remarque: Avant de PHP_CodeSniffer la version 3.2.0, utilisez //
    @codingStandardsIgnoreFile au lieu de //phpcs:ignoreFile. L'
    @codingStandards syntaxe est obsolète et sera supprimée dans
    PHP_CodeSniffer version 4.0.

    InformationsquelleAutor RevNoah