PSX: Proje Yapı Denetleyicisi ile Tutarlılığı Sağlamak

PSX: Proje Yapı Denetleyicisi ile Tutarlılığı Sağlamak

Yazılım projeleri büyüdükçe ve geliştikçe, proje yapısının tutarlılığını korumak zorlu bir görev haline gelebilir. Farklı geliştiricilerin farklı dosya adlandırma kuralları, klasör yapıları veya modül yerleşimleri kullanması, zamanla projenin okunabilirliğini, bakımını ve genel kalitesini olumsuz etkileyebilir. İşte tam bu noktada PSX (Project Structure Checker) devreye girer. PSX, projelerinizin dosya ve klasör yapısını önceden tanımlanmış kurallara göre otomatik olarak denetleyen, açık kaynaklı ve esnek bir araçtır. Bu makalede, PSX’in ne olduğunu, neden önemli olduğunu, nasıl kurulup kullanılacağını, gelişmiş yapılandırma seçeneklerini ve projelerinize nasıl değer katabileceğini detaylı bir şekilde inceleyeceğiz.

PSX Nedir ve Neden Önemlidir?

Proje Yapı Tutarlılığının Önemi

Büyük ve karmaşık yazılım projelerinde, dosya ve klasör yapısının tutarlı olması, projenin sürdürülebilirliği ve geliştirici deneyimi açısından kritik öneme sahiptir. Tutarlı bir yapı, yeni geliştiricilerin projeye adaptasyonunu hızlandırır, kod tabanında gezinmeyi kolaylaştırır ve olası hataları azaltır. Aksi takdirde, her geliştiricinin kendi kurallarına göre hareket etmesi, zamanla projenin bir “spagetti”ye dönüşmesine neden olabilir.

PSX’in Amacı ve Temel Fonksiyonu

PSX, adından da anlaşılacağı gibi, bir projenin yapısını kontrol etmek için tasarlanmıştır. Temel amacı, geliştiricilerin tanımladığı kurallar doğrultusunda dosya ve klasörlerin varlığını, adlandırma desenlerini ve konumlarını doğrulamaktır. Bu sayede, projenin belirlenen standartlara uygun kalması sağlanır ve yapısal sapmalar erkenden tespit edilir.

Kimler İçin Faydalıdır?

• Bireysel Geliştiriciler: Kendi projelerinde düzeni sağlamak ve iyi alışkanlıklar edinmek isteyenler.
• Yazılım Geliştirme Takımları: Takım üyeleri arasında yapısal tutarlılığı garanti altına almak ve kod inceleme süreçlerini kolaylaştırmak isteyenler.
• Büyük Ölçekli Projeler: Onlarca modül ve yüzlerce dosya içeren projelerde yapısal bütünlüğü korumak isteyen kuruluşlar.
• Açık Kaynak Projeleri: Katkıda bulunanların ortak bir yapıya uymasını sağlamak için.

PSX’in Temel Özellikleri ve Çalışma Prensibi

Kural Tabanlı Yapı Denetimi

PSX’in kalbinde, JSON formatında tanımlanan kurallar bulunur. Bu kurallar, projenin hangi dosya ve klasörlere sahip olması gerektiğini, hangi adlandırma desenlerini takip etmesi gerektiğini ve hangi öğelerin var olmaması gerektiğini belirtir. PSX, bu kuralları okur ve projenin mevcut yapısını bu kurallarla karşılaştırır.

Esnek Yapılandırma Seçenekleri

PSX, oldukça esnek bir yapılandırma sunar. Geliştiriciler, basit dosya varlığı kontrollerinden, karmaşık düzenli ifade (regex) tabanlı adlandırma desenlerine kadar çeşitli kural türlerini tanımlayabilirler. Ayrıca, belirli dosyaları veya klasörleri denetimden hariç tutma (exclude) yeteneği de mevcuttur.

Otomasyon ve CI/CD Entegrasyonu

PSX, komut satırı aracı olarak tasarlandığı için otomasyon süreçlerine kolayca entegre edilebilir. Sürekli Entegrasyon/Sürekli Dağıtım (CI/CD) pipeline’larına eklenerek, her kod gönderiminde veya birleştirme isteğinde proje yapısının otomatik olarak denetlenmesi sağlanabilir. Bu, yapısal sorunların erken aşamada yakalanmasına ve düzeltilmesine olanak tanır.

Raporlama ve Hata Bildirimi

Denetim sonucunda, PSX kurallara uymayan tüm yapısal sorunları detaylı bir şekilde raporlar. Hataların hangi kuraldan kaynaklandığı ve hangi dosya/klasörün soruna neden olduğu açıkça belirtilir. Bu, geliştiricilerin sorunları hızlıca anlamasına ve düzeltmesine yardımcı olur.

PSX Kurulumu ve İlk Kullanım

Kurulum Adımları

PSX, bir Node.js paketi olarak mevcuttur ve npm veya yarn aracılığıyla kolayca kurulabilir. Projenizin bağımlılıklarına eklemek için aşağıdaki komutları kullanabilirsiniz:

# npm ile kurulum
npm install --save-dev psx

# veya yarn ile kurulum
yarn add --dev psx

Genel olarak kullanmak isterseniz, global olarak da kurabilirsiniz (ancak proje bazlı kurulum daha yaygındır):

npm install -g psx

Temel Komutlar ve Çalıştırma

PSX'i kurduktan sonra, projenizin kök dizininde bir psx.json yapılandırma dosyası oluşturmanız gerekir. Bu dosya, denetlenecek kuralları içerir. Dosyayı oluşturduktan sonra, PSX'i çalıştırmak için aşağıdaki komutu kullanabilirsiniz:

# Proje dizininde
npx psx

# veya package.json'daki script'ten
npm run psx

Eğer global olarak kurduysanız, doğrudan psx komutunu kullanabilirsiniz.

Örnek Bir Proje Yapısı Üzerinde Deneme

Basit bir örnekle PSX'in nasıl çalıştığını görelim. Diyelim ki projenizin kök dizininde src klasörü ve bu klasörün içinde index.js dosyası olmasını istiyorsunuz. Ayrıca bir test klasörü ve README.md dosyasının da var olmasını bekliyorsunuz.

Örnek psx.json:

{
  "rules": [
    {
      "path": "src",
      "type": "directory",
      "message": "src klasörü bulunamadı."
    },
    {
      "path": "src/index.js",
      "type": "file",
      "message": "src/index.js dosyası bulunamadı."
    },
    {
      "path": "test",
      "type": "directory",
      "message": "test klasörü bulunamadı."
    },
    {
      "path": "README.md",
      "type": "file",
      "message": "README.md dosyası bulunamadı."
    }
  ]
}

Eğer projenizin yapısı bu kurallara uymuyorsa, PSX size ilgili hataları bildirecektir.

Yapı Kurallarını Tanımlama: psx.json Yapılandırma Dosyası

psx.json Dosyasının Yapısı

psx.json dosyası, bir JSON nesnesidir ve temel olarak bir rules dizisi içerir. Her kural nesnesi, denetlenecek bir öğeyi ve bu öğe için geçerli olacak koşulları tanımlar.

{
  "rules": [
    { /* Kural 1 */ },
    { /* Kural 2 */ }
  ],
  "exclude": [ /* Hariç tutulacak yollar */ ]
}

Temel Kural Türleri

PSX, farklı kural türlerini destekler:

• "type": "file": Belirtilen yolda bir dosyanın varlığını kontrol eder.
• "type": "directory": Belirtilen yolda bir klasörün varlığını kontrol eder.
• "type": "pattern": Belirtilen yoldaki