PHPCodeSniffer HTML отчет?

Question

Генерирует ли PHPCodeSniffer отчет в формате HTML?

Если нет?Как?

В настоящее время я могу запустить PHPCodeSniffer, но он генерирует только XML-файл и отображает результаты в терминале.

Как создать отчет HTML, такой как отчет о покрытии и модульном тесте в phpunit.

В настоящее время я использую PHPCheckStyle, поскольку он генерирует html-отчет, но я также хочу попробовать PHPCodeSniffer, чтобы узнать, какой из них лучше.

Answer 1

Другое решение (но, возможно, не самое простое) заключается в использовании системы непрерывной интеграции , которая обеспечивает интеграцию анализатора кода PHP.

Например, phpUnderControl предоставляет удобный интерфейс для просмотра отчета.

Answer 2

Написание собственного отчета на самом деле довольно тривиально.

Если вы работаете из CLI, вы можете реализовать свой собственный класс отчета с уникальным методом и вызвать его из команды ligne. Для отчета с именем Xxx:

class PHP_CodeSniffer_Reports_Xxx implements PHP_CodeSniffer_Report
{ 

  /**
   * Prints all errors and warnings for each file processed.
   *
   * Errors and warnings are displayed together, grouped by file.
   *
   * @param array   $report      Prepared report.
   * @param boolean $showSources Show sources?
   * @param int     $width       Maximum allowed lne width.
   * @param boolean $toScreen    Is the report being printed to screen?
   *
   * @return string
   */
  public function generate(
      $report,
      $showSources=false,
      $width=80,
      $toScreen=true
  ) {
     ...
  }
}

Если вы работаете с веб-сервера, метод PHP_CodeSniffer.getFilesErrors() дает вам множество ошибок со всем, что вам нужно для создания отчета.

Answer 3

HTML отчеты пока не предоставляются.Однако есть обходной путь для выполнения работы.

Вы можете экспортировать отчет в XML и прочитать данные с помощью DOM Parser и самостоятельно создать HTML-версию. Вот краткое руководство по началу работы.

Answer 4

HTML Reporting работает для меня.Просто используйте в соответствии с --help:

phpcs src/AppBundle --generator=HTML > index.html

Показать результат в index.html