Repolode
JLLeitschuh

JLLeitschuh/ktlint-gradle

Un plugin de Gradle que integra ktlint para añadir tareas de comprobación y formato automático a proyectos Kotlin.

Estrellas
1,723
Forks
185
Issues abiertos
126
Último commit
hace 12 horas

¿Qué es?

ktlint-gradle es un plugin de Gradle que integra el linter y formateador de Kotlin ktlint. Añade tareas listas para usar a la compilación de Gradle para comprobar y corregir el estilo del código sin configuración manual. Solo se activa en proyectos que aplican un plugin de Kotlin, por lo que se ocupa del código Kotlin y no de archivos arbitrarios.

El plugin crea tareas de comprobación y formato para cada conjunto de fuentes, además de las tareas ktlintCheck y ktlintFormat para todo el proyecto, y también procesa archivos de script Kotlin. Es compatible con los plugins kotlin, kotlin-android, kotlin-multiplatform y Kotlin JS, y se puede aplicar mediante el bloque plugins, un catálogo de versiones o el método apply heredado.

La configuración incluye la versión de ktlint, archivos baseline, reporters y conjuntos de reglas personalizados, filtros de archivos y el tamaño del heap de los workers. El plugin también puede instalar hooks Git pre-commit que ejecutan ktlint check o format en los archivos preparados para el commit.

Funciones clave

  • 01Añade las tareas ktlintCheck y ktlintFormat para todos los conjuntos de fuentes y los scripts Kotlin.
  • 02Es compatible con proyectos kotlin, kotlin-android, kotlin-multiplatform y Kotlin JS.
  • 03Permite usar un archivo baseline para suprimir infracciones de lint existentes.
  • 04Admite reporters y conjuntos de reglas de ktlint personalizados.
  • 05Puede instalar hooks Git pre-commit para comprobar o dar formato a los archivos preparados para el commit.

Casos de uso

  • Aplicar un estilo de código Kotlin uniforme en compilaciones de Gradle para Android o JVM.
  • Añadir comprobaciones de lint a un proyecto Kotlin multiplataforma sin modificar manualmente la lógica de compilación.
  • Incorporar lint de forma gradual a una base de código heredada mediante un baseline.
  • Ejecutar comprobaciones de estilo en CI mediante la tarea ktlintCheck.

Inicio rápido

  1. 1

    Añade el plugin al bloque plugins del script de compilación (configura la versión en la versión actual).

  2. 2

    Añade mavenCentral() a repositories para poder descargar KtLint.

  3. 3

    Ejecuta las tareas ktlint de Gradle en tu proyecto.

Antes de usarlo

  • El plugin solo se activa en proyectos que aplican un plugin de Kotlin compatible.
  • Requiere Gradle 7.4 o posterior y Kotlin 1.4 o posterior.

Temas

Preguntas frecuentes

¿Qué es ktlint-gradle?
Un plugin de Gradle que integra ktlint para añadir tareas de comprobación y formato automático a proyectos Kotlin. ktlint-gradle es un plugin de Gradle que integra el linter y formateador de Kotlin ktlint. Añade tareas listas para usar a la compilación de Gradle para comprobar y corregir el estilo del código sin configuración manual. Solo se activa en proyectos que aplican un plugin de Kotlin, por lo que se ocupa del código Kotlin y no de archivos arbitrarios.
¿ktlint-gradle es gratuito? ¿Qué licencia tiene?
ktlint-gradle es open source bajo la licencia MIT. Revisa los términos de la licencia antes de usarlo en productos comerciales.
¿ktlint-gradle sigue mantenido?
Mantenimiento activo. El último commit de ktlint-gradle fue el 6 nov 2026.
¿Para qué puedo usar ktlint-gradle?
Aplicar un estilo de código Kotlin uniforme en compilaciones de Gradle para Android o JVM. Añadir comprobaciones de lint a un proyecto Kotlin multiplataforma sin modificar manualmente la lógica de compilación. Incorporar lint de forma gradual a una base de código heredada mediante un baseline. Ejecutar comprobaciones de estilo en CI mediante la tarea ktlintCheck.
¿Cómo se instala ktlint-gradle?
Añade el plugin al bloque plugins del script de compilación (configura la versión en la versión actual). Añade mavenCentral() a repositories para poder descargar KtLint. Ejecuta las tareas ktlint de Gradle en tu proyecto.
¿Dónde consigo ktlint-gradle?
El código fuente y las instrucciones de instalación están en GitHub: https://github.com/JLLeitschuh/ktlint-gradle

Resumen generado por IA a partir del README del proyecto. Las estadísticas de GitHub se actualizan a diario.

Proyectos relacionados