Saltar a contenido

EditorConfig


EditorConfig permite ayudar a los desarrolladores a definir y mantener estilos de codificación coherentes entre distintos editores e IDE, este consiste en un formato de archivo para definir estilos de codificación y una colección de complementos de editor de texto que permiten a los editores leer el formato de archivo y adherirse a los estilos definidos. Los archivos de EditorConfig son fáciles de leer y funcionan muy bien con los sistemas de control de versiones.

Instalación

Para el uso correcto dentro de cada editor, es necesario instalar el plugin correspondiente para el uso, aun que hay editores que lo traen ya integrado:

Y otros que si requieren este plugin:

Configuración

Para su uso basta con crear el archivo .editorconfig dentro del directorio raíz de nuestro proyecto y definir nuestro estilo de edición deseado, por ejemplo:

# top-most EditorConfig file
root = true

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

# Configuracion para Java, XML
[*.{java,xml}]
indent_size = 4

[*.{yaml,yml}]
indent_size = 2

# 4 space indentation
[*.py]
indent_size = 4

# Tab indentation (no size specified)
[Makefile]
indent_style = tab

# Indentation override for all JS under lib directory
[lib/**.js]
indent_size = 2

# Matches the exact files either package.json or .travis.yml
[{package.json,.travis.yml}]
indent_size = 2