D2 (outil de diagrammes textuels) prend désormais en charge le rendu ASCII

• Dans la version 0.7.1 de D2, une fonctionnalité de rendu des diagrammes textuels en ASCII a été ajoutée
• Il est possible d’utiliser de simples diagrammes ASCII dans les commentaires de code pour expliquer le flux d’une fonction ou d’une classe
• Par défaut, le rendu utilise des caractères Unicode, mais un drapeau d’option permet de choisir l’ASCII standard
• Cette fonctionnalité est en phase alpha et ne prend pas encore en charge certains styles, caractères spéciaux et certaines formes
• Il est possible d’essayer directement le rendu ASCII dans le D2 Playground et l’extension Vim

---

Présentation du rendu ASCII de D2

À partir de la dernière version de D2 (0.7.1), une fonction de sortie ASCII pour les diagrammes textuels a été ajoutée.
Les fichiers de sortie avec l’extension .txt sont automatiquement rendus avec le moteur ASCII.
Un exemple est visible dans l’extension Vim de D2 : en ouvrant un fichier .d2 et via la fenêtre de prévisualisation, il est possible de voir en temps réel l’état du diagramme ASCII à chaque sauvegarde.

Utilisation pour la documentation du code

Les diagrammes ASCII sont particulièrement pratiques lorsqu’ils sont insérés dans les commentaires du code source

• Ajouter un petit diagramme à côté d’une fonction ou d’une classe permet de faciliter la compréhension du code de façon plus intuitive qu’une simple explication du flux
• Dans l’extension Vim, il est possible d’écrire du code D2 puis de convertir immédiatement une sélection en diagramme ASCII

Choix entre Unicode et ASCII standard

Le rendu ASCII par défaut utilise des caractères Unicode de dessin de cadres, pour un résultat plus esthétique

• Si vous souhaitez une portabilité maximale, vous pouvez aussi effectuer le rendu avec des caractères ASCII classiques via le drapeau d’option --ascii-mode=standard

Limites actuelles

Cette fonctionnalité de rendu ASCII est en phase alpha

• Il peut encore exister de nombreux cas limites, pistes d’amélioration et bugs
• Les utilisateurs sont encouragés à soumettre des rapports de bug ou des retours sur le site

Principales limitations

• Styles non pris en charge
  • Les animations, polices, etc. n’ont pas de sens en ASCII
  • Une prise en charge limitée de certains styles, comme les couleurs de terminal, pourrait être étudiée à l’avenir
  • Les thèmes ne sont pas pris en charge non plus
  • double-border, multiple, etc. figurent dans la liste des améliorations prévues
• Espacement irrégulier
  • Lors de la conversion en ASCII, la disposition des boîtes peut devenir plus irrégulière qu’en SVG
• Éléments impossibles à rendre
  • La prise en charge des textes spéciaux comme Markdown, Latex et le code n’est pas encore implémentée
  • Les images et icônes, les classes UML, les tables SQL, etc. ne peuvent pas être rendues
  • Il reste à décider si ces éléments seront supprimés ou affichés sous forme de placeholders
• Certaines formes ne sont pas prises en charge
  • Les formes courbes comme les nuages ou les cercles se représentent mal en ASCII
  • Ces formes sont remplacées par des rectangles, avec une petite icône ajoutée en haut à gauche pour distinguer leur type

Essayer par vous-même

Cette fonctionnalité est disponible immédiatement dans le D2 Playground

• Vous pouvez ouvrir le bloc de code fourni et tester vous-même le rendu ASCII