Nette Code Checker

Code Checker kaynak dosyalarınızı görünmez BOM, denetim karakterleri, bozuk kodlama ya da PHP, Latte, NEON ve JSON dosyalarının geçersiz sözdizimi gibi biçimsel kusurlara karşı denetler ve onları otomatik düzeltebilir.

Kurulum

Onu Composer ile küresel olarak kurun:

composer global require nette/code-checker

Küresel Composer bin dizininizin $PATH içinde olduğundan emin olun. code-checker komutu o zaman her yerden, her işletim sisteminde kullanılabilir.

Alternatif olarak onu bağımsız bir proje olarak kurun:

composer create-project nette/code-checker

PHP 8.0 ya da daha yenisini gerektirir.

Kullanım

Code Checker varsayılan olarak salt okunur kipte çalışır ve yalnızca bulduğu sorunları bildirir:

code-checker

Dosyaları gerçekten onarmak için --fix ekleyin. Önce dosyalarınızı yedekleyin ya da onu temiz bir çalışma ağacında çalıştırın; böylece değişiklikleri sonradan git diff ile gözden geçirebilirsiniz:

code-checker --fix

Taramayı belirli bir yolla sınırlayabilir, dosyaları atlayabilir ya da yalnızca sözdizimini denetleyen daha hızlı bir çalıştırma yapabilirsiniz:

code-checker -d src --ignore "temp/*"
code-checker --only-syntax

Salt okunur kipte araç, her şey yolundaysa 0, herhangi bir hata ya da düzeltilebilir sorun bulduğunda 1 koduyla çıkar; böylece CI hatlarına güzelce oturur.

Seçeneklerin tam listesi:

Usage: code-checker [options]

Options:
	-d <path>             Folder or file to scan (default: current directory)
	-i | --ignore <mask>  Files to ignore
	-f | --fix            Fix the files
	-l | --eol            Normalize line endings to the system default
	--only-syntax         Check syntax only (faster)
	--no-progress         Do not show progress dots
	--version             Show version

Code Checker Ne Yapar

  • Latte şablonlarının ve .php, .neon ile .json dosyalarının sözdizimini denetler
  • BOM karakterini kaldırır
  • dosyaların geçerli UTF-8 olduğunu doğrular
  • denetim karakterlerini denetler
  • hatalı biçimlendirilmiş phpDoc yorumlarını saptar (örneğin /** @var yerine /* @var)
  • declare(strict_types=1) bildirimi eksik olan PHP dosyalarını bildirir
  • PHP, CSS, JS ve TS dosyalarında girinti için sekmeleri, YAML'de ise boşlukları zorunlu kılar
  • dosyaların sonundaki sondaki boşlukları ve boş satırları kaldırır
  • satır sonlarını sistem varsayılanına normalleştirir (-l parametresiyle)