- En la versión 0.7.1 de D2 se añadió la capacidad de renderizar diagramas de texto en ASCII
- Se pueden usar diagramas ASCII simples en comentarios de código para explicar el flujo de funciones o clases
- De forma predeterminada, usa caracteres Unicode pero con una bandera de opción se puede elegir ASCII estándar
- Esta función está en fase alfa y no admite algunos estilos, caracteres especiales ni ciertas figuras
- Es posible probar directamente el renderizado ASCII en D2 Playground y en la extensión para Vim, entre otros
Introducción al renderizado ASCII de D2
Desde el lanzamiento más reciente de D2 (versión 0.7.1), se añadió la salida ASCII para diagramas de texto.
Los archivos de salida con extensión .txt se renderizan automáticamente con el renderizador ASCII.
Se puede ver un ejemplo en la extensión de D2 para Vim; al abrir un archivo .d2 y guardar desde la ventana de vista previa, es posible ver en tiempo real la salida del diagrama ASCII.
Uso en la documentación de código
Los diagramas ASCII son más prácticos cuando se insertan en comentarios del código fuente.
- Si agregas un diagrama simple junto a una función o clase pequeña, puede ayudar a entender el código de forma más intuitiva que una explicación del flujo
- En la extensión de Vim, se puede escribir código D2 y convertir de inmediato la selección en un diagrama ASCII
Elección entre Unicode y ASCII estándar
El renderizado ASCII predeterminado usa caracteres Unicode de dibujo de cajas para ofrecer una salida más agradable visualmente.
- Si buscas máxima portabilidad, también se puede renderizar con caracteres ASCII comunes mediante la bandera de opción
--ascii-mode=standard
Limitaciones actuales
Esta función de renderizado ASCII está en fase alfa.
- Puede haber muchos casos límite, puntos de mejora y errores
- Se anima a enviar reportes de errores o comentarios en el sitio web
Limitaciones principales
- Sin soporte para estilos
- Las animaciones, fuentes y similares no tienen sentido en ASCII
- Más adelante se planea evaluar soporte para algunos estilos limitados, como colores de terminal
- Los temas tampoco son compatibles
double-border,multipley otros están en la lista de mejoras futuras
- Espaciado irregular
- Durante la conversión a ASCII, la disposición de las cajas puede volverse más irregular que en SVG
- Elementos que no se pueden renderizar
- Aún no está implementado el soporte para textos especiales como Markdown, Latex o código
- No se pueden renderizar imágenes e íconos, clases UML, tablas SQL, etc.
- Más adelante se decidirá si estos elementos se eliminan o se muestran como marcadores de posición
- Algunas figuras no son compatibles
- Las figuras curvas, como nubes o círculos, no se representan bien en ASCII
- Esas figuras se reemplazan por rectángulos y se distinguen por tipo con un pequeño ícono en la esquina superior izquierda
Pruébalo directamente
Esta función se puede usar de inmediato en D2 Playground.
- Puedes abrir el bloque de código proporcionado y probar tú mismo el renderizado ASCII
Aún no hay comentarios.