PHP_CodeSniffer
3.7.2
Warnung
Dieses Repository wurde aufgegeben. Sein Nachfolger ist phpcStandards/php_codesniffere
Weitere Informationen finden Sie in Ausgabe Nr. 3932.
PHP_CODESNIFER ist ein Satz von zwei PHP -Skripten; Das Haupt phpcs -Skript, das PHP-, JavaScript- und CSS -Dateien tokenisiert, um Verstöße gegen einen definierten Codierungsstandard zu erkennen, und ein zweites phpcbf -Skript, um die Verstöße gegen die Codierungsstandard automatisch zu korrigieren. PHP_CODESNIFER ist ein wesentliches Entwicklungstool, das sicherstellt, dass Ihr Code sauber und konsistent bleibt.
PHP_CODESNIFFER benötigt PHP Version 5.4.0 oder höher, obwohl einzelne Schnüffeln zusätzliche Anforderungen wie externe Anwendungen und Skripte haben können. Eine Liste dieser Anforderungen finden Sie auf der Seite "Konfigurationsoptionen".
Wenn Sie PHP_CODESNIFFER als Teil eines Teams verwenden oder es auf einem CI -Server ausführen, möchten Sie möglicherweise die Einstellungen Ihres Projekts mithilfe einer Konfigurationsdatei konfigurieren.
Der einfachste Weg, um mit PHP_CODESNIFFER zu beginnen, besteht darin, die Phar -Dateien für jeden der Befehle herunterzuladen:
# 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
Wenn Sie Composer verwenden, können Sie mit dem folgenden Befehl pHP_CODESNIFFER-systemweit installieren:
Composer Global erfordern "SquizLabs/PHP_CODESNIFFER =*"
Stellen Sie sicher, dass Sie den Komponisten Bin Dir in Ihrem Weg haben. Der Standardwert lautet ~/.composer/vendor/bin/ , aber Sie können den Wert überprüfen, den Sie verwenden müssen, indem Sie composer global config bin-dir --absolute ausführen.
Oder alternativ eine Abhängigkeit für squizlabs/php_codesniffer in Ihre composer.json -Datei. Zum Beispiel:
{"Required-dev": {"SquizLabs/php_codesniffer“: "3.*"}
}Sie können dann php_codesniffere aus dem Vendor Bin -Verzeichnis ausführen:
./vendor/bin/phpcs -h ./vendor/bin/phpcbf -h
Wenn Sie Phive verwenden, können Sie PHP_CODESNIFFER als Projekttool mit den folgenden Befehlen installieren:
Phive -PHPCS installieren Phive Installieren Sie PHPCBF
Anschließend können Sie php_codesniffere aus dem Tools -Verzeichnis ausführen:
./tools/phpcs -h ./tools/phpcbf -h
Wenn Sie PEAR verwenden, können Sie PHP_CODESNIFFER mithilfe des Pear Installers installieren. Dadurch werden die Befehle phpcs und phpcbf sofort zur Verfügung gestellt. So installieren Sie PHP_CODESNIFFER mithilfe des Birnen -Installationsprogramms zuerst, dass Sie Birne installiert haben und dann den folgenden Befehl ausführen:
BEAR INSTALLIERT PHP_CODESNIFER
Sie können auch die Quelle von PHP_CODESNIFFER herunterladen und die Befehle phpcs und phpcbf direkt aus dem Git -Klon ausführen:
Git Clone https://github.com/squizlabs/php_codesniffer.gitcd PHP_CODESNIFFER PHP bin/phpcs -h PHP bin/phpcbf -h
Der Standard -Codierungsstandard, der von PHP_CODESNIFFER verwendet wird, ist der Birnencodierungsstandard. Um eine Datei anhand des Birnencodierungsstandards zu überprüfen, geben Sie einfach den Punkt der Datei an:
PHPCS/PATH/TO/CODE/MYFILE.PHP
Wenn Sie ein ganzes Verzeichnis überprüfen möchten, können Sie den Verzeichnisspeicherort anstelle einer Datei angeben.
PHPCS/PATH/TO/CODE-DIRECTORY
Wenn Sie Ihren Code mit dem PSR-12-Codierungsstandard überprüfen möchten, verwenden Sie das Argument --standard -Befehlszeilen):
PHPCS-STANDARD = PSR12/PATH/TO/CODE-DIRECTORY
Wenn php_codesniffer irgendwelche Codierungsstandardfehler feststellt, wird nach dem Ausführen des Befehls ein Bericht angezeigt.
Auf der Nutzungsseite finden Sie vollständige Nutzungsinformationen und Beispielberichte.
Die Dokumentation für PHP_CODESNIFFER ist im Github -Wiki verfügbar.
Fehlerberichte und Feature -Anfragen können im GitHub -Problem Tracker gesendet werden.
Informationen finden Sie unter Beitrags.md für Informationen.
PHP_CODESNIFER verwendet ein MAJOR.MINOR.PATCH -Versionsnummernformat.
Die MAJOR wird erhöht, wenn:
rückwärts-inkompatible Änderungen werden vorgenommen, wie die Befehle phpcs oder phpcbf verwendet werden, oder
Rückwärts-inkompatible Änderungen werden am ruleset.xml -Format vorgenommen, oder
Rückwärts-inkompatible Änderungen werden an der API von Sniff-Entwicklern vorgenommen, oder
benutzerdefinierte typerne typen php_codesniffer werden entfernt, oder
Bestehende Sniffs werden vollständig aus php_codesniffer entfernt
Die MINOR wird inkrementiert, wenn:
Neue rückwärtskompatible Funktionen werden den Befehlen phpcs und phpcbf hinzugefügt, oder
Rückwärtskompatible Änderungen werden am ruleset.xml -Format vorgenommen, oder
Rückwärtskompatible Änderungen werden an der API vorgenommen, die von Schnupfenentwicklern verwendet wird, oder
Neuen Sniffs werden zu einem enthaltenen Standard hinzugefügt, oder
Bestehende Schnüffler werden aus einem enthaltenen Standard entfernt
Hinweis: Rückwärts-kompatible Änderungen an der von Sniff-Entwicklern verwendeten API ermöglichen es einem vorhandenen Schnupfen, weiter zu laufen, ohne tödliche Fehler zu erzeugen, aber möglicherweise nicht dazu führt, dass der Schnupfen die gleichen Fehler wie zuvor berichtete wie zuvor, ohne dass Änderungen erforderlich waren.
Die PATCH -Version wird erhöht, wenn:
Rückwärtskompatible Fehlerkorrekturen werden vorgenommen
HINWEIS: Da PHP_CODESNIFFER Probleme gibt, die Probleme berichten und beheben, sind die meisten Fehler das Ergebnis der kodierenden Standardfehler, die falsch gemeldet werden oder Standardfehler, die nicht gemeldet werden, wenn sie sein sollten. Dies bedeutet, dass die von PHP_CODESNIFFER erzeugten Nachrichten und die von ihnen vorgenommenen Korrekturen wahrscheinlich zwischen Patch -Versionen unterschiedlich sind.
