| Introduction (Previous) | (Next) Utilisation avancée | ||||
| |
|||||
|
|||||
Utilisation
Obtenir l'aide en ligne de commande
Executer PHP_CodeSniffer avec l'argument -h ou --help affichera une liste des commandes auxquelles PHP_CodeSniffer réponds. Le résultat obtenu par un phpcs -h est montré ci-dessous.
Usage: phpcs [-nwlvi] [--report=<report>] [--standard=<standard>]
[--config-set key value] [--config-delete key] [--config-show]
[--generator=<generator>] [--extensions=<extensions>]
[--ignore=<patterns>] [--tab-width=<width>] <file> ...
-n Do not print warnings
-w Print both warnings and errors (on by default)
-l Local directory only, no recursion
-v[v][v] Print verbose output
-i Show a list of installed coding standards
--help Print this help message
--version Print version information
<file> One or more files and/or directories to check
<extensions> A comma separated list of file extensions to check
(only valid if checking a directory)
<patterns> A comma separated list of patterns that are used
to ignore directories and files
<standard> The name of the coding standard to use
<width> The number of spaces each tab represents
<generator> The name of a doc generator to use
(forces doc generation instead of checking)
<report> Print either the "full", "xml" "checkstyle",
"csv" or "summary" report
(the "full" report is printed by default) |
Note : L'argument --standard est optionnel, even if you have more than one coding standard installed. Si vous ne spécifiez aucune norme, PHP_CodeSniffer utilisera la norme de codage de PEAR pour éffectuer la vérification, ou la norme que vous avec fixé par défaut. Voir les instructions pour fixer les valeur par défaut des règles codage.
Vérifier des fichiers et des dossiers
La manière la plus simple d'utiliser PHP_CodeSniffer est de donner l'emplacement du fichier ou du dossier à vérifier. Si un dossier est donné, PHP_CodeSniffer vérifiera tous les fichiers trouvés dans ce dossier et récursivement.
Note : Si vous ne désirez pas que les sous-dossiers soient pris en compte, utilisez l'argument -l pour forcer PHP_CodeSniffer à ne considerer que les fichiers directement dans le répertoire donné.
Dans l'exemple suivant, la première commande demande à PHP_CodeSniffer de vérifier les règles de codage sur le fichier mon_fichierfile.inc ensuite la seconde commande demande à PHP_CodeSniffer de vérifier tous les fichiers php dans le répertoire mon_repertoire.
Exemple 58-1. Vérifier un fichier ou tout un répertoire
|
Vous pouvez aussi spécifier plusieurs fichiers ou dossiers à vérifier. La commande qui suit dit à PHP_CodeSniffer de vérifier le fichier mon_fichier.inc et tous les fichiers du répertoire mon_repertoire.
Exemple 58-2. Vérifier plusieurs fichiers et dossiers
|
Une fois que PHP_CodeSniffer a terminé son traitement de vos fichiers, il affiche un rapport. Ce rapport liste les erreurs et alertes pour l'ensemble des fichiers qui ne respectent pas la norme. L'affichage est comme suit:
Exemple 58-3. Exemple de résultat de PHP_CodeSniffer
|
Si vous ne voulez pas que les avertissements soient inclus, ajoutez l'argument-n.
Exemple 58-4. Exemple d'utilisation de PHP_CodeSniffer sans avertissements
|
Obtenir un rapport sommaire
Par défaut, PHP_CodeSniffer affichera la liste complète de toutes les erreurs et avertissements qu'il trouve. Cette liste peut devenir longue particulièrement quand c'est une vérification d'un large nombre de fichiers en une fois. Pour afficher un rapport condensé qui ne montre que le nombre d'erreurs et de avertissements par fichier, utilisez l'argument --report=summary . L'affichage ressemblera alors à ceci:
Exemple 58-5. Exemple de rapport PHP_CodeSniffer abregé
|
Tout comme pour le rapport complet, vous pouvez demander d'ignorer les avertissements avec l'argument -n.
Exemple 58-6. Exemple de rapport résumé avec PHP_CodeSniffer sans warning
|
PHP_CodeSniffer verbeux
Par défaut, PHP_CodeSniffer s'execute sobrement, et se limite à l'affichage du rapport des erreurs et des alertes. Si vous vérifiez un large nombre de fichier, vous pouvez attendre un bout de temps avant d'obtenir le rapport. Si vous voulez savoir ce qui se passe pendant ce temps là, vous pouvez activer l'affichage des informations d'execution.
Avec l'affichage verbeux, PHP_CodeSniffer devrait imprimer le fichier en traitement, le nombre de "tokens" et de lignes que le fichier contient, et finalement la durée du traitement. L'affichage ressemble à ceci:
Exemple 58-7. Exemple de rapport PHP_CodeSniffer bavard
|
Spécifier la norme de codage
PHP_CodeSniffer peut avoir plusieurs normes de codage installés pour permettre à une seule installation de PHP_CodeSniffer d'être utilisé dans plusieurs projets aux normes différentes. Quand vous vérifiez du code PHP, PHP_CodeSniffer doit savoir quelle norme il doit utiliser. C'est ce qu'on fait avec l'argument --standard.
L'exemple suivant vérifie la fidélité du fichier mon_fichier.inc à la norme de codage PEAR (installé et utilisé par défaut).
Exemple 58-8. Indiquer la norme de codage à utiliser pour la validation
|
Afficher la liste des normes de codage installés
PHP_CodeSniffer peut affichier la liste des normes de codage qui sont installés. Vous pouvez donc donner correctement le nom de la norme à utiliser pour la vérification. Vous pouvez afficher cette liste en ajoutant l'argument -i.
Exemple 58-9. Générer la liste des normes installées
|
| Introduction (Previous) | (Next) Utilisation avancée | ||||||||
| |
|||||||||
|
|||||||||