EditorConfig para Android y Kotlin
editorconfig android kotlin

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?

脥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 poderosa que puede facilitar 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.

Publicado: 2023-09-25 Actualizado: 2023-10-01