Detekt para Kotlin: guía completa con ejemplos prácticos

1. ¿Qué es Detekt y por qué usarlo?

Detekt es una potente herramienta de análisis estático de código para el lenguaje Kotlin, creada por Arturbosch y mantenida por la comunidad. Está diseñada para detectar automáticamente problemas potenciales, "olores de código" (code smells), violaciones de convenciones de estilo y vulnerabilidades en proyectos Kotlin. Detekt opera a nivel del árbol sintáctico abstracto (AST), lo que le permite analizar el código en mayor profundidad que los linters de texto simples. La herramienta se integra con sistemas de compilación como Gradle, Maven y otras herramientas CI/CD, convirtiéndose en un recurso indispensable para mantener la calidad del código en el desarrollo en equipo.

¿Por qué necesitas Detekt? Primero, automatiza la verificación del código contra las Kotlin Coding Conventions, algo crucial en proyectos grandes con múltiples desarrolladores. Segundo, Detekt ayuda a identificar errores potenciales en etapas tempranas: por ejemplo, variables no utilizadas, posibles NullPointerException, estructuras condicionales complejas y otros problemas que podrían causar fallos en tiempo de ejecución. Tercero, la herramienta fomenta la refactorización: resalta secciones de código con alta complejidad ciclomática, funciones largas, operadores Elvis redundantes y otros patrones que perjudican la legibilidad y el mantenimiento del código.

Detekt ofrece más de 150 reglas integradas, organizadas en categorías: errores potenciales (potential bugs), estilo de código (style), rendimiento (performance), complejidad (complexity), excepciones (exceptions) y más. Además, la herramienta es totalmente configurable: puedes activar/desactivar reglas individuales, ajustar sus umbrales e incluso escribir tus propias reglas en Kotlin. Detekt admite la generación de informes en formatos HTML, XML, SARIF y texto, lo que permite integrarlo con cualquier sistema de análisis de código.

2. Instalación

Detekt se instala como un plugin para el sistema de compilación Gradle (método recomendado) o como una herramienta CLI independiente. A continuación se muestran los comandos exactos para la instalación.

Instalación mediante Gradle (plugin)

Añade al archivo build.gradle.kts (o build.gradle):

// build.gradle.kts
plugins {
    id("io.gitlab.arturbosch.detekt") version "1.23.6" // versión actual al momento de escribir
}

// Configuración de Detekt (opcional)
detekt {
    buildUponDefaultConfig = true // usar reglas estándar + las propias
    allRules = false // no incluir todas las reglas (solo las recomendadas)
    config.setFrom("$projectDir/config/detekt/detekt.yml") // ruta al archivo de configuración
    baseline = file("$projectDir/config/detekt/baseline.xml") // baseline para ignorar errores
    reports {
        html.required.set(true) // generar informe HTML
        xml.required.set(true) // generar informe XML
        txt.required.set(true) // generar informe de texto
    }
}

Después de añadir el plugin, ejecuta el comando:

./gradlew detekt

Instalación mediante CLI (Homebrew para macOS/Linux)

brew install detekt

Instalación mediante SDKMAN

sdk install detekt

Instalación mediante JAR (método universal)

curl -sSLO https://github.com/detekt/detekt/releases/download/v1.23.6/detekt-cli-1.23.6-all.jar
alias detekt='java -jar detekt-cli-1.23.6-all.jar'

3. Inicio rápido — ejemplo mínimo funcional

Crea un archivo Kotlin simple src/main/kotlin/ejemplo.kt:

// ejemplo.kt
fun main() {
    val x = 1
    val y = 2
    if (x > 0) {
        println("Positivo")
    } else {
        println("No positivo")
    }
    println("Suma: ${x + y}")
}

Crea un archivo de configuración config/detekt/detekt.yml:

# config/detekt/detekt.yml
build:
  maxIssues: 10

style:
  active: true
  MaxLineLength:
    active: true
    maxLineLength: 120

complexity:
  active: true
  TooManyFunctions:
    active: true
    thresholdInFiles: 10
    thresholdInClasses: 10
    thresholdInInterfaces: 10
    thresholdInObjects: 10
    thresholdInEnums: 10
    ignoreDeprecated: false
    ignorePrivate: false
    ignoreOverridden: false

Ejecuta Detekt:

./gradlew detekt

Si todo está configurado correctamente, verás un informe en la consola y archivos de reporte en build/reports/detekt/.

4. Métodos principales y ejemplos de uso

4.1. Reglas de estilo (Style)

Detekt incluye reglas para garantizar un estilo de código consistente. Por ejemplo, la regla MaxLineLength verifica que ninguna línea supere una longitud determinada:

// Código que viola MaxLineLength
fun ejemploFuncionConLineaLarga() {
    println("Esta es una línea extremadamente larga que supera el límite de 120 caracteres y debería ser dividida en varias líneas más cortas para mejorar la legibilidad")
}

Detekt reportará esta línea como una infracción. La solución es dividir la cadena:

fun ejemploFuncionConLineaCorregida() {
    println(
        "Esta es una línea que ahora respeta el límite de 120 caracteres " +
        "y se ha dividido en varias líneas para mejorar la legibilidad"
    )
}

4.2. Reglas de complejidad (Complexity)

La regla TooManyFunctions ayuda a mantener las clases con un número razonable de métodos. Por ejemplo:

// Clase que viola TooManyFunctions (más de 10 funciones)
class GestorDeUsuarios {
    fun crearUsuario() {}
    fun actualizarUsuario() {}
    fun eliminarUsuario() {}
    fun obtenerUsuario() {}
    fun listarUsuarios() {}
    fun buscarUsuarios() {}
    fun validarEmail() {}
    fun validarTelefono() {}
    fun enviarNotificacion() {}
    fun generarReporte() {}
    fun exportarCSV() {} // Esta función dispara la regla
}

La solución es dividir la clase en varias clases más pequeñas y enfocadas:

class GestorDeUsuarios {
    fun crearUsuario() {}
    fun actualizarUsuario() {}
    fun eliminarUsuario() {}
    fun obtenerUsuario() {}
    fun listarUsuarios() {}
    fun buscarUsuarios() {}
}

class ValidadorDeUsuarios {
    fun validarEmail() {}
    fun validarTelefono() {}
}

class NotificadorDeUsuarios {
    fun enviarNotificacion() {}
}

class ExportadorDeUsuarios {
    fun generarReporte() {}
    fun exportarCSV() {}
}

4.3. Reglas de rendimiento (Performance)

La regla SpreadOperator detecta el uso innecesario del operador de propagación (*) en arrays, que puede afectar el rendimiento:

// Código ineficiente
fun imprimirElementos(elementos: Array<String>) {
    println(Arrays.toString(elementos)) // Mejor usar contentToString()
}

// Código optimizado
fun imprimirElementosOptimizado(elementos: Array<String>) {
    println(elementos.contentToString())
}

4.4. Reglas de posibles errores (Potential Bugs)

La regla UnreachableCode detecta código que nunca se ejecutará:

fun ejemploConCodigoInalcanzable(): Int {
    return 42
    println("Este código nunca se ejecutará") // Detekt lo marcará como error
}

5. Configuración avanzada

Detekt permite una configuración detallada mediante archivos YAML. Puedes crear configuraciones personalizadas para diferentes módulos o entornos (desarrollo, pruebas, producción). Ejemplo de configuración avanzada:

# config/detekt/detekt-personalizado.yml
build:
  maxIssues: 0 # No se permiten infracciones

config:
  validation: true
  excludes: ['**/test/**', '**/build/**']

processors:
  active: true
  exclude: ['FunctionCountProcessor']

console-reports:
  active: true
  exclude:
    - 'ProjectStatisticsReport'
    - 'ComplexityReport'
    - 'NotificationReport'
    - 'FindingsReport'
    - 'FileBasedInfoReport'

output-reports:
  active: true
  exclude:
    - 'HtmlOutputReport'
    - 'XmlOutputReport'
    - 'TxtOutputReport'
    - 'SarifOutputReport'

6. Integración con CI/CD

Detekt se integra fácilmente con pipelines de CI/CD. Ejemplo para GitHub Actions:

# .github/workflows/detekt.yml
name: Detekt Analysis

on:
  push:
    branches: [ main, develop ]
  pull_request:
    branches: [ main ]

jobs:
  detekt:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Set up JDK 17
        uses: actions/setup-java@v4
        with:
          java-version: '17'
          distribution: 'temurin'
      - name: Run Detekt
        run: ./gradlew detekt
      - name: Upload Detekt Report
        uses: actions/upload-artifact@v4
        if: always()
        with:
          name: detekt-report
          path: build/reports/detekt/

7. Conclusión

Detekt es una herramienta esencial para cualquier desarrollador Kotlin que busque mantener un código limpio, seguro y eficiente. Con más de 150 reglas configurables, integración sencilla con Gradle y CI/CD, y la capacidad de crear reglas personalizadas, Detekt se adapta a proyectos de cualquier tamaño. Implementar Detekt en tu flujo de trabajo te ayudará a detectar problemas temprano, reducir la deuda técnica y mejorar la colaboración en equipo. ¡Comienza hoy mismo y eleva la calidad de tu código Kotlin!