Formateo de código en Kotlin usando ktlint

Como todos sabemos, el lenguaje kotlin es recomendado por Google particularmente para el desarrollo de aplicaciones de Android y, por supuesto, facilitó la vida de los desarrolladores de aplicaciones de Android. Pero si es un principiante en este campo, es posible que no sepa que necesita escribir los códigos en el formato deseado. y definitivamente es útil para los desarrolladores, pero si no está familiarizado con cómo escribir código limpio usando Kotlin, entonces no se preocupe, no necesita aprender algo para lograrlo, en su lugar, solo tiene que usar ktlint que se usa para lo mismo objetivo.

ktlint : ktlint es un linter de Kotlin anti-bikeshedding con un formato incorporado. En palabras simples, verifica el estilo de nuestro código y también nos ayuda a formatear nuestro código y mejorar su comprensión.

Los beneficios de usarlo

• Ktlitn puede ahorrarte tiempo
• Puede ahorrar energía (porque no tiene que verificar manualmente el estilo de su código)
• Puede simplificar su proceso

¿Qué podemos hacer usando ktlint?

Antes de esto, hablemos de algunas cosas importantes como ktlint se divide en dos cosas.

1. herramienta de revestimiento: la herramienta de revestimiento se basa en la guía de estilo estándar de kotlin, y validará y se asegurará de que su código se adhiera a esa guía de estilo.
2. formateador: si ktlint detecta que hay problemas en su código, puede ejecutar el formateador y hacer que ktlint intente solucionar esos problemas automáticamente.

¿Cómo podemos implementarlo?

• Agregue ktlint a su proyecto y, más específicamente, vamos a integrar ktlint con el complemento ktlint Gradle, este es un complemento independiente de terceros además de la herramienta básica ktlint y hace que trabajar con ktlint sea muy fácil al proporcionar Gradle listo para usar. tareas con las que ejecutar comandos ktlint.
• Hay varias opciones, pero la forma más fácil es hacer uso del complemento ktlint-Gradle que proporciona tareas de Gradle listas para usar para las herramientas de ktlint.

Agregar ktlint a su proyecto de Android

• Para agregar el complemento ktlint-gradle, simplemente agregue el complemento ktlint-gradle a su archivo build.gradle de nivel raíz
• Para aplicar el complemento a los subproyectos, simplemente aplique el complemento ktlint-gradle a cualquier módulo de Gradle que le gustaría verificar
• Verifique las tareas de Gradle agregadas como Verifique que las tareas ktlintCheck y ktlintFormat se hayan agregado para sus diversos objetivos de compilación

Agregar el complemento ktlint-gradle

Si usa una versión de Gradle que admita los complementos DSL, puede agregar ktlint-gradle a su proyecto con el siguiente código:

// root-level build.gradle
plugins {
    id "org.jlleitschuh.gradle.ktlint" version "7.1.0"
}
 
// root-level build.gradle
buildscript {
  repositories {
    maven {
      url "https://plugins.gradle.org/m2/"
    }
  }
  dependencies {
    classpath "org.jlleitschuh.gradle:ktlint-gradle:7.1.0"
  }
}

Aplique el complemento ktlint-Gradle a todos los subproyectos

Deberá aplicar el complemento ktlint-gradle a los diversos módulos dentro de su proyecto. Puedes hacer esto usando el bloque allProjects{} en el archivo build.gradle de nivel raíz.

// root-level build.gradle
allprojects {
    ...
    apply plugin: "org.jlleitschuh.gradle.ktlint"
}

Probar tareas de Gradle añadidas 

Finalmente, querrá probar que las tareas de ktlint Gradle ahora están disponibles para su uso. Puedes hacerlo de estas formas

• ejecute tareas ./gradlew desde la línea de comando y busque cualquier tarea ktlint
• intente ejecutar ./gradlew ktlintCheck desde la línea de comando
• use la ventana de la herramienta Gradle en IntelliJ o Android Studio para ver si las tareas están en la lista

Para verificar realmente el formato de su código, ejecute el siguiente comando desde la línea de comandos: 

./gradlew ktlintCheck

Esto se ejecutará a través de su proyecto e informará cualquier error que se encuentre utilizando la configuración predeterminada del complemento ktlint-gradle.

Para corregir automáticamente cualquier error informado por ktlintCheck, puede ejecutar el siguiente comando desde la línea de comando: 

./gradlew ktlintFormat

Esto intentará corregir automáticamente cualquier error e informará cualquier problema que no se haya podido solucionar automáticamente.

Cuando todo esté formateado correctamente, debería ver algo como la siguiente imagen cuando ejecute ktlintCheck. ktlint es un proyecto de código abierto mantenido por Pinterest y puedes encontrar más información. Haga clic aquí.