Gradle 4.4.1应用Checkstyle插件后执行check任务未生成HTML报告如何解决

原因说明 #

Gradle 4.4.1内置的Checkstyle插件默认开启了失败中断逻辑，只要检测到代码违规就会立即将任务标记为失败，终止后续执行流程，因此不会完成HTML报告的生成步骤。

解决方案 #

• 方案1：允许违规存在，始终生成报告
  在原有apply plugin: 'checkstyle'代码下方添加如下配置：

checkstyle {
    // 检测到违规时不中断任务执行
    ignoreFailures = true
    // 显式开启HTML格式报告生成
    reports {
        html.enabled = true
        // 不需要XML报告的话可以设为false
        xml.enabled = false
    }
}

配置完成后重新执行gradle check，报告将默认生成在项目的build/reports/checkstyle/目录下。

• 方案2：按违规级别控制是否中断
  如果不希望所有违规都不中断执行，仅允许低优先级违规时生成报告，可以通过阈值配置实现：

checkstyle {
    // ERROR级违规超过0个就中断任务
    maxErrors = 0
    // WARNING级违规阈值可自行调整，设置为极大值相当于不限制警告
    maxWarnings = 9999
    ignoreFailures = false
    reports {
        html.enabled = true
    }
}

该配置下只有出现ERROR级别的违规时才会中断任务，WARNING级别的违规不会中断，可正常生成报告。

内容的提问来源于stack exchange，提问作者Neo