codeclimate phpcodesniffer

Код климат PHP_CODESNIFFER ENGINE

codeclimate-phpcodesniffer -это кодовый климат-двигатель, который завершает инструмент статического анализа Sniffer PHP_CODE. Вы можете запустить его в своей командной строке, используя CODE CLIMAT CLI или на нашей хостированной платформе анализа.

Php_codesniffer помогает вам обнаружить нарушения определенного стандарта кодирования.

Установка

1. Если вы еще этого не сделали, установите климат CODE CLI.
2. Запустите codeclimate engines:enable phpcodesniffer . Эта команда оба устанавливает двигатель и позволяет ему в вашем файле .codeclimate.yml .
3. Вы готовы проанализировать! Зайдите в папку вашего проекта и запустите codeclimate analyze .

Параметры конфигурации

Форматируйте значения для этих параметров конфигурации в соответствии с документацией php_codesniffer.

• file_extensions - Здесь вы можете настроить расширения файлов для файлов, которые вы хотите проанализировать php_codesniffer.
• Стандарт - это список стандартов, которые вы хотите использовать при анализе ваших файлов. Вы можете при желании включить относительный путь к пользовательскому файлу правил PHPCS.xml.
• Ignore_warnings - вы можете скрыть предупреждения и сообщать только об ошибках с этой опцией.
• Кодирование-по умолчанию, PHPCS использует ISO-8859-1. Используйте это, чтобы изменить его на кодирование, например, UTF-8.

Пример конфигурации

 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"

Поддерживаемые стандарты кодирования

В дополнение к стандартам, предоставленным по умолчанию с php_codesniffer, поддерживаются стандарты кодирования Drupal, WordPress, YII2 и Magento расширения. Вот полный список:

• Drupal
• DrupalPractice
• Meqp1
• Meqp2
• Mysource
• ГРУША
• PHPCS
• PSR1
• PSR2
• Скис
• WordPress
• WordPress-Core
• WordPress-Docs
• WordPress-Extra
• WordPress-VIP
• Yii2
• Zend

Нужна помощь?

Для получения помощи с php_codesniffer, ознакомьтесь с их документацией.

Если вы сталкиваетесь с проблемой климата кода, сначала посмотрите на проблемы с GitHub этого проекта, так как ваш вопрос, возможно, уже был покрыт. Если нет, иди и откройте с нами билет на поддержку.