Örnekler

listr2, uygulamanın kullanımına dair daha fazla bilgi edinebileceğiniz birçok örneği depoda barındırır; bu, belgelerin ileri düzey durumlar için yetersiz kaldığı durumlarda geçerlidir.

bilgi

Örneklerin bulunabileceği klasörler ve bu örneklerin çalıştırılma yöntemleri aşağıda detaylandırılmıştır.

Örnekler

Örnekler ./examples/ klasöründe yer almakta olup, hepsi çalışır durumdaki örnekler olduğu için kendi ortamınızda çalıştırılabilir.

Belgeler ayrıca birçok örnek içermektedir; bu örnekler de ./examples/docs/ klasöründe çalıştırılabilir/incelemek için kullanılabilir.

Eğer depoyu klonlamaya karar verirseniz, yeni şeyler öğrenmek veya denemek için ts-node ile tüm örnekleri yerel ortamınızda çalıştırabilirsiniz.

# depoyu klonla
git clone git@github.com:cenk1cenk2/listr2.git

# bağımlılıkları yükle
pnpm install

# herhangi bir örneği çalıştır, script'e deponun görece yolunu vererek
pnpm run --filter example start renderer-default.example.ts

jsdoc

Her bir açık alternatif, örneklerde eksikse kısa bir açıklama içermektedir.

ipucu

Örnekle ilgili kısa açıklamalar ile birlikte, seçeneklerin anlamı ve kullanımı hakkında bilgi paylaşılmaktadır.

Testler

Örneklerin yetersiz kaldığı durumlarda, ./tests/ klasöründe yer alan testler klasörüne daha derinlemesine dalabilirsiniz.

Bu uygulama, kenar koşulları için genellikle iyi bir şekilde test edilmiştir; ancak esasen bir terminal uygulaması olduğundan sınırlıdır. Ne yazık ki testler sırasında terminal taklit edildiği için değişikliklerinizi doğrudan testler üzerinde göremezsiniz, ancak orada verilen örneklerde daha fazla derinlemesine inceleme yapabilirsiniz.