Глава 59. Плагин Checkstyle.

Плагин Checkstyle выполняет проверки качества на исходных файлах Java вашего проекта с использованием Checkstyle и генерирует отчет по итогам этих проверок.

59.1. Использование.

Чтобы использовать плагин Checkstyle, включите следующую строчку в ваш сборочный скрипт:

Пример 59.1. Использование плагина Checkstyle

build.gradle

apply plugin: 'checkstyle'
	  

Плагин добавляет несколько задач к проекту, которые выполняют проверка качества. Вы можете выполнить проверки, запустив команду gradle check.

Обратите внимание на то, что Checkstyle будет запущен с той же версией Java, что использовалась для запуска Gradle.

59.2. Задачи.

Плагин Checkstyle добавляет следующие задачи к проекту:

Таблица 59.1. Плагин Checkstyle - задачи
Имя задачиЗависит отТипОписание
checkstyleMainclassesCheckstyleЗапускает Checkstyle на 'боевых' исходных файлах Java.
checkstyleTesttestClassesCheckstyleЗапускает Checkstyle на исходных файлах тестов Java.
checkstyleНаборИсходниковнаборИсходниковClassesCheckstyleЗапускает Checkstyle на исходных файлах Java данного набора исходников.

Плагин Checkstyle добавляет следующие зависимости к задачам, определенным плагином Java.

Таблица 59.2. Плагин Checkstyle - дополнительные зависимости задач
Имя задачиЗависит от
checkВсех задач Checkstyle, включая checkstyleMain и checkstyleTest.

59.3. Разметка проекта.

Плагин Checkstyle ожидает следующую разметку проекта:

Таблица 59.3. Плагин Checkstyle - разметка проекта
ФайлЗначение
config/checkstyle/checkstyle.xmlКонфигурационный файл Checkstyle.

59.4. Управление зависимостями.

Плагин Checkstyle добавляет следующие конфигурации зависимостей:

Таблица 59.4. Плагин Checkstyle - конфигурации зависимостей
ИмяЗначение
checkstyleИспользуемые библиотеки Checkstyle

59.5. Настройка.

Смотрите класс CheckstyleExtension в документации API.

59.6. Настройка вида HTML-отчета.

HTML-отчет, генерируемый задачей Checkstyle, можно настроить с использованием таблицы стилей XSLT, например, чтобы подсвечивать определенные ошибки или изменить их отображение:

Пример 59.2. Настройка вида HTML-отчета

build.gradle

tasks.withType(Checkstyle) {
    reports {
        xml.enabled false
        html.enabled true
        html.stylesheet resources.text.fromFile('config/xsl/checkstyle-custom.xsl')
    }
}
	  

Посмотреть образец таблицы стилей Checkstyle.