Bu araç ne yapar
Ruby biçimlendirici, Ruby kodunu tutarlı girinti ve boşluklarla yeniden yazar. Bir script, bir Rails modeli veya bir Rakefile yapıştırın; iki boşluk girinti, her satırda bir ifade, operatörlerin etrafında ve süslü parantezlerin içinde boşluklar ve satır genişliğine sığacak şekilde kırılmış uzun metot zincirleriyle geri gelir.
WebAssembly’ye derlenmiş gerçek Ruby yorumlayıcısı üzerinde çalışan Syntax Tree’yi kullanır. Ayrıştırıcı Ruby’nin kendisine ait olduğu için endless metotlar, pattern matching ve anahtar kelime argümanları gibi modern söz dizimi tam olarak Ruby’nin anladığı gibi anlaşılır.
Nasıl kullanılır
- Ruby kodunu yapıştırın veya bir
.rbdosyası açın. - İlk sonucu bekleyin. Yorumlayıcı arka planda bir kez indirilir.
- Bir Satır genişliği seçin. Bundan uzun satırlar metot çağrılarından, argümanlardan veya hash girdilerinden kırılır.
- Biçimlendirilmiş kodu kopyalayın veya indirin.
Kod ayrıştırılamazsa araç, eksik parçayı bulabilmeniz için syntax error, unexpected 'end' gibi Ruby’nin söz dizimi hatasını gösterir.
Örnek
Örnek, düzene hiç dikkat edilmeden yazılmış küçük bir alışveriş sepeti modülüdür: girintilenmemiş bir sınıf gövdesi, noktalı virgüllerle tek satırda yazılmış initialize, boşluksuz hash’ler ve > etrafında boşluk olmayan bir üçlü operatör. Biçimlendirmeden sonra modül ve sınıf girintilenir, initialize içindeki her ifade kendi satırını alır, hash literal’leri { name: name, price: price, qty: qty } olur ve üçlü operatör cart.total > 10 ? "big order" : "small order" şeklinde okunur.
Neleri değiştirmez
Biçimlendirici yalnızca düzeni değiştirir. Değişkenleri yeniden adlandırmaz, hash roket söz dizimini yeni söz dizimine çevirmez veya tek ve çift tırnaklar arasında geçiş yapmaz. Yorumlar korunur. Bu stil düzeltmelerine ihtiyacınız varsa, biçimlendirmeden sonra projenizde RuboCop’un otomatik düzeltmesini çalıştırın.
İpuçları
- Biçimlendirilmiş kodun linter’ınızdan geçmesi için projenizin
.rubocop.ymldosyasındaki (Layout/LineLength) satır genişliğini kullanın. - Biçimlendirme, eksik bir
end’i bulmanın hızlı bir yoludur: Ruby, genellikle kapatılmamış bloğun hemen ardından, vazgeçtiği yeri bildirir.
SSS
› Hangi biçimlendiriciyi kullanıyor?
Resmi Prettier Ruby eklentisinin arkasındaki Ruby biçimlendiricisi Syntax Tree’yi. WebAssembly’ye derlenmiş standart Ruby yorumlayıcısı CRuby üzerinde çalışır; bu yüzden kodunuzu tam olarak Ruby’nin yaptığı gibi ayrıştırır.
› İlk çalıştırma neden yavaş?
Sayfa, bir şeyi ilk kez biçimlendirdiğinizde yaklaşık 13 MB olan Ruby yorumlayıcısını ve biçimlendiriciyi indirir ve sayfanın yanıt vermeye devam etmesi için bunları bir arka plan worker’ında başlatır. Sonrasında biçimlendirme saniyenin küçük bir kesrini alır.
› RuboCop’un stilini izliyor mu?
Büyük ölçüde. Syntax Tree iki boşluk girinti, hash süslü parantezlerinin içinde ve operatörlerin etrafında boşluklar ve metotlar arasında bir boş satır üretir; bu da RuboCop’un varsayılan düzen kurallarıyla eşleşir. `rubocop -a` gibi tırnak stilini değiştirmez veya kodu yeniden yazmaz.
› Kodum yükleniyor mu?
Hayır. Her şey tarayıcınızda çalışır ve bir sunucuya hiçbir şey gönderilmez.