CleanLens kuralları
Eklenti paketiyle birlikte gelen kısa kural tablosu.
.clean-code-tracker.json içinde yapılandırılan 14 kural. Her kuralın enabled ve severity (low | medium | high | critical) alanları vardır; bazıları ayrıca limit veya options alır.
| Kural kimliği | Ne zaman raporlanır | Varsayılan sınır | JS/TS | Python |
|---|---|---|---|---|
maxFunctionLines | bir fonksiyon sınırdan uzunsa | 40 satır | ✅ | ✅ |
maxFileLines | bir dosya sınırdan uzunsa | 400 satır | ✅ | ✅ |
maxParameters | bir fonksiyon sınırdan fazla parametre alıyorsa | 5 | ✅ | ✅ |
maxComplexity | döngüsel karmaşıklık sınırı aşıyorsa | 10 | ✅ | ✅ (yaklaşık) |
maxNestingDepth | kontrol akışı iç içeliği sınırdan derinse | 4 | ✅ | ✅ (girintiye göre) |
detectDuplicateCode | aynı blok dosyalar arasında tekrarlanıyorsa | options.minLines = 6 | ✅ | ✅ |
detectUnusedCode | bir import / değişken / fonksiyon hiç kullanılmıyorsa | — | ✅ | ✅ (yalnızca import'lar) |
requireClearVariableNames | data1 veya x gibi belirsiz bir ad | — | ✅ | ✅ |
requireErrorHandling | try olmadan başarısız olabilecek bir işlem | — | ✅ (await) | ✅ (open / requests / …) |
forbidEmptyCatchBlocks | boş bir catch / except | — | ✅ | ✅ (pass) |
forbidHardcodedSecrets | kodda bir API anahtarı veya parola | — | ✅ | ✅ |
forbidDebugStatements | console.log / debugger / print / breakpoint | — | ✅ | ✅ |
requireSingleResponsibility | çok metotlu bir sınıf veya hem uzun hem karmaşık bir fonksiyon | options.maxMethods = 10 | ✅ | ✅ |
requireDocumentationForComplexCode | JSDoc / docstring olmadan fonksiyon karmaşıklığı ≥ eşik | options.complexityThreshold = 15 | ✅ | ✅ |
Doğruluk hakkında notlar
requireErrorHandling,requireSingleResponsibility,requireDocumentationForComplexCodedoğaları gereği yaklaşıktır ve yanlış pozitif üretebilir. Ekibiniz için gürültülüyse kapatın veya sınırlarını yükseltin.- Python analizörü girinti ve kalıp tabanlıdır (tam AST yok). İleride daha doğru analiz için planda olduğu gibi Ruff/Pylint entegre edilebilir.
- JS/TS için
detectUnusedCodetip bilgisine sahip değildir — yalnızca bariz durumları yakalar (tam olarak bir kez görünen bir ad).
Tüm ayrıntılar için bkz. 06 — Kural başvurusu.