DotNet Format ile Programatik Olarak Kod Biçimlendirme

Gerald Versluis

9m 34s

Bu makalede, C# .NET kodunuzu programatik olarak .NET format aracı kullanarak formatlama sürecini adım adım inceleyeceğiz. Bu kılavuz, Gerald Versluis'in "Format Your C# .NET Code Automatically with .NET Format" adlı video eğitimine dayanmaktadır ve kodunuzun tutarlı bir biçimlendirme standardına uymasını sağlamak için aracı nasıl etkili bir şekilde kullanacağınızı göstermektedir. Videoda Gerald'ın yaptıklarını takip etmenizi kolaylaştırmak ve bu teknikleri projelerinize uygulamanız için zaman damgaları ve detaylı açıklamalar sunacağım.

.NET Format'a Giriş

Gerald, (0:36)'da .NET format'ı tanıtırken, bir .editorconfig dosyasında tanımlanan kurallara dayalı olarak C# kodunu formatlayacak bir araç olarak tanımlar. Bu dosya, proje boyunca tutarlı kodlama stillerinin benimsenmesini sağlamak için kritik öneme sahiptir. Tüm kodun aynı formatlama kurallarına uygun olmasını sağlar, bu kurallar şunları içerebilir:

• Girinti Stili: Sekme veya boşluk kullanılıp kullanılmayacağı.
• Boşluk Kuralları: Operatörler, parantezler vb. etrafındaki boşluk miktarı.
• Kod Yapısı: Tek satırlık ve çok satırlık yapılar nasıl biçimlendirilir.

Bu kuralları uygulayarak, .NET format birim bir kod tabanının korunmasına yardımcı olur, böylece okunması ve yönetilmesi daha kolay hale gelir.

.editorconfig Dosyasını Anlama

(0:48)'de Gerald tarafından açıklandığı gibi, .editorconfig dosyası çeşitli kodlama tarzı tercihlerini belirtir. Bu dosya son derece esnektir ve geniş bir formatlama kuralları yelpazesini tanımlamanıza olanak tanır, bunlar şunları içerir:

• Girinti Tercihleri: Girintileme için sekmelerin mi yoksa boşlukların mı kullanıldığını ve kaç boşluk kullanıldığını belirler.
• Boşluk Kılavuzları: Operatörler, parantezler ve anahtar kelimeler gibi kod elemanları etrafındaki boşluğu kontrol eder.
• Diğer Biçimlendirme Kuralları: Kod tutarlılığını sağlamak için ek tarz kurallar tanımlar.

.editorconfig dosyası, farklı editörler ve IDE'ler üzerinde kod formatlaması için merkezi bir yapılandırma noktası görevi görür.

.NET Format Aracına Genel Bakış

Gerald, (1:13)'teki .NET format'ın, .NET çalışma zamanı için küresel bir araç olduğunu açıklar. Bir genel araç olması, sisteminizdeki çeşitli .NET projelerinde kullanılabilmek için bir kez kurulabileceği anlamına gelir. Bu, her proje için ayrı kurulum veya yapılandırma gereksinimi olmadan tutarlı kod formatlamasına olanak tanır.

(1:26)'da GitHub'da .NET format deposuna erişebilirsiniz. Bu depo, aracın kaynak kodunu, belgelerini ve ek bilgilerini sağlar ve kullanıcıların işlevselliklerini anlamasına ve en son sürümlerle güncel kalmasına yardımcı olur.

.NET Format'ın Temel Kullanımı

Gerald, (2:09)'da .NET formatı kullanmanın temel komutunu gösterir:

dotnet format <options> <workspace>

dotnet format <options> <workspace>

Bir Çalışma Alanı Nedir?

.NET format bağlamında, "çalışma alanı" terimi, formatlanacak kodun kapsamını ifade eder. Bu şunları içerebilir:

• Bir Çözüm Dosyası: Birden fazla projeyi kapsayan .sln dosyası.
• Bir Proje Dosyası: Belirli kod dosyalarını içeren bireysel .csproj dosyası.
• Bir Klasör: Birden fazla kod dosyası ve potansiyel olarak .vb dosyaları içeren bir dizin.

Farklı türde çalışma alanları belirleme esnekliği, projenizin çeşitli seviyelerinde formatlama uygulamanıza olanak tanır.

Özellikler ve Seçenekler

Gerald, (2:27)'de .NET format'ın birkaç önemli özelliğini ve seçeneklerini vurgular:

• Otomatik Düzeltme: Araç, .editorconfig dosyanızda tanımlanan kurallara göre formatlama sorunlarını otomatik olarak düzeltebilir. Bu, projeniz boyunca tutarlı kod stili sağlamak için manuel müdahaleye gerek duymadan kullanışlıdır.
• Sadece Kontrol: Değişiklik yapmadan formatlama sorunlarını incelemeyi tercih ediyorsanız, yalnızca sorunları kontrol etmek için aracı kullanabilirsiniz. Bu özellik, sürekli entegrasyon (CI) boru hatlarında özellikle yararlıdır.

Gelişmiş Seçenekler ve Özelleştirme

Gerald gelişmiş seçenekleri ve özelleştirmeyi araştırıyor. Şunlardan bahsediyor:

• Ciddiyet Seviyesi: Hangi ciddiyet seviyesindeki sorunların düzeltileceğini belirtmenize olanak tanır. Bu, belirli türde formatlama sorunlarını hedeflemenize yardımcı olur.
• Dosyaların Dahil Edilmesi/Harici Tutulması: Formatlamadan hangi dosyaların dahil edileceğini veya hariç tutulacağını kontrol edebilirsiniz. Bu, kod tabanınızın belirli bölümlerine odaklanmak için faydalıdır.
• Çıkış Kodu ile Sadece Kontrol: Kontrol seçeneğini kullanarak, düzeltmeler uygulamadan herhangi bir formatlama sorununun olup olmadığını doğrulayabilirsiniz. Çıkış kodu sorunların bulunup bulunmadığını gösterir.
• JSON Raporu: Kodunuzun formatlama durumuna dair içgörüler sağlayan ayrıntılı bir JSON formatında rapor üretir.
• Kapsamlılık: Üretilen çıktı miktarını kontrol etmek için kapsamlılık seviyesini ayarlayın.
• Araç Sürümü: Projenizle uyumluluğu sağlamak ve yeni özelliklerle güncel kalmak için .NET format sürümünü kontrol edin.

.NET Format Araç Kurulumu

Gerald, programatik olarak C# kodunu formate etmek için .NET format aracını kurma sürecini açıklayarak başlar. Şu komutla global bir araç olarak nasıl ayarlanacağını gösterir:

dotnet tool install -g dotnet-format

dotnet tool install -g dotnet-format

Bu komut, .NET format'ın küresel olarak kullanılabilir olmasını sağlayarak, herhangi bir komut istemi veya terminalden kolay erişim sağlar. Gerald, yakın zamanda .NET ile çalışıyorsanız, yüklenmiş olması gereken .NET Core çalışma zamanının önemini vurgular.

(4:00)'de, kurulumun başarılı olduğunu doğrulamak için Gerald şu komutu çalıştırır:

dotnet format /?

dotnet format /?

Bu komut, mevcut seçeneklerin ve komutların listesini görüntüler, .NET format'ın doğru bir şekilde kurulduğunu ve kullanıma hazır olduğunu doğrular.

(4:11)'de, Gerald not edip bazılarının, --dry-run gibi seçneklerinin kullanım dışı olduğunu ve kod formatlama için güncel uygulamaların kullanılmasını önerir.

Kod Biçimlendirme Düzeltmelerini Uygulama

Biçim Sorunlarını Kontrol Etme

Pratik bir örnek olarak Xamarin Community Toolkit kod tabanını kullanarak, Gerald öncelikle herhangi bir değişiklik uygulamadan biçimlendirme sorunlarını kontrol eder. Gerald şu komutu çalıştırır:

dotnet format . -f --check

dotnet format . -f --check

biçimlendirilmesi gereken dosyaları belirlemek için. Gerald, (5:26)'da dizinler için --folder veya çözüm dosyaları için .NET format sln kullanarak çalışma alanını nasıl belirleyebileceğinizi açıklar. Bu komut biçimlendirme sorunları olan dosyaları listeler.

Hata Seviyesi Kontrolü

Çalıştırılan her işlem, durumunu belirten bir çıkış koduna sahiptir. Gerald hata seviyesini kontrol etmek için aşağıdaki komutu yürüttü:

echo %errorlevel%

echo %errorlevel%

Gerald, 2 numaralı çıkış kodunun ele alınması gereken biçimlendirme hataları olduğunu işaret ettiğini gösteriyor.

Düzeltmeleri Uygulama ve Doğrulama

Gerald, daha sonra, --check bayrağı olmadan komutu yeniden çalıştırarak biçimlendirme düzeltmelerinin nasıl uygulanacağını gösterir:

dotnet format . -f

dotnet format . -f

Bu, .editorconfig dosyanızda tanımlanan kurallara göre kod dosyalarını otomatik olarak biçimlendirir. Gerald, tüm biçimlendirme sorunlarının çözüldüğünü gösteren, çıkış kodunun 0 olup olmadığını kontrol etmek için yukarıda belirtilen aynı komutu kullanır.

Değişiklikleri doğrulamak için, (8:00)'de, güncellenen dosyaları incelemek için GitHub Desktop gibi grafiksel bir araç kullanır. Araç, düzeltilmiş boşluklar, düzenlenmiş using ifadeleri ve diğer biçimlendirme ayarlamaları gibi geliştirmeler gösterir.

Çalışma Akışınıza Biçimlendirmeyi Entegre Etme

Gerald, .NET format aracını yapı CI hattınıza dahil etmenizi önerir. Bu uygulama, kod formatlamasının sürekli olarak uygulanmasını sağlar ve yüksek kaliteli kod standartlarının korunmasına yardımcı olur. Biçimlendirme sürecini otomatikleştirerek, manuel biçimlendirme görevlerinden kaçınabilir ve tüm kodun tanımlı stil kurallarına uymasını sağlayabilirsiniz.

Sonuç

Gerald'in ayrıntılı yürüyüşünü takip ederek, .NET format'ı geliştirme sürecinize kolayca entegre edebilir ve C# .NET kodunuzun otomatik biçimlendirilmesini sağlayabilirsiniz. İster tek başınıza çalışıyor olun, ister bir ekibin parçası olarak, bu araç, kodunuzun temiz, tutarlı ve okunması kolay kalmasını sağlar. Gerald'in videosuna göz atmayı unutmayın, bu araç hakkında pratik bir gösterim ve daha fazla içgörü sunar. C# kodu hakkında daha fazla bilgi edinmek için YouTube Kanalını da ziyaret edin.