Episodio 145 – EditorConfig para Android y Kotlin
EditorConfig: en el mundo del desarrollo de software, la coherencia es clave. Mantener un estilo de código uniforme y una estructura bien definida es esencial para la colaboración efectiva en equipos de desarrollo.
Aquí es donde entra en juego este fichero, una herramienta que puede simplificar enormemente tu flujo de trabajo y ayudarte a evitar debates interminables sobre cuestiones de estilo de código.
Exploraremos qué es EditorConfig, cómo funciona y por qué deberías considerarlo para tus proyectos Android / Kotlin.
Viste ya a Rusvel Leyva en la entrevista en la que hablamos sobre el Síndrome del Impostor en programadores?
Contenido del audio
Índice
00:00 | Qué vamos a ver
00:14 | EditorConfig
00:55 | Ejemplo de EditorConfig
02:13 | charset
02:26 | end_of_line
02:34 | insert_final_newline
03:02 | trim_trailing_white_space
03:19 | Configuración para Android / Kotlin
04:13 | Conclusiones
04:42 | Recomendación
Transcripción
¡Muy buenas! Soy Gabi Moreno y te doy la bienvenida al episodio número 145 de Los androides, el podcast en el que te contamos técnicas, tips, herramientas, conceptos, hábitos y todo aquello que te va a hacer desatar tu potencial como Android Developer.
Hoy te voy a hablar sobre el fichero Editor Config.
Y este episodio de hoy es un formato diferente a adicional, no voy a dejar de hacer el tipo de contenido que estás acostumbrado si es que escuchas este podcast, pero es un formato nuevo, diferente y a ver qué te parece, por cierto, si hay algo que no quede claro, te recomiendo, encarecidamente, que vayas al canal de YouTube, «Gabi Moreno», gabimoreno.soy/youtube, si algo se queda pues que no se acaba de pillar, porque hay parte visual que evidentemente pues no tiene, porque vamos, que tiene más sentido que se vea en vídeo, pero bueno, ya me dices que tal, me puedes dar feedback de muchas maneras a través del e-mail holra@gabimoreno.soy a través de un mensaje directo en Discord o a través de redes sociales como quieras.
Vamos a ver que tal funciona, si te gusta, si no te gusta, si te parece interesante, no, te dejo con el contenido.
En este vídeo te voy a explicar por qué usar un fichero .editorconfig te va a ser muy útil para ahorrar tiempo y discusiones.
Muy buenas, soy Gabi Moreno y vamos al lío.
Editor config es un fichero de configuración que nos permite definir el estilo que va a tener un proyecto a nivel de código, lo que son si usamos tabuladores o espacios, saltos de línea, etc.
Editor config sobrescribe las configuraciones que tenga nuestro IDE, en nuestro caso Android Studio, con lo que permite que haya una uniformidad independientemente de la versión de la versión…
¿Qué es EditorConfig?
EditorConfig es un archivo de configuración utilizado en proyectos Android y Kotlin (y el resto en realidad) para definir la configuración estilística. Esto incluye detalles como si se deben utilizar espacios o tabuladores, cómo se deben manejar los saltos de línea, si se deben eliminar espacios en blanco innecesarios y cuál debe ser el límite máximo de caracteres por línea. En definitiva, te permite establecer un estándar de estilo de código para tu proyecto. Algo esencial para mantener la calidad de tu código.
Compatibilidad y Ventajas
Una de las grandes ventajas de EditorConfig es su compatibilidad. La mayoría de los editores de texto populares admiten nativamente el formato EditorConfig. Si tu editor favorito no lo soporta de manera nativa, es probable que puedas agregar un complemento o plugin para habilitar esta funcionalidad.
La ventaja principal de EditorConfig es que permite mantener un estilo de programación coherente en todo tu equipo de desarrollo. A menudo, los desarrolladores tienen preferencias personales en cuanto a la configuración de su editor, como el uso de espacios en lugar de tabuladores o viceversa. EditorConfig resuelve este problema al sobrescribir cualquier configuración individual del editor con las directivas definidas en el archivo EditorConfig del proyecto. Esto significa que todos, sin importar qué editor utilicen, programarán de la misma manera, lo que facilita las revisiones de código y mantiene un código limpio y consistente.
Yo es de lo primero que miro cuando hago una revisión de código.
Estructura de un Archivo EditorConfig
Un archivo .editorconfig tiene una estructura simple pero poderosa. Se compone de bloques donde se especifican rutas o expresiones regulares que indican qué archivos se verán afectados por la configuración. Luego, dentro de esos bloques, se definen directivas en pares clave-valor que establecen la configuración visual del código fuente.
Directivas Importantes
indent_style: Esta directiva define si se deben utilizar espacios o tabuladores para la indentación.indent_size: Indica cuántos espacios o tabuladores se deben usar para la indentación.end_of_line: Especifica el tipo de caracter de final de línea (LF o CRLF).charset: Define la codificación de caracteres que se debe utilizar (se recomienda utf-8).trim_trailing_whitespace: Controla si se deben eliminar espacios en blanco al final de las líneas al guardar el archivo.insert_final_newline: Decide si se debe agregar una línea en blanco al final del archivo.max_line_length: Establece el límite máximo de caracteres por línea.
Prioridad de Configuración y Expresiones Regulares
Las configuraciones más específicas tienen prioridad sobre las generales. Puedes utilizar expresiones regulares para definir qué archivos se verán afectados por las configuraciones. Esto te permite personalizar la configuración según las necesidades de tu proyecto y tu equipo.
Extensiones de Archivo
Puedes utilizar asteriscos o expresiones regulares para aplicar configuraciones a tipos específicos de archivos.
Por ejemplo, si deseas aplicar reglas solo a archivos Kotlin típicos, puedes usar [*.kt] como expresión regular. Si quisieras hacerlo para los ficheros Kotlin de Gradle, [*.kts].
Si quieres hacerlo para los 2 a la vez, [*{kt, kts}].
Instalación y Beneficios de EditorConfig en Android y Kotlin
En la mayoría de los casos, los editores de texto reconocen automáticamente los archivos EditorConfig en tu proyecto. Si tu editor no lo hace, generalmente puedes agregar una extensión o plugin para habilitar esta funcionalidad.
Los beneficios de utilizar EditorConfig en Android y Kotlin son evidentes. Simplifica la colaboración en equipo al eliminar debates sobre el estilo de código. Ayuda a mantener un código limpio y legible, lo que a su vez mejora la calidad del software que produces.
Conclusión
EditorConfig es una herramienta sensacional que facilita significativamente tu flujo de trabajo en desarrollo de software. Al establecer un estándar de estilo de código y garantizar su cumplimiento en todo el equipo, puedes centrarte en lo que realmente importa: crear software de alta calidad.
Si aún no has considerado utilizar EditorConfig en tus proyectos, ¡te animo a que lo pruebes! Verás cómo mejora la eficiencia de tu equipo y la calidad de tu código.
Y también te recomiendo que le eches un vistazo a los TOPICS 2024 en Android / Kotlin.