Embellecedor de código
Cinco lenguajes, una indentación

Qué hace un embellecedor de código con un archivo

El diseño y el significado son cosas distintas en el código. Por eso un embellecedor de código puede cambiar cada espacio sin cambiar lo que hace el programa.

Esa es toda la promesa. Este embellecedor de código lee el archivo, averigua dónde empieza y acaba cada bloque, y reescribe las líneas con una indentación que sigue el anidamiento.

Cinco modos viven tras un solo editor en este embellecedor de código: Java, C, C++, ActionScript y crontab. Como los cuatro primeros comparten una gramática de llaves, comparten casi todo el lector, y cada uno añade sus reglas encima.

Todo corre en esta pestaña. Así que puedes ordenar un archivo bajo cláusula de confidencialidad sin que toque un servidor.

El resultado es un archivo que un revisor puede leer. Como un diff muestra el cambio de diseño entero, mantienes el control de lo que vuelve al repositorio.

Cómo lee un embellecedor de código un archivo

Un formateador no puede limitarse a contar espacios. En su lugar recorre el texto una vez y sigue el estado en que está.

El lector conoce cuatro estados: código normal, una cadena literal, un carácter literal y un comentario. Como una llave significa una cosa en el código y nada dentro de una cadena, el estado lo decide todo.

Esa única regla es lo que separa un embellecedor de un buscar y reemplazar. Una expresión regular que indenta en cada llave de apertura moverá las líneas dentro de una cadena que da la casualidad de llevar una llave.

Así que el lector mide una línea en vez de reescribirla. Luego la profundidad que sostiene en el salto de línea fija la indentación de la siguiente.

La profundidad sube en una llave de apertura y baja en una de cierre. Mientras tanto, el lector pasa por encima de una llave dentro de un comentario o un literal, y la profundidad se queda donde estaba.

Por qué importa una llave dentro de una cadena

Piensa en una línea que arma un mensaje con una llave suelta, o en una expresión regular escrita como literal. Para un contador, cada una parece el inicio de un bloque.

Desde ahí la indentación está mal el resto del archivo. El fallo es silencioso, porque el archivo aún compila. Solo se lee mal desde una línea en adelante.

El lector lo evita al negarse a contar dentro de un literal. Así que una llave en una cadena es texto, una llave en un comentario es texto, y solo una llave en el código mueve la profundidad.

El lector trata igual una comilla escapada. Como una barra invertida dentro de un literal mantiene al lector en ese literal, una comilla en medio de una cadena no lo termina.

La misma máquina de estados explica tres de los fallos comunes que se listan más abajo en esta página. Por eso vale la pena leerla dos veces.

Indentación y estilo de llaves, lado a lado

Dos ajustes hacen casi todo el trabajo visible en un embellecedor de código. El primero es la indentación, y el segundo es dónde va la llave de apertura.

El ancho de indentación es un número de espacios, de dos a ocho, o un solo tabulador. Como la elección es una convención de equipo y no una cuestión de corrección, cualquiera de las dos vale mientras el archivo sea coherente.

El estilo de llaves tiene tres respuestas comunes, y la disputa es lo bastante vieja como para que Wikipedia liste las variantes con nombre. En la primera, la llave abre al final de la línea que la necesita. En la segunda, la llave abre en una línea propia con la misma indentación. En la tercera, la llave abre en su propia línea indentada un nivel más.

Mezclarlos dentro de un archivo es lo que hace que un código cueste de ojear. Por eso el ajuste se aplica a todo el archivo de una vez, y el cuerpo se vuelve a colocar bajo la nueva elección.

Una llave de cierre siempre se sienta en la indentación de la línea que la abrió. Esa regla es lo que hace legible un método largo, ya que el ojo encuentra el fin de un bloque sin contar.

Qué añade el formateo de crontab

Un archivo crontab no es un lenguaje de llaves, así que el lector cambia a otro trabajo. Igualmente, en vez de anidar, comprueba que cada línea tenga el número correcto de campos.

Cinco campos forman un horario: minuto, hora, día del mes, mes y día de la semana, como los expone la referencia de cron. Luego sigue un comando, y sus propios espacios se dejan en paz.

Así que la herramienta cuenta los campos, nombra los que faltan y señala un valor que no puede significar nada. Una hora de 26 y un minuto de 61 son imposibles, y ambos son fáciles de teclear.

Un valor de paso y un rango reciben el mismo trato. Como cinco barra dos y nueve guion diecisiete son las dos formas que más se escriben mal, la herramienta comprueba cada una contra sus límites.

Los comentarios que empiezan con almohadilla se quedan donde están. Por consiguiente, el archivo vuelve con sus notas intactas y sus columnas alineadas.