PHP_CodeSniffer
3.7.2
Avertissement
Ce référentiel a été abandonné. Son successeur est phpcsstandards / php_codesniffer
Voir le numéro # 3932 pour plus d'informations.
Php_codesniffer est un ensemble de deux scripts PHP; Le script phpcs principal qui tokenise les fichiers PHP, JavaScript et CSS pour détecter les violations d'une norme de codage définie et un deuxième script phpcbf pour corriger automatiquement les violations des normes de codage. Php_codesniffer est un outil de développement essentiel qui garantit que votre code reste propre et cohérent.
PHP_codesniffer nécessite PHP version 5.4.0 ou plus, bien que les reniflements individuels puissent avoir des exigences supplémentaires telles que les applications externes et les scripts. Voir la page du manuel Options de configuration pour une liste de ces exigences.
Si vous utilisez PHP_CODESNIFFER dans le cadre d'une équipe ou que vous l'exécutez sur un serveur CI, vous pouvez configurer les paramètres de votre projet à l'aide d'un fichier de configuration.
La façon la plus simple de commencer avec php_codesniffer est de télécharger les fichiers phar pour chacune des commandes:
# 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 vous utilisez Composer, vous pouvez installer PHP_CODESNIFFER à l'échelle du système avec la commande suivante:
Composer Global nécessite "SquizLabs / Php_codesniffer = *"
Assurez-vous d'avoir le composeur Bin Dir sur votre chemin. La valeur par défaut est ~/.composer/vendor/bin/ , mais vous pouvez vérifier la valeur que vous devez utiliser en exécutant composer global config bin-dir --absolute .
Ou alternativement, incluez une dépendance pour squizlabs/php_codesniffer dans votre fichier composer.json . Par exemple:
{"requi-dev": {"SquizLabs / php_codesniffer": "3. *"}
}Vous pourrez alors exécuter PHP_CODESNIFFER à partir du répertoire du bac du fournisseur:
./Vendor/bin/Phpcs -h ./vendor/bin/phpcbf -h
Si vous utilisez PHIVE, vous pouvez installer PHP_CODESNIFFER comme outil de projet à l'aide des commandes suivantes:
PHIVE installer des phpcs PHIVE INSTALLATION PHPCBF
Vous pourrez alors exécuter Php_codesniffer à partir du répertoire des outils:
./tools/phpcs -h ./tools/phpcbf -h
Si vous utilisez Pear, vous pouvez installer PHP_CODESNIFFER à l'aide du programme d'installation de Pear. Cela mettra les commandes phpcs et phpcbf immédiatement disponibles pour une utilisation. Pour installer PHP_CODESNIFFER à l'aide du programme d'installation de Pear, assurez-vous d'abord que vous avez installé PEAR, puis exécutez la commande suivante:
Installer php_codesniffer
Vous pouvez également télécharger la source php_codesniffer et exécuter les commandes phpcs et phpcbf directement à partir du clone Git:
git clone https://github.com/squizlabs/php_codesniffer.gitcd php_codesniffer php bac / phpcs -h php bac / phpcbf -h
La norme de codage par défaut utilisée par Php_codesniffer est la norme de codage de poire. Pour vérifier un fichier par rapport à la norme de codage de poire, spécifiez simplement l'emplacement du fichier:
phpcs /path/to/code/myfile.php
Ou si vous souhaitez vérifier un répertoire entier, vous pouvez spécifier l'emplacement du répertoire au lieu d'un fichier.
phpcs / path / to / code-directory
Si vous souhaitez vérifier votre code par rapport à la norme de codage PSR-12, utilisez l'argument de la ligne de commande --standard :
phpcs --standard = psr12 / path / to / code-directory
Si php_codesniffer trouve des erreurs standard de codage, un rapport sera affiché après l'exécution de la commande.
Les informations d'utilisation complètes et les rapports d'exemples sont disponibles sur la page d'utilisation.
La documentation pour PHP_CODESNIFFER est disponible sur le Wiki GitHub.
Les rapports de bogues et les demandes de fonctionnalités peuvent être soumis sur le suivi du problème GitHub.
Voir contribution.md pour plus d'informations.
Php_codesniffer utilise un format de numéro de version MAJOR.MINOR.PATCH .
La version MAJOR est incrémentée lorsque:
Des modifications incompatibles vers l'arrière sont apportées à la façon dont les commandes phpcs ou phpcbf sont utilisées, ou
Des modifications incompatibles à l'arrière sont apportées au format ruleset.xml , ou
Des modifications incompatibles à l'arrière sont apportées à l'API utilisée par les développeurs Sniff, ou
Les types de jetons PHP_CODESNIFFER personnalisés sont supprimés, ou
Les reniflements existants sont supprimés entièrement de PHP_CODESNIFFER
La version MINOR est incrémentée lorsque:
De nouvelles fonctionnalités compatibles vers l'arrière sont ajoutées aux commandes phpcs et phpcbf , ou
Des modifications compatibles vers l'arrière sont apportées au format ruleset.xml , ou
Des modifications compatibles vers l'arrière sont apportées à l'API utilisée par les développeurs Sniff, ou
De nouveaux reniflements sont ajoutés à une norme incluse, ou
Les reniflements existants sont supprimés d'une norme incluse
Remarque: les modifications compatibles vers l'arrière de l'API utilisées par les développeurs Sniff permettra à un reniflement existant de continuer à fonctionner sans produire d'erreurs fatales, mais peuvent ne pas entraîner le reniflement des mêmes erreurs qu'auparavant sans que des modifications soient nécessaires.
La version PATCH est incrémentée lorsque:
Des correctifs de bogue compatibles vers l'arrière sont effectués
Remarque: comme PHP_CODESNIFFER existe pour signaler et résoudre les problèmes, la plupart des bogues sont le résultat de codage des erreurs standard qui sont mal rapportées ou de codage des erreurs standard qui ne sont pas signalées lorsqu'ils devraient l'être. Cela signifie que les messages produits par PHP_CODESNIFFER, et les correctifs qu'il fait, sont susceptibles d'être différents entre les versions de patch.
