Detekt Kotlin: पूर्ण गाइड उदाहरणों के साथ

1. Detekt क्या है और इसकी आवश्यकता क्यों है?

Detekt Kotlin भाषा के लिए एक शक्तिशाली स्टैटिक कोड एनालिसिस टूल है, जिसे Arturbosch कंपनी ने बनाया है और समुदाय द्वारा समर्थित है। यह Kotlin प्रोजेक्ट्स में संभावित समस्याओं, कोड स्मेल्स (code smells), स्टाइल उल्लंघनों और कमजोरियों को स्वचालित रूप से पहचानने के लिए डिज़ाइन किया गया है। Detekt एब्सट्रैक्ट सिंटैक्स ट्री (AST) स्तर पर काम करता है, जो इसे सामान्य टेक्स्ट लिंटर्स की तुलना में कोड का गहराई से विश्लेषण करने में सक्षम बनाता है। यह टूल Gradle, Maven और अन्य CI/CD टूल्स के साथ एकीकृत होता है, जो इसे टीम डेवलपमेंट में कोड गुणवत्ता बनाए रखने के लिए अपरिहार्य बनाता है।

Detekt की आवश्यकता क्यों है? पहला, यह Kotlin Coding Conventions के अनुसार कोड की जाँच को स्वचालित करता है, जो कई डेवलपर्स वाले बड़े प्रोजेक्ट्स में विशेष रूप से महत्वपूर्ण है। दूसरा, Detekt शुरुआती चरणों में संभावित बग्स को पहचानने में मदद करता है: जैसे अनुपयोगी वेरिएबल, संभावित NullPointerException, जटिल कंडीशनल स्ट्रक्चर और अन्य समस्याएं जो रनटाइम में त्रुटियाँ पैदा कर सकती हैं। तीसरा, यह टूल रिफैक्टरिंग को बढ़ावा देता है: यह उच्च साइक्लोमैटिक कॉम्प्लेक्सिटी वाले कोड सेक्शन, लंबे फंक्शन, अनावश्यक एल्विस ऑपरेटर और अन्य पैटर्न को हाइलाइट करता है जो कोड की पठनीयता और रखरखाव को खराब करते हैं।

Detekt 150 से अधिक बिल्ट-इन नियम प्रदान करता है, जो श्रेणियों में विभाजित हैं: संभावित बग्स (potential bugs), कोड स्टाइल (style), प्रदर्शन (performance), जटिलता (complexity), अपवाद (exceptions) और अन्य। यह टूल पूरी तरह से कस्टमाइज़ेबल है: आप अलग-अलग नियमों को चालू/बंद कर सकते हैं, उनकी थ्रेशोल्ड वैल्यू बदल सकते हैं, और Kotlin में अपने स्वयं के नियम भी लिख सकते हैं। Detekt HTML, XML, SARIF और टेक्स्ट फॉर्मेट में रिपोर्ट जनरेट करने का समर्थन करता है, जिससे इसे किसी भी कोड एनालिसिस सिस्टम के साथ एकीकृत किया जा सकता है।

2. इंस्टॉलेशन

Detekt को Gradle बिल्ड सिस्टम के प्लगइन के रूप में (अनुशंसित तरीका) या एक अलग CLI टूल के रूप में इंस्टॉल किया जाता है। नीचे इंस्टॉलेशन के लिए सटीक कमांड दिए गए हैं।

Gradle के माध्यम से इंस्टॉलेशन (प्लगइन)

build.gradle.kts (या build.gradle) फ़ाइल में जोड़ें:

// build.gradle.kts
plugins {
    id("io.gitlab.arturbosch.detekt") version "1.23.6" // लेखन के समय नवीनतम संस्करण
}

// Detekt कॉन्फ़िगरेशन (वैकल्पिक)
detekt {
    buildUponDefaultConfig = true // डिफ़ॉल्ट नियम + अपने नियम उपयोग करें
    allRules = false // सभी नियम चालू न करें (केवल अनुशंसित)
    config.setFrom("$projectDir/config/detekt/detekt.yml") // कॉन्फ़िग फ़ाइल का पथ
    baseline = file("$projectDir/config/detekt/baseline.xml") // त्रुटियों को अनदेखा करने के लिए बेसलाइन
    reports {
        html.required.set(true) // HTML रिपोर्ट जनरेट करें
        xml.required.set(true) // XML रिपोर्ट जनरेट करें
        txt.required.set(true) // टेक्स्ट रिपोर्ट जनरेट करें
    }
}

प्लगइन जोड़ने के बाद, यह कमांड चलाएँ:

./gradlew detekt

CLI के माध्यम से इंस्टॉलेशन (macOS/Linux के लिए Homebrew)

brew install detekt

SDKMAN के माध्यम से इंस्टॉलेशन

sdk install detekt

JAR के माध्यम से इंस्टॉलेशन (सार्वभौमिक तरीका)

curl -sSLO https://github.com/detekt/detekt/releases/download/v1.23.6/detekt-cli-1.23.6-all.jar
alias detekt='java -jar detekt-cli-1.23.6-all.jar'

3. त्वरित शुरुआत — न्यूनतम कार्यशील उदाहरण

एक सरल Kotlin फ़ाइल src/main/kotlin/example.kt बनाएँ:

// example.kt
fun main() {
    val x = 1
    val y = 2
    if (x > 0) {
        println("Positive")
    } else {
        println("Non-positive")
    }
    println("Sum: ${x + y}")
}

एक कॉन्फ़िगरेशन फ़ाइल config/ बनाएँ: