Analisador estático de Detekt para Kotlin

É hora de amar os analisadores estáticos! Conheça Detekt em Kotlin

Se você já sabe o que será discutido e está interessado apenas em implementar o projeto, continue imediatamente para o ponto de instalação.

O que é isso?

Análise de software realizada (em oposição à análise dinâmica) sem execução real dos programas em estudo. Wikipedia

E, com suas próprias palavras, é uma ferramenta conveniente que ajuda você a cumprir as regras do bom código. Permitindo personalização muito flexível dos filtros pela definição de código incorreto. Que a cada lançamento gera um determinado relatório, incluindo estatísticas sobre conflitos detectados, informações sobre eles, que permitem determinar onde o conflito ocorreu e seu tipo.

Os analisadores estáticos facilitam o trabalho do revisor e geralmente economizam o tempo da equipe de desenvolvimento.

Suponha que tenhamos um bom PR, no entanto, o autor forneceu nomes que são muito longos para as variáveis, escreveu código que pode ser facilmente simplificado ou violado uma das muitas regras definidas no arquivo de configuração do Detekt, as regras não são complicadas, mas a revisão de código não passa nesse PR.
O autor terá que alternar novamente entre os projetos, assim como os revisores, tenho certeza de que a revisão repetida trará pouco prazer.

Automatize se for rápido e barato. C) Senso comum

O que são analisadores estáticos?

Para java:

• Find-bugs (Descontinuado em 2015)
• Spot bugs

Para Kotlin:

• Detekt
• Ktlint

Eu respondo à pergunta que surgiu em sua cabeça: os bugs no Kotlin não funcionam.

Introduzindo o Detekt no projeto

O Detect pode ser instalado de várias maneiras:

1. Plugin para AndroidStudio
2. Gradle

Eu acho que a configuração através do Gradle é mais flexível e estou falando sobre isso.

No site oficial, existem várias maneiras de instalar o Detekt no projeto, dependendo da versão do Gradle, seja um projeto Android. Mas, na minha experiência de implementar um projeto Android, algumas instruções não funcionam . No momento, o projeto está muito próximo da versão 1.0. A versão mais recente no momento da redação deste documento é o candidato a lançamento 1.0.0-RC14

Então

Vamos ao site oficial da Gradle e vemos as instruções de instalação.

buildscript { repositories { maven { url "https://plugins.gradle.org/m2/" } } dependencies { classpath "io.gitlab.arturbosch.detekt:detekt-gradle-plugin:1.0.0-RC14" } } 

É essa decisão que aconselho a aderir ao projeto Android.

Você provavelmente notou que removi a linha apply: plugin, pois aconselho a separar o Detekt em um arquivo separado e aplicar o aplicar já.

Etapa 1:

Portanto, copie esse código para o nível de aplicativo build.gradle.

Lá, no bloco allprojects, devemos escrever uma linha para aplicar nosso arquivo contendo as configurações detekt.

 allprojects { apply from: "$rootDir/detekt.gradle" repositories { maven { url "https://plugins.gradle.org/m2/" } } } 

Etapa 2:

Então você precisa criar o arquivo detekt.gradle

 apply plugin: "io.gitlab.arturbosch.detekt" detekt { toolVersion = "1.0.0-RC14" // Version of the Detekt CLI that will be used. When unspecified the latest detekt version found will be used. Override to stay on the same version. input = files("src/main/java") // The directories where detekt looks for input files. Defaults to `files("src/main/java", "src/main/kotlin")`. parallel = true // Builds the AST in parallel. Rules are always executed in parallel. Can lead to speedups in larger projects. `false` by default. filters = ".*build.*,.*/resources/.*,.*/tmp/.*" // Regular expression of paths that should be excluded separated by `;` or `,`. config = files("$rootDir/detekt-config.yml") // Define the detekt configuration(s) you want to use. Defaults to the default detekt configuration. reports { xml { enabled = true // Enable/Disable XML report (default: true) destination = file("build/reports/detekt.xml") // Path where XML report will be stored (default: `build/reports/detekt/detekt.xml`) } html { enabled = true // Enable/Disable HTML report (default: true) destination = file("build/reports/detekt.html") // Path where HTML report will be stored (default: `build/reports/detekt/detekt.html`) } } } 

Etapa 3:

Agora você precisa criar o arquivo de configuração detekt-config.yml

Este é um arquivo de configuração padrão do site oficial .

Etapa 4:

Abra um console e execute o comando: gradlew detekt

Isso é tudo!

Agora você tem estatísticas prontas para o seu projeto. Eles são exibidos no console e você também pode encontrá-los no caminho: {u_project} \ app \ build \ reports \ detekt

Em conclusão

É muito conveniente usar o Detekt ao construir em Jenkins
O tempo de execução da tarefa em um projeto com mais de 2000 classes é de 4-7 segundos *.

Quero dizer que o uso de um analisador estático simplifica um pouco o nosso trabalho. Acelera o processo de desenvolvimento e economiza dinheiro dos negócios.

Referências:

Detekt github
Configurar detekt
default-detekt-config.yml