EditorConfig para configurar tu editor de código

Seguro te ha pasado que: en tu equipo de desarrollo unos usan tabs y otros usan espacios para la identación, también que necesitas identación diferente de acuerdo al tipo de archivo. Esto se resuelve de manera sencilla configurando tu editor o IDE adecuadamente.

EditorConfig

EditorConfig es un plugin para tu Editor de código o IDE que permite configurar la forma en que se formatea el código de fuente de tu proyecto, con esto se logra mantener el código consistente de manera sencilla.

Existen plugins para la mayoría de los casos, entre los más utilizados se tienen:

Una vez instalado el plugin, lo siguiente es crear un archivo llamado .editorconfig en la raíz de tu proyecto donde se colocarán las reglas necesarias.

Parámetros de EditorConfig

Los parámetros mas utilizados para la configuración son:

charset define la codificación de caracteres de los archivos.
indent_style estilo de la identación a utilizar (tab, space).
indent_size tamaño de la identación expresada como número entero.
end_of_line formato del salto de línea (lf, crlf, cr).
trim_trailing_whitespace define si se acepta espacios en blanco al final de la línea.
insert_final_newline define si se inserta una línea en blanco al final del archivo.

Configurar EditorConfig

Configuremos para que todos los archivos se guarden en UTF-8, que las líneas no terminen con espacios en blanco y el archivo siempre tenga una línea vacía al final.


root = true

[*]
charset = utf-8
end_of_line = lf
indent_size = 2
indent_style = space
insert_final_newline = true
trim_trailing_whitespace = true

Podemos mejorar aún esta configuración aplicando: identación de 4 espacios para archivos PHP y permitiendo los espacios en blanco para los archivos MarkDown.


root = true

[*]
charset = utf-8
end_of_line = lf
indent_size = 2
indent_style = space
insert_final_newline = true
trim_trailing_whitespace = true

[*.php]
indent_size = 4

[*.md]
trim_trailing_whitespace = false

Con esto cada vez que guardes tus archivos se formatearán correctamente cada vez que guardes los cambios.

Recomendaciones

Se recomienda incluir el archivo de configuración al inicio del proyecto e incluirlo en tu repositorio para asegurarse que todo el equipo trabaja correctamente.

Cuando usas un nuevo editor de código asegúrate que tiene instalado EditorConfig para que tu trabajo siga las reglas del equipo.