Vercel, yorum ve daha düz yapı destekli vercel.toml proje yapılandırması ekledi

Ne oldu

Vercel blog'unda yayımlanan bir changelog yazısına göre Vercel projeleri artık vercel.toml dosyasıyla yapılandırılabiliyor. Yeni seçenek tüm projelerde kullanılabilir durumda ve mevcut vercel.json ile vercel.ts formatlarının yanına ekleniyor.

Vercel'e göre vercel.json'da çalışan her yapılandırma özelliği vercel.toml'da da çalışıyor; yani geçişte hiçbir şey kaybedilmiyor. Değişen şey dosyanın kullanım kolaylığı: TOML satır içi yorumlara izin veriyor ve yapılandırmayı JSON'dan daha az iç içe geçmiş şekilde ifade ediyor.

Yeni format size ne kazandırıyor

En belirgin iyileştirme yorumlar. JSON'da yorum sözdizimi yok; yani derlemeleri, rewrite'ları veya header'ları vercel.json üzerinden yapılandıran ekipler, bir ayarın gerekçesini ya başka bir yerde belgelemek ya da açıklamasız bırakmak zorundaydı. vercel.toml ile birlikte, belirli bir rewrite'ın veya servis ayarının neden var olduğuna dair bir not doğrudan yanına eklenebiliyor.

Daha sığ yapı, TOML'un tablo sözdiziminden geliyor. İç içe geçmiş JSON nesneleri yerine ilgili ayarlar [services.frontend] gibi bölüm başlıkları altında gruplanıyor ve rewrite kuralları gibi tekrarlanan girdiler [[rewrites]] biçimi kullanılarak tablo dizileri olarak yazılıyor. Sonuç, tek büyük iç içe bir nesne olarak değil, baştan sona okunabilen bir dosya.

Vercel'in verdiği örnek

Changelog yazısı, formatı iki servis çalıştıran bir örnekle gösteriyor: bir Next.js frontend ve bir FastAPI backend. Dosya önce "$schema" anahtarını Vercel'in OpenAPI belirtimine yönlendiriyor, ardından her servisi kendi bölümünde tanımlıyor. Frontend'in kökü frontend/ olarak ayarlanmışken, backend'in kökü backend/ ve giriş noktası main:app.

Ardından iki rewrite kuralı geliyor. /api/(.*) ile eşleşen istekler backend servisine yönlendiriliyor, geri kalan her şey frontend'e düşüyor. Örnek TOML ile yazıldığı için her blok, neyi yapılandırdığını belirten bir yorum taşıyabiliyor; bu da tam olarak JSON'un barındıramadığı türden bir açıklama.

Proje başına tek yapılandırma dosyası

Vercel tek bir kısıt belirtiyor: bir proje, vercel.toml, vercel.json veya vercel.ts arasından seçilmiş tam olarak bir yapılandırma dosyası kullanmalı. TOML formatını benimseyen ekipler, ikisini yan yana çalıştırmak yerine mevcut vercel.json dosyalarını kaldırmak zorunda kalacak. Changelog yazısı, mevcut JSON dosyalarını yeni formata dönüştürecek otomatik bir araçtan bahsetmiyor.

Neden önemli

Yapılandırma dosyaları düzenlenmelerinden çok daha sık okunur ve önemsiz bir dağıtımın ötesindeki her şey için — birden çok servis, rewrite'lar, ortama özel ayarlar — dosyaya açıklama ekleyebilme, onu açan bir sonraki kişi için gerçekten işe yarar. Daha düz yapı, büyük yapılandırmaları incelemeyi ve diff'lerde gözden geçirmeyi de kolaylaştırır.

Bir tanıdıklık argümanı da var. TOML zaten Rust'ın Cargo'sunun, Python'ın pyproject.toml dosyasının ve Netlify'ın netlify.toml dosyasının kullandığı yapılandırma formatı; dolayısıyla Vercel'e gelen birçok geliştirici bu türde dosya yazmış olacak. vercel.toml'ı vercel.json ile aynı seviyeye getirmek mevcut ekiplere hiçbir maliyet getirmez, çünkü eski format çalışmaya devam ederken yeni ve büyüyen projelere dağıtım ayarlarını saklayacak daha sürdürülebilir bir yer sunar.