software - checkstyle gradle

Generar el informe HTML de Checkstyle con Gradle

Question

Me gustaría obtener el resultado de ejecutar Checkstyle a través de Gradle como un informe HTML.

No he encontrado nada en la documentación del plugin Checkstyle .

He añadido lo siguiente a mi archivo build.gradle .

checkstyleTask {
    reports {
        html {
            destination "build/reports/checkstyle.html"
        }
    }
}

pero esto dio lugar

Lo que salió mal: se produjo un problema al evaluar el proyecto raíz ''MyProject''.

No se pudo encontrar el método checkstyleTask () para argumentos [build_1vu33nc0ekgtoo19jt e86o8o42 $ _run_closure8 @ 1d8ee20] en el proyecto raíz ''MyProject''.

¿Hay una manera de generar informes HTML de Checkstyle usando Gradle?

Gracias.

Answer 1

Así es como lo hago en un pequeño proyecto mío:

checkstyleMain << {
    ant.xslt(in: reports.xml.destination,
             style: new File(''config/checkstyle-noframes-sorted.xsl''),
             out: new File(reports.xml.destination.parent, ''main.html''))
}

Esto requiere que almacene el archivo checkstyle-noframes-sorted.xsl, desde el directorio contrib de la distribución binaria de estilo de comprobación, en el directorio config de su proyecto.

Sin embargo, si puede permitirse el lujo de ejecutar un servidor SonarQube, el uso del complemento de sonar conduce a una experiencia de usuario mucho mejor.

EDITAR: Lo anterior no funcionará si hay violaciones. Esto debería en todos los casos:

task checkstyleHtml << {
    ant.xslt(in: checkstyleMain.reports.xml.destination,
             style: file(''/config/checkstyle-noframes-sorted.xsl''),
             out: new File(checkstyleMain.reports.xml.destination.parent, ''main.html''))
}

checkstyleMain.finalizedBy checkstyleHtml

Answer 2

Para Gradle 2.10, agregue el siguiente código a su build.gradle :

tasks.withType(Checkstyle) {
  reports {
    html.enabled = true
  }
}

Answer 3

Parece que llego tarde a la fiesta. Pero aún publicando este pensamiento, podría ayudar a alguien más con el mismo problema.

Gradle 2.10 soporta la generación de informes de archivos html. Solo asegúrese de tener la versión configurada correctamente en su archivo gradle-wrapper.properties .

Después de eso, en su archivo build.gradle debería tener una configuración como la que se muestra a continuación.

apply plugin: ''checkstyle''

checkstyle {
    toolVersion = ''6.4.1''
    sourceSets = [sourceSets.main]
    configFile = rootProject.file("config/checkstyle/checkstyle.xml");
    showViolations = true
    ignoreFailures = true
}

checkstyleTest {
    enabled = false
}

tasks.withType(Checkstyle) {
  reports {
    html.destination rootProject.file("build/reports/checkstyle.html")
  }
}

Aquí, el config file es el archivo que tiene los módulos de estilo de verificación que desea utilizar y html.destination es la ubicación donde desea que se genere su informe html.

Answer 4

Here hay un complemento que hará que la configuración del estilo de verificación sea muy fácil. Establece automáticamente toda la configuración requerida para el estilo de verificación según su gusto y genera un informe HTML al final.

Todo lo que necesita hacer es agregar algunas líneas a su build.gradle y eso es todo. No es necesario crear archivos xml separados.

El plugin se llama estilo . Puede encontrar más detalles sobre cómo usarlo aquí: Here