Laravel Pint: Pint ile Kodlarınızı Güzelleştirin

laravel pint

Giriş

Laravel Pint, minimalistler için düşünceli bir PHP kod stili düzelticisidir. Pint, PHP-CS-Fixer üzerine kuruludur ve kod stilinizin temiz ve tutarlı kalmasını sağlamayı kolaylaştırır.

Pint, tüm yeni Laravel uygulamalarıyla otomatik olarak yüklenir, böylece hemen kullanmaya başlayabilirsiniz. Varsayılan olarak, Pint herhangi bir yapılandırma gerektirmez ve Laravel’in kabul görmüş kodlama stilini izleyerek kodunuzdaki kod stili sorunlarını çözecektir.

Kurulum

Pint, Laravel çerçevesinin son sürümlerine dahil edilmiştir, bu nedenle kurulum genellikle gereksizdir. Ancak daha eski uygulamalar için Laravel Pint’i Composer aracılığıyla kurabilirsiniz:

				
					composer require laravel/pint --dev
				
			

Çalıştırma

Projenizin vendor/bin dizininde bulunan pint ikili dosyasını çağırarak Pint’e kod stili sorunlarını düzeltmesi için talimat verebilirsiniz:

				
					./vendor/bin/pint
				
			

Pint, güncellediği tüm dosyaların kapsamlı bir listesini görüntüler. Pint’i çağırırken -v seçeneğini sağlayarak Pint’in değişiklikleri hakkında daha fazla ayrıntı görüntüleyebilirsiniz:

				
					./vendor/bin/pint -v
				
			

Pint’in, dosyaları gerçekten değiştirmeden kodunuzu stil hataları açısından incelemesini istiyorsanız, –test seçeneğini kullanabilirsiniz:

				
					./vendor/bin/pint --test
				
			
laravel pint first run
Laravel pint ilk çalıştırma
pint test ile çalıştırma

Konfigürasyon

Daha önce belirtildiği gibi, Pint herhangi bir yapılandırma gerektirmez. Ancak ön ayarları, kuralları veya denetlenen klasörleri özelleştirmek istiyorsanız, projenizin kök dizininde bir pint.json dosyası oluşturarak bunu yapabilirsiniz:

				
					{
    "preset": "laravel"
}
				
			

Ek olarak, belirli bir dizinden bir pint.json kullanmak istiyorsanız, Pint’i çağırırken –config seçeneğini sağlayabilirsiniz:

				
					pint --config vendor/my-company/coding-style/pint.json
				
			

Ön Ayarlar

Hazır ayarlar, kodunuzdaki kod stili sorunlarını düzeltmek için kullanılabilecek bir dizi kural tanımlar. Varsayılan olarak Pint, Laravel’in kabul görmüş kodlama stilini izleyerek sorunları gideren Laravel ön ayarını kullanır. Ancak, Pint’e –preset seçeneğini sağlayarak farklı bir ön ayar belirtebilirsiniz:

				
					 pint --preset psr12
				
			

Dilerseniz ön ayarı projenizin pint.json dosyasında da ayarlayabilirsiniz:

				
					{
    "preset": "psr12"
}
				
			

Pint’in şu anda desteklenen hazır ayarları şunlardır: laravel, psr12 ve symfony.

Kurallar

Kurallar, Pint’in kodunuzdaki kod stili sorunlarını düzeltmek için kullanacağı stil yönergeleridir. Yukarıda bahsedildiği gibi, hazır ayarlar, çoğu PHP projesi için mükemmel olması gereken önceden tanımlanmış kural gruplarıdır, bu nedenle genellikle içerdikleri bireysel kurallar hakkında endişelenmenize gerek kalmaz.

Ancak isterseniz pint.json dosyanızdaki belirli kuralları etkinleştirebilir veya devre dışı bırakabilirsiniz:

				
					{
    "preset": "laravel",
    "rules": {
    "simplified_null_return": true,
    "braces": false,
    "new_with_braces": {
        "anonymous_class": false,
        "named_class": false
        }
    }
}
				
			

Pint, PHP-CS-Fixer’ın üzerine inşa edilmiştir. Bu nedenle, projenizdeki kod stili sorunlarını düzeltmek için kurallarından herhangi birini kullanabilirsiniz.

Dosyaları / Klasörleri Hariç Tutma

Varsayılan olarak Pint, vendor dizinindekiler dışında projenizdeki tüm .php dosyalarını inceler. Daha fazla klasörü hariç tutmak istiyorsanız, bunu hariç tutma yapılandırma seçeneğini kullanarak yapabilirsiniz:

				
					{
"exclude": [
    "my-specific/folder"
    ]
}
				
			

Belirli bir ad kalıbını içeren tüm dosyaları hariç tutmak istiyorsanız, bunu notName yapılandırma seçeneğini kullanarak yapabilirsiniz:

				
					{
"notName": [
    "*-my-file.php"
    ]
}
				
			

Dosyanın tam yolunu sağlayarak bir dosyayı hariç tutmak isterseniz, bunu notPath yapılandırma seçeneğini kullanarak yapabilirsiniz:

				
					{
"notPath": [
    "path/to/excluded-file.php"
    ]
}
				
			

Eğitimin, Eğlencenin ve Haberin Sitesi TEKNOKODİ

İlgili Yazılar