- D2 0.7.1 sürümüyle metin diyagramlarını ASCII olarak render etme özelliği eklendi
- Kod yorumlarında basit ASCII diyagramları kullanarak fonksiyon veya sınıf akışını açıklamak mümkün
- Varsayılan olarak Unicode kutu çizim karakterleri kullanılıyor, ancak seçenek bayrağıyla standart ASCII tercih edilebiliyor
- Bu özellik alfa aşamasında ve bazı stilleri, özel karakterleri ve belirli şekilleri henüz desteklemiyor
- D2 Playground ve Vim eklentisi gibi ortamlarda ASCII render'ı doğrudan deneyimlemek mümkün
D2 ASCII render'ına giriş
D2'nin en yeni sürümüyle (0.7.1) birlikte metin diyagramları için ASCII çıktı özelliği eklendi.
.txt uzantılı çıktı dosyaları otomatik olarak ASCII renderer ile render ediliyor.
Örnekler D2 Vim eklentisinde görülebiliyor; .d2 dosyasını açıp önizleme penceresi üzerinden her kaydedişte ASCII diyagram çıktısının durumunu gerçek zamanlı olarak görmek mümkün.
Kod dokümantasyonunda kullanım
ASCII diyagramları, kaynak kod yorumlarına eklendiğinde en pratik kullanım alanını sunuyor.
- Küçük bir fonksiyonun veya sınıfın yanına basit bir diyagram eklemek, akışı metinle anlatmaktan daha sezgisel biçimde kodun anlaşılmasına yardımcı olabilir
- Vim eklentisinde D2 kodu yazıp seçili alanı doğrudan ASCII diyagrama dönüştürmek mümkün
Unicode ve standart ASCII arasında seçim
Varsayılan ASCII render, daha iyi görünen bir çıktı sağlamak için Unicode kutu çizim karakterlerini kullanıyor.
- Eğer azami taşınabilirlik isteniyorsa,
--ascii-mode=standardseçenek bayrağıyla normal ASCII karakterleriyle de render almak mümkün
Mevcut sınırlamalar
Bu ASCII render özelliği şu anda alfa aşamasında.
- Köşe durumları, iyileştirme alanları ve çeşitli hatalar bulunabilir
- Web sitesi üzerinden hata raporu veya geri bildirim gönderilmesi teşvik ediliyor
Başlıca kısıtlar
- Stil desteği yok
- Animasyon, font gibi öğeler ASCII'de anlam taşımıyor
- İleride terminal renkleri gibi bazı sınırlı stil destekleri değerlendirilebilir
- Temalar da desteklenmiyor
double-border,multiplegibi seçenekler gelecekte iyileştirilecekler listesinde yer alıyor
- Düzensiz aralıklar
- ASCII'ye dönüştürme sürecinde kutuların yerleşimi SVG'ye kıyasla daha düzensiz olabilir
- Render edilemeyen öğeler
- Markdown, Latex, kod gibi özel metin türleri için destek henüz uygulanmadı
- Görseller ve ikonlar, UML sınıfları, SQL tabloları gibi öğeler render edilemiyor
- Bu tür öğelerin kaldırılması veya yer tutucu olarak gösterilmesi konusu ileride belirlenecek
- Bazı şekiller desteklenmiyor
- Bulut, daire gibi eğrisel şekiller ASCII'de iyi ifade edilemiyor
- Bu şekiller dikdörtgenle değiştirilip sol üst köşeye küçük bir ikon eklenerek tür ayrımı yapılıyor
Doğrudan deneyin
Bu özellik D2 Playground üzerinden hemen kullanılabiliyor.
- Verilen kod bloğunu açarak ASCII render'ı doğrudan deneyebilirsiniz
Henüz yorum yok.