Tutoriel d'installation et d'utilisation de PHP_CodeSniffer (outil de spécification d'inspection automatique de code)

Nous prêtons tous attention aux spécifications du code dans notre développement. Si vous êtes un développeur individuel, il vous suffit de comprendre si le code est standardisé ou non, mais en collaboration en équipe. , les réglementations du code sont particulièrement importantes. Ci-dessous, nous présentons PHP_CodeSniffer, un outil qui vérifie automatiquement les spécifications du code.

PHP_CodeSniffer est un outil de vérification automatisé des spécifications de code PHP.

CodeSniffer a intégré plusieurs ensembles de spécifications de code telles que MySource, PEAR, PHPCS, PSR1, PSR2, Squiz et Zend.

Bien sûr, vous pouvez également ajouter vos propres spécifications de code.

Adresse de l'entrepôt PHP_CodeSniffer : https://github.com/squizlabs/PHP_CodeSniffer

Adresse de la version PHP_CodeSniffer : http://pear.php.net/package/PHP_CodeSniffer

PHP_CodeSniffer contient deux outils, phpcs est utilisé pour vérifier les spécifications du code et phpcbf est utilisé pour corriger les spécifications du code.

1 Installation

PHP_CodeSniffer dispose de plusieurs méthodes d'installation.

1.1 Installation par fichier exécutable

Utilisez la commande git pour télécharger (ou télécharger directement) le code source de l'entrepôt, puis exécutez-le directement :

git clone https://github.com/squizlabs/PHP_CodeSniffer.git<br/>cd PHP_CodeSniffer<br/>php bin/phpcs -h<br/>php bin/phpcbf -h<br/>

Pour utiliser non La dernière version peut être téléchargée depuis PEAR à l'adresse : http://pear.php.net/package/PHP_CodeSniffer/download

Par exemple, si vous souhaitez utiliser 2.9.1, après en téléchargeant PEAR et en le décompressant, la commande à exécuter est :

php scripts/phpcs -h<br/>php scripts/phpcbf -h<br/>

La différence avec githuh download est que le fichier d'exécution est dans le répertoire des scripts.

Méthode d'installation du fichier phar 1.2

phar est une archive php, qui regroupe les fichiers php dans un seul fichier pour le service.

Le système Linux utilise la commande pour télécharger le fichier phar :

curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar<br/>curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcbf.phar<br/>

Pour le système Windows, utilisez le navigateur pour accéder aux deux liens ci-dessus et téléchargez les deux fichiers phar.

Ensuite, exécutez dans le répertoire du fichier phar :

php phpcs.phar -h<br/>php phpcbf.phar -h<br/>

Vous pouvez voir les informations d'aide de phpcs et phpcbf, indiquant que l'installation est réussie.

Remarque :

Cette méthode doit garantir que le fichier exécutable php a été ajouté à l'environnement PATH, sinon le répertoire absolu doit être spécifié

Ces deux doivent être ajoutés chacun fois qu'il est exécuté. fichier phar dans le répertoire correspondant, puis exécutez la commande de ligne php phpcs.phar xxx dans ce répertoire

Méthode d'installation 1.3 pear

Si poire est installé localement (méthode d'installation pear), vous pouvez également installer PHP_CodeSniffer via pear, commande :

pear install PHP_CodeSniffer<br/>

Après l'installation via pear, le fichier de spécification CodeSniffer sera installé dans : /path/to/pear/PHP/CodeSniffer /src/Normes.

Méthode d'installation de Composer 1.4

L'installation de Composer est également très pratique, une seule commande :

composer global require "squizlabs/php_codesniffer=*"<br/>

Remarque : La commande composer est requise ici pour être dans la variable d'environnement PATH.

peut également être utilisé dans le fichier composer.json :

{<br/>    "require-dev": {<br/>        "squizlabs/php_codesniffer": "3.*"<br/>    }<br/>}<br/>

Exécuter la commande une fois terminée :

./vendor/bin/phpcs -h<br/>./vendor/bin/phpcbf -h<br/>

1.5 Configurer phpcs et l'exécuter directement dans la commande line

Parmi les méthodes ci-dessus, à l'exception de la méthode d'installation pear, si vous souhaitez exécuter la commande phpcs dans d'autres méthodes, vous devez ajouter php devant.

S'il est fourni par Linux, car le chemin du fichier d'exécution php est déjà dans le PATH de l'environnement, ajoutez donc le chemin bin (ou les scripts) au PATH et vous pourrez exécuter la commande phpcs dans le terminal.

Mais dans le système Windows, le fichier phpcs.bat est en fait exécuté, et ce fichier fait référence au fichier phpcs dans le même répertoire.

Dans phpcs.bat, nous devons configurer deux variables pour exécuter correctement la commande phpcs dans CMD.

Comme suit, vous devez spécifier l'emplacement absolu des fichiers php.exe et phpcs :

if "%PHPBIN%" == "" set PHPBIN=D:\php56n\php.exe<br/>if not exist "%PHPBIN%" if "%PHP_PEAR_PHP_BIN%" neq "" goto USE_PEAR_PATH<br/>GOTO RUN<br/>:USE_PEAR_PATH<br/>set PHPBIN=%PHP_PEAR_PHP_BIN%<br/>:RUN<br/>"%PHPBIN%" "D:\www\PHP_CodeSniffer-2.9.1\scripts\phpcs" %*<br/>

Ajoutez ensuite le chemin D : wwwPHP_CodeSniffer-2.9.1scripts à PATH, et vous pourrez exécuter phpcs dans CMD.

Remarque : PHPCBF nécessite également une telle modification.

2 Utilisation de

Ci-dessus, nous voyons que PHP_CodeSniffer a deux commandes.

Par défaut, PHP_CodeSniffer utilise la spécification PEAR pour inspecter le code.

2.1 Utilisez la commande

La commande suivante utilise la spécification par défaut pour vérifier les fichiers et les répertoires.

$ phpcs /path/to/code/myfile.php                        # 检查文件<br/>$ phpcs /path/to/code                                   # 检查目录和子目录下的所有文件<br/>$ phpcs -l /path/to/code                                # 检查目录下的所有文件，不包括子目录<br/>$ phpcs /path/to/code/myfile.inc /path/to/code/my_dir   # 检查文件和目录<br/>

2.2 Résultats de la vérification

Par défaut, les résultats de la vérification incluent les erreurs et les avertissements, comme suit :

$ phpcs /path/to/code/myfile.php<br/>FILE: /path/to/code/myfile.php<br/>--------------------------------------------------------------------------------<br/>FOUND 5 ERROR(S) AND 1 WARNING(S) AFFECTING 5 LINE(S)<br/>--------------------------------------------------------------------------------<br/>  2 | ERROR   | Missing file doc comment<br/> 20 | ERROR   | PHP keywords must be lowercase; expected "false" but found<br/>    |         | "FALSE"<br/> 47 | ERROR   | Line not indented correctly; expected 4 spaces but found 1<br/> 47 | WARNING | Equals sign not aligned with surrounding assignments<br/> 51 | ERROR   | Missing function doc comment<br/> 88 | ERROR   | Line not indented correctly; expected 9 spaces but found 6<br/>--------------------------------------------------------------------------------<br/>

Si vous ne souhaitez pas afficher avertissements, ajoutez - n paramètre :

$ phpcs -n /path/to/code/myfile.php<br/>

Afficher uniquement le résumé des résultats de l'inspection :

$ phpcs --report=summary /path/to/code<br/>

2.3 Spécifier les spécifications

Vous pouvez utiliser le -- paramètre standard pour préciser une ou plusieurs spécifications Venez le découvrir.

$ phpcs --standard=PEAR /path/to/code/myfile.inc                      # 使用内置规范<br/>$ phpcs --standard=/path/to/MyStandard /path/to/code/myfile.inc       # 使用指定路径下的规范<br/>$ phpcs --standard=PEAR,PHPCS,/path/to/MyStandard file.php            # 使用多个规范<br/>$ phpcs --config-set default_standard Squiz                           # 修改默认规范为Squiz（原本是PEAR）<br/>

Afficher les spécifications existantes :

$ phpcs -i<br/>

2.4 Afficher l'aide

$ phpcs -h<br/>

Pour plus de connaissances sur PHP, veuillez visiter le Site Web PHP chinois!

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!