codeclimate phpcodesniffer

Code Klima PHP_CODESNIFFER Engine

codeclimate-phpcodesniffer ist eine Code-Klima-Engine, die das statische Analyse-Tool von PHP_CODE Sniffer umhüllt. Sie können es auf Ihrer Befehlszeile mit der Code -Klima -CLI oder auf unserer gehosteten Analyseplattform ausführen.

PHP_CODESNIFFER hilft Ihnen, Verstöße gegen einen definierten Codierungsstandard zu erkennen.

Installation

1. Wenn Sie es noch nicht getan haben, installieren Sie die Codeklima -CLI.
2. Run codeclimate engines:enable phpcodesniffer . Dieser Befehl installiert beide die Engine und ermöglicht es in Ihrer .codeclimate.yml -Datei.
3. Sie sind bereit zu analysieren! Suchen Sie in den Ordner Ihres Projekts und führen Sie codeclimate analyze aus.

Konfigurationsoptionen

Formatieren Sie die Werte für diese Konfigurationsoptionen pro Dokumentation von PHP_CODESNIFFER.

• Datei_extensions - Hier können Sie die Dateierweiterungen für die Dateien konfigurieren, die PHP_CODESNIFFER analysieren sollen.
• Standard - Dies ist die von der Komma abgrenzende Liste der Standards, die Sie bei der Analyse Ihrer Dateien verwenden sollen. Sie können optional einen relativen Pfad zu einer benutzerdefinierten PHPCS Ruleset.xml -Datei einfügen.
• Ignore_Warnings - Sie können Warnungen ausblenden und nur Fehler mit dieser Option melden.
• Codierung-Standardmäßig verwendet PHPCS ISO-8859-1. Verwenden Sie dies, um es in Ihre Codierung zu ändern, z. B. UTF-8.

Beispielkonfiguration

 exclude_paths:
 - "/examples/**/*"
engines:
  phpcodesniffer:
    enabled: true
    config:
      file_extensions: "php,inc,lib"
      standard: "PSR1,PSR2,my_custom_php_ruleset.xml"
      ignore_warnings: true
      encoding: utf-8
ratings:
  paths:
  - "**.php"

Unterstützte Codierungsstandards

Zusätzlich zu Standards, die standardmäßig mit PHP_CODESNIFFER bereitgestellt werden, werden die Drupal-, WordPress-, YII2- und Magento -Erweiterungscodierungsstandards unterstützt. Hier ist die vollständige Liste:

• Drupal
• Drupalpractice
• Meqp1
• Meqp2
• Mysource
• BIRNE
• PHPCS
• PSR1
• PSR2
• Squiz
• WordPress
• WordPress-Core
• WordPress-Docs
• WordPress-Extra
• WordPress-VIP
• Yii2
• Zend

Benötigen Sie Hilfe?

Für Hilfe bei PHP_CODESNIFFER finden Sie ihre Dokumentation.

Wenn Sie auf ein Code -Klimaproblem stoßen, schauen Sie sich zunächst die Github -Probleme dieses Projekts an, da Ihre Frage möglicherweise bereits behandelt wurde. Wenn nicht, eröffnen Sie mit uns ein Support -Ticket.