02

Başlarken

Eklentiyi ve CLI'ı kurup ilk kez çalıştırmak

2 dk okuma5 bölüm

Gereksinimler

GereksinimNeden
PATH üzerinde GitHer analiz git log, git diff, git cat-file çalıştırır.
En az bir commit'i olan bir Git deposu olan klasörAtama commit'lere dayanır. Commit yoksa analiz hata vererek durur.
VS Code ≥ 1.90 (eklenti)engines.vscode içinde tanımlıdır.
Node.js ≥ 20 (CLI)engines.node içinde tanımlıdır.
Güvenilir bir çalışma alanı (eklenti)Eklenti Git komutları çalıştırır, bu yüzden Kısıtlı Mod'da (Restricted Mode) devre dışıdır.

Seçenek A — VS Code eklentisi

Kurulum

  • Marketplace'ten: CleanLens arayın (kimlik cleanlens.cleanlens) veya
  • yerel bir derlemeden: npm run package, ardından Extensions → … → Install from VSIX.

İlk çalıştırma

  1. Proje klasörünü (depo kökünü) VS Code'da açın.
  2. Komut Paleti'nden (Cmd/Ctrl+Shift+P) CleanLens: Initialize Project komutunu çalıştırın.
    • CleanLens kök dizindeki dosyalara göre bir ön ayar önerir: manage.py → Django; pyproject.toml / requirements.txt / setup.py → Python; aksi halde JavaScript.
    • Bir ön ayar seçin, önizlemeyi inceleyin, Create'e tıklayın.
    • Bu işlem kök dizine .clean-code-tracker.json dosyasını yazar ve açar. Var olan bir dosyanın üzerine asla yazmaz.
  3. Kuralları gözden geçirin (bkz. 06 — Kural başvurusu).
  4. CleanLens: Run Analysis komutunu çalıştırın (veya CleanLens kenar çubuğundaki ▶ düğmesi). İlerleme bildirimi her aşamayı gösterir; iptal edebilirsiniz.
  5. Pano otomatik olarak açılır. Kenar çubuğundaki Dashboard, Developers ve Violations görünümleri dolar ve her ihlalin altı editörde çizilir.

Kod yazarken

Canlı tanılar varsayılan olarak açıktır: açık olan her JS/TS/Python dosyası, yazmayı bıraktıktan 400 ms sonra dosya düzeyindeki kurallarla yeniden denetlenir. Bkz. 12 — VS Code eklentisi.

Seçenek B — CLI

Bu depodan derleyip çalıştırma

bash
npm install
npm run build
node dist/cli.js /path/to/repo

Paket olarak kurulduktan sonra

bash
cleanlens                       # geçerli dizini analiz et
cleanlens ./my-project --violations
cleanlens --markdown > report.md
cleanlens --json > report.json
cleanlens --preset django --fail-on high

CLI, eklentiyle aynı .clean-code-tracker.json dosyasını okur. --preset bu dosyayı yok sayar ve bunun yerine yerleşik bir ön ayar kullanır. Tüm seçenekler için bkz. 13 — CLI.

İlk raporunuzu okumak

Metin raporu şöyle görünür (değerler örnektir):

text
Developers: 3
Analyzed files: 84
Analyzed commits: 500
Total violations: 212
Unattributed: 0

Alice
  Clean Code Score: 78/100
    duplication 88 · structure 70 · hygiene 82
  Analyzed Lines: 12,400
  Confidence: Highly reliable
  Contribution: 61%
  New Violations: 64
  Fixed Violations: 21
  ...

Nasıl okunur:

  • Score kaliteyi ölçer: yüksek olan daha temizdir. Contribution hacmi ölçer. İkisini ayrı okuyun.
  • Üç alt puan, sorunların nerede olduğunu gösterir.
  • Confidence, puanın ne kadar koda dayandığını söyler. Insufficient ve Provisional puanlara dikkatle yaklaşın.
  • Existing ve Unattributed sayıları bilgi amaçlıdır. Puanı asla düşürmezler.
  • Sıralama eşiğinin altındaki geliştiriciler "Not ranked" altında görünür.

Sonraki adımlar