¿Qué es .editorconfig?

EditorConfig es un archivo de configuración simple que contiene una lista de reglas que se pueden aplicar a cualquier IDE o editor de código para formatear correctamente el código. Pero, ¿por qué usar EditorConfig? Considere un escenario en el que su equipo está trabajando en un proyecto pero los miembros individuales del equipo usan un IDE o editor de código diferente, estas diferencias pueden resultar en un formato inconsistente aplicado al código ya que cada IDE/editor tiene sus propias configuraciones. EditorConfig resuelve este problema al tener un único archivo de configuración que todos los IDE y editores de código pueden leer con la ayuda de algunos complementos/extensiones. Esta herramienta se usa ampliamente en muchos proyectos grandes, incluidos Angular, Bootstrap, Django, Nodejs, React, Vuejs y muchos más.

Ventajas de usar EditorConfig

1. Puede tener un estilo de sangría común (pestañas/espacios) y un tamaño de sangría
2. EditorConfig ayudará a configurar la codificación de caracteres y los finales de línea (lf/crlf)
3. También puede obligar al editor a tener una nueva línea al final de cada archivo y mucho más.

Configurando EditorConfig en sus proyectos: 

Para configurar EditorConfig, debe instalar el complemento/extensión correspondiente a su IDE/editor.
Los siguientes editores no necesitan complementos, ya que vienen con soporte nativo para EditorConfig:

• IntelliJ
• Pycharm
• Estudio visual
• Github / Gitlab / Gitbucket

Si usa los editores que se enumeran a continuación, debe instalar el complemento a través de sus respectivos enlaces:

• Código VS
• Átomo
• Eclipse
• Bloques de código
• Frijoles netos
• Texto sublime

Una vez que se instala el complemento/extensión respectivo, cree un archivo llamado `.editorconfig` en la raíz del directorio de su proyecto

Si usa VS Code, puede generar un nuevo archivo editorconfig a través del menú contextual de la barra lateral del Explorador haciendo clic con el botón derecho en la carpeta donde desea que esté y seleccionando Generar .editorconfig.

Sintaxis de configuración: 

• root = true: cada vez que abra su Editor, el complemento EditorConfig buscará un archivo llamado `.editorconfig` en el directorio de archivos abiertos y en cada directorio principal, pero esta búsqueda se puede detener si llega a la ruta del archivo raíz que puede especificarse con root=true.
• Comentarios: Los comentarios en `.editorconfig` comienzan con ‘#’ o ‘;’.
• Encabezados de sección: comienzan con ‘[‘ y terminan con ‘]’, se utilizan para seleccionar los archivos específicos y aplicarles reglas. Por ejemplo, ‘[*.js]’ aplicará todas las reglas a cualquier archivo que tenga ‘.js’ como extensión.
• Pares clave-valor : estos pares clave-valor son las reglas (propiedades admitidas) que se encuentran debajo de los encabezados de sección. Por ejemplo, ‘indent_size = 4` establecerá el tamaño de la sangría en 4 espacios/pestañas. Puede encontrar todas las propiedades admitidas en su página wiki .

Ejemplo de archivo de configuración: 

# EditorConfig is awesome: https://EditorConfig.org

# top-most EditorConfig file
root = true

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

[*.md]
max_line_length = 0
trim_trailing_whitespace = false

Aquí root=true especifica al editor que es el archivo EditorConfig superior, cualquier regla especificada bajo el encabezado de esta sección- [*] se aplicará a todos los archivos, incluidos sus *.js, *.css, etc. puede tener reglas específicas para archivos específicos, por ejemplo, el encabezado de la sección [*.md] tiene las reglas que deben aplicarse solo en archivos que tienen .md como extensión.