लिंट जांच की मदद से अपने कोड को बेहतर बनाना

यह पक्का करने के लिए कि आपका ऐप्लिकेशन, काम करने से जुड़ी ज़रूरी शर्तों को पूरा करता है, टेस्ट बनाएं. इसके अलावा, यह भी ज़रूरी है कि आप कोड को लिंट टूल की मदद से चलाएं, ताकि यह पक्का किया जा सके कि आपके कोड में स्ट्रक्चर से जुड़ी कोई समस्या न हो. लिंट टूल की मदद से, खराब तरीके से लिखे गए कोड का पता लगाया जा सकता है. इस तरह के कोड से, आपके Android ऐप्लिकेशन की विश्वसनीयता और परफ़ॉर्मेंस पर असर पड़ सकता है. साथ ही, आपके कोड को मैनेज करना मुश्किल हो सकता है. हमारा सुझाव है कि ऐप्लिकेशन को पब्लिश करने से पहले, लिंट से मिली सभी गड़बड़ियों को ठीक कर लें.

उदाहरण के लिए, अगर आपकी एक्सएमएल रिसॉर्स फ़ाइलों में ऐसे नेमस्पेस शामिल हैं जिनका इस्तेमाल नहीं किया गया है, तो इससे स्टोरेज भर जाता है और बेवजह प्रोसेसिंग की ज़रूरत पड़ती है. स्ट्रक्चर से जुड़ी अन्य समस्याएं, जैसे कि ऐसे एलिमेंट या एपीआई कॉल का इस्तेमाल करना जो अब काम नहीं करते और जिन्हें टारगेट किए गए एपीआई वर्शन के साथ इस्तेमाल नहीं किया जा सकता. इनकी वजह से, हो सकता है कि कोड सही तरीके से काम न करे. Lint की मदद से, इन समस्याओं को ठीक किया जा सकता है.

लिंटिंग की परफ़ॉर्मेंस को बेहतर बनाने के लिए, अपने कोड में एनोटेशन भी जोड़े जा सकते हैं.

खास जानकारी

Android Studio में, कोड स्कैन करने वाला एक टूल उपलब्ध है. इसे लिंट कहा जाता है. इसकी मदद से, कोड के स्ट्रक्चर की क्वालिटी से जुड़ी समस्याओं की पहचान की जा सकती है और उन्हें ठीक किया जा सकता है. इसके लिए, आपको ऐप्लिकेशन को चलाने या टेस्ट केस लिखने की ज़रूरत नहीं पड़ती. टूल से पता चलने वाली हर समस्या की जानकारी, ब्यौरे वाले मैसेज और गंभीरता के लेवल के साथ दी जाती है. इससे आपको यह तय करने में मदद मिलती है कि किन ज़रूरी सुधारों को प्राथमिकता दी जानी चाहिए. किसी समस्या की गंभीरता के लेवल को कम भी किया जा सकता है. इससे उन समस्याओं को अनदेखा किया जा सकता है जो आपके प्रोजेक्ट के लिए काम की नहीं हैं. इसके अलावा, खास समस्याओं को हाइलाइट करने के लिए, गंभीरता के लेवल को बढ़ाया भी जा सकता है.

लिंट टूल, आपके Android प्रोजेक्ट की सोर्स फ़ाइलों की जांच करता है. इससे, संभावित गड़बड़ियों का पता चलता है. साथ ही, यह भी पता चलता है कि सही जानकारी, सुरक्षा, परफ़ॉर्मेंस, इस्तेमाल करने की सुविधा, सुलभता, और अंतरराष्ट्रीय स्तर पर इस्तेमाल करने की सुविधा को बेहतर बनाने के लिए, ऑप्टिमाइज़ेशन में क्या सुधार किए जा सकते हैं. Android Studio का इस्तेमाल करने पर, ऐप्लिकेशन बनाते समय कॉन्फ़िगर किए गए लिंट और आईडीई की जांच की जाती है. हालांकि, इस पेज पर बताए गए तरीके से, जांच को मैन्युअल तरीके से चलाया जा सकता है या कमांड लाइन से लिंट को चलाया जा सकता है.

Android Studio का इस्तेमाल करते समय, पहले से मौजूद लिंट टूल आपके कोड की जांच करता है. चेतावनियां और गड़बड़ियां देखने के दो तरीके हैं:

  • एडिटर विंडो में पॉप-अप टेक्स्ट के तौर पर. जब लिंट को कोई समस्या मिलती है, तो वह समस्या वाले कोड को पीले रंग में हाइलाइट करता है. ज़्यादा गंभीर समस्याओं के लिए, यह कोड को लाल रंग से अंडरलाइन करता है.
  • Code > Inspect Code पर क्लिक करने पर, लिंट Inspection Results विंडो में.

ध्यान दें: जब आपका कोड Android Studio में कंपाइल किया जाता है, तब कोड की समीक्षा को आसान बनाने के लिए, IntelliJ कोड की अतिरिक्त जांच की जाती है. Android Studio को अप-टू-डेट रखें, ताकि लिंट के नए नियम और जांच की सुविधा उपलब्ध हो.

पहली इमेज में दिखाया गया है कि लिंट टूल, ऐप्लिकेशन की सोर्स फ़ाइलों को कैसे प्रोसेस करता है.

लिंट टूल की मदद से कोड स्कैन करने का वर्कफ़्लो.
पहली इमेज. लिंट टूल की मदद से कोड स्कैन करने का वर्कफ़्लो.
ऐप्लिकेशन की सोर्स फ़ाइलें
सोर्स फ़ाइलों में वे फ़ाइलें शामिल होती हैं जिनसे आपका Android प्रोजेक्ट बनता है. इनमें Kotlin और एक्सएमएल फ़ाइलें, आइकॉन, और ProGuard कॉन्फ़िगरेशन फ़ाइलें शामिल हैं.
lint.xml फ़ाइल
एक कॉन्फ़िगरेशन फ़ाइल, जिसका इस्तेमाल करके लिंट की उन जांचों के बारे में बताया जा सकता है जिन्हें आपको शामिल नहीं करना है. साथ ही, समस्या की गंभीरता के लेवल को पसंद के मुताबिक बनाया जा सकता है.
लिंट टूल
यह स्टैटिक कोड स्कैनिंग टूल है. इसे Android Studio या कमांड लाइन से, अपने Android प्रोजेक्ट पर चलाया जा सकता है. लिंट टूल, कोड के स्ट्रक्चर से जुड़ी उन समस्याओं की जांच करता है जिनसे आपके Android ऐप्लिकेशन की क्वालिटी और परफ़ॉर्मेंस पर असर पड़ सकता है.
लिंट चेकिंग के नतीजे
लिंट के नतीजों को कंसोल में या Android Studio में जांच के नतीजे विंडो में देखा जा सकता है. अगर कमांड लाइन से lint को चलाया जाता है, तो नतीजे build/ फ़ोल्डर में सेव हो जाते हैं. ज़्यादा जानकारी के लिए, मैन्युअल तरीके से जांच करने के बारे में सेक्शन देखें.

कमांड लाइन से लिंट चलाना

अगर Android Studio या Gradle का इस्तेमाल किया जा रहा है, तो अपने प्रोजेक्ट के लिए lint टास्क को शुरू करने के लिए, Gradle रैपर का इस्तेमाल करें. इसके लिए, अपने प्रोजेक्ट की रूट डायरेक्ट्री से इनमें से कोई एक कमांड डालें:

ध्यान दें: लिंट के नए नियमों का इस्तेमाल करने के लिए, Android Gradle प्लगिन को अप-टू-डेट रखें.

  • Windows पर:
    gradlew lint
    
  • Linux या macOS पर:
    ./gradlew lint
    

आपको इससे मिलता-जुलता आउटपुट दिखेगा:

> Task :app:lintDebug
Wrote HTML report to file:<path-to-project>/app/build/reports/lint-results-debug.html

लिंट टूल अपनी जांच पूरी करने के बाद, लिंट रिपोर्ट के एक्सएमएल और एचटीएमएल वर्शन के पाथ उपलब्ध कराता है. इसके बाद, एचटीएमएल रिपोर्ट पर जाएं और उसे अपने ब्राउज़र में खोलें, जैसा कि इमेज 2 में दिखाया गया है.

एचटीएमएल लिंट रिपोर्ट का सैंपल
दूसरी इमेज. एचटीएमएल लिंट रिपोर्ट का सैंपल.

अगर आपके प्रोजेक्ट में बिल्ड के वैरिएंट शामिल हैं, तो लिंट सिर्फ़ डिफ़ॉल्ट वैरिएंट की जांच करता है. अगर आपको किसी दूसरे वैरिएंट पर लिंट चलाना है, तो आपको वैरिएंट के नाम को कैपिटल लेटर में लिखना होगा. साथ ही, उसके पहले lint लगाना होगा.

./gradlew lintRelease

ध्यान दें: Lint, आपके बिल्ड के हिस्से के तौर पर अपने-आप नहीं चलता. हमारा सुझाव है कि आप लगातार इंटिग्रेशन बिल्ड के हिस्से के तौर पर, लिंट को साफ़ तौर पर चलाएं. इससे आपको मौजूदा सोर्स कोड बनाते समय, लिंट की नई जांचें दिखेंगी.

कमांड लाइन से Gradle टास्क चलाने के बारे में ज़्यादा जानने के लिए, कमांड लाइन से अपना ऐप्लिकेशन बनाएं लेख पढ़ें.

अलग से उपलब्ध टूल का इस्तेमाल करके लिंट चलाना

अगर Android Studio या Gradle का इस्तेमाल नहीं किया जा रहा है, तो अलग से मौजूद लिंट टूल का इस्तेमाल करने के लिए, Android SDK कमांड-लाइन टूल इंस्टॉल करें. android_sdk/cmdline-tools/version/bin/lint पर लिंट टूल ढूंढें.

ध्यान दें: अगर Gradle प्रोजेक्ट पर स्टैंडअलोन टूल को चलाने की कोशिश की जाती है, तो गड़बड़ी का मैसेज दिखता है. Gradle प्रोजेक्ट पर लिंट चलाने के लिए, आपको हमेशा gradle lint (Windows पर) या ./gradlew lint (macOS या Linux पर) का इस्तेमाल करना चाहिए.

किसी प्रोजेक्ट डायरेक्ट्री में मौजूद फ़ाइलों की सूची के लिए लिंट चलाने के लिए, इस कमांड का इस्तेमाल करें:

lint [flags] <project directory>

उदाहरण के लिए, myproject डायरेक्ट्री और इसकी सबडायरेक्ट्री में मौजूद फ़ाइलों को स्कैन करने के लिए, यह कमांड दिया जा सकता है. समस्या का आईडी MissingPrefix, लिंट को सिर्फ़ उन एक्सएमएल एट्रिब्यूट को स्कैन करने के लिए कहता है जिनमें Android नेमस्पेस प्रीफ़िक्स मौजूद नहीं है.

lint --check MissingPrefix myproject 

टूल के साथ काम करने वाले फ़्लैग और कमांड-लाइन आर्ग्युमेंट की पूरी सूची देखने के लिए, इस कमांड का इस्तेमाल करें:

lint --help

यहां दिए गए उदाहरण में, Earthquake नाम के प्रोजेक्ट के लिए लिंट कमांड चलाने पर कंसोल आउटपुट दिखाया गया है:

$ lint Earthquake

Scanning Earthquake: ...............................................................................................................................
Scanning Earthquake (Phase 2): .......
AndroidManifest.xml:23: Warning: <uses-sdk> tag appears after <application> tag [ManifestOrder]
  <uses-sdk android:minSdkVersion="7" />
  ^
AndroidManifest.xml:23: Warning: <uses-sdk> tag should specify a target API level (the highest verified version; when running on later versions, compatibility behaviors may be enabled) with android:targetSdkVersion="?" [UsesMinSdkAttributes]
  <uses-sdk android:minSdkVersion="7" />
  ^
res: Warning: Missing density variation folders in res: drawable-xhdpi [IconMissingDensityFolder]
0 errors, 4 warnings

आउटपुट के उदाहरण में तीन चेतावनियां दी गई हैं और कोई गड़बड़ी नहीं है.

प्रोजेक्ट की AndroidManifest.xml फ़ाइल से जुड़ी दो चेतावनियां:

  • ManifestOrder
  • UsesMinSdkAttributes

एक चेतावनी res डायरेक्ट्री से जुड़ी है: IconMissingDensityFolder.

चेतावनियों को छिपाने के लिए, लिंट को कॉन्फ़िगर करना

डिफ़ॉल्ट रूप से, लिंट स्कैन चलाने पर, टूल उन सभी समस्याओं की जांच करता है जो लिंट के साथ काम करती हैं. आपके पास यह तय करने का विकल्प भी होता है कि लिंट किन समस्याओं की जांच करे. साथ ही, समस्याओं को उनकी गंभीरता के हिसाब से लेवल असाइन किए जा सकते हैं. उदाहरण के लिए, आपके पास ऐसी समस्याओं के लिए लिंट की जांच को रोकने का विकल्प होता है जो आपके प्रोजेक्ट के लिए काम की नहीं हैं. साथ ही, लिंट को इस तरह कॉन्फ़िगर किया जा सकता है कि वह कम गंभीर समस्याओं को कम गंभीरता के लेवल पर रिपोर्ट करे.

गंभीरता के लेवल ये हैं:

  • enable
  • disable या ignore
  • informational
  • warning
  • error
  • fatal

लिंट चेकिंग को अलग-अलग लेवल के लिए कॉन्फ़िगर किया जा सकता है:

  • ग्लोबल (पूरे प्रोजेक्ट के लिए)
  • प्रोजेक्ट मॉड्यूल
  • प्रोडक्शन मॉड्यूल
  • टेस्ट मॉड्यूल
  • फ़ाइल खोलो
  • क्लास की हैरारकी
  • वर्शन कंट्रोल सिस्टम (वीसीएस) के स्कोप

लिंट फ़ाइल को कॉन्फ़िगर करना

lint.xml फ़ाइल में जाकर, लिंट की जांच से जुड़ी अपनी प्राथमिकताएं तय की जा सकती हैं. अगर इस फ़ाइल को मैन्युअल तरीके से बनाया जा रहा है, तो इसे अपने Android प्रोजेक्ट की रूट डायरेक्ट्री में रखें.

lint.xml फ़ाइल में एक <lint> पैरंट टैग होता है. इसमें एक या इससे ज़्यादा चाइल्ड <issue> एलिमेंट होते हैं. Lint, हर <issue> के लिए id एट्रिब्यूट की एक यूनीक वैल्यू तय करता है:

<?xml version="1.0" encoding="UTF-8"?>
<lint>
    <!-- list of issues to configure -->
</lint>

किसी समस्या की गंभीरता के लेवल को बदलने या उस समस्या के लिए लिंट चेकिंग की सुविधा बंद करने के लिए, <issue> टैग में गंभीरता एट्रिब्यूट सेट करें.

अहम जानकारी: लिंट की मदद से पहचानी जा सकने वाली समस्याओं और उनके आईडी की पूरी सूची देखने के लिए, lint --list कमांड चलाएं. --list विकल्प को स्टैंडअलोन लिंट टूल से चलाना ज़रूरी है.

lint.xml फ़ाइल का सैंपल

यहां दिए गए उदाहरण में, lint.xml फ़ाइल का कॉन्टेंट दिखाया गया है:

<?xml version="1.0" encoding="UTF-8"?>
<lint>
    <!-- Disable the ComposableNaming check in this project -->
    <issue id="ComposableNaming" severity="ignore" />

    <!-- Ignore the ComposeUnrememberedState issue in the specified files -->
    <issue id="ComposeUnrememberedState">
        <ignore path="src/main/java/com/example/myapp/MainActivity.kt" />
        <ignore path="src/main/java/com/example/myapp/ui/components/SpecialButton.kt" />
    </issue>

    <!-- Ignore the ComposeModifierMissing issue in the specified file -->
    <issue id="ComposeModifierMissing">
        <ignore path="src/main/java/com/example/myapp/ui/screens/HomeScreen.kt" />
    </issue>

    <!-- Change the severity of hardcoded strings to "error" -->
    <issue id="HardcodedText" severity="error" />
</lint>

इस उदाहरण में बताया गया है कि समस्या के अलग-अलग टाइप कैसे कॉन्फ़िगर किए जाते हैं. ComposableNaming की जांच पूरी तरह से बंद है. साथ ही, ComposeUnrememberedState की जांच सिर्फ़ उन फ़ाइलों में बंद है जिनके बारे में, शामिल किए गए <ignore ... /> एलान में बताया गया है.

Kotlin और एक्सएमएल सोर्स फ़ाइलों के लिए, लिंट चेकिंग को कॉन्फ़िगर करना

Preferences डायलॉग बॉक्स में जाकर, Kotlin और एक्सएमएल सोर्स फ़ाइलों के लिए लिंट चेकिंग की सुविधा बंद की जा सकती है:

  1. Windows पर, File > Settings या macOS या Linux पर, Android Studio > Preferences को चुनें.
  2. एडिटर > जांच को चुनें.
  3. इसे बंद करने के लिए, सोर्स फ़ाइल से चुने हुए का निशान हटाएं.

इन्हें IDE या अलग-अलग प्रोजेक्ट के लिए सेट किया जा सकता है. इसके लिए, सही प्रोफ़ाइल चुनें.

Kotlin में लिंट चेकिंग को कॉन्फ़िगर करना

अपने Android प्रोजेक्ट में किसी क्लास या फ़ंक्शन के लिए लिंट चेकिंग की सुविधा बंद करने के लिए, उस कोड में @SuppressLint एनोटेशन जोड़ें.

यहां दिए गए उदाहरण में, किसी फ़ंक्शन में NewApi समस्या के लिए लिंट चेकिंग को बंद करने का तरीका बताया गया है. लिंट टूल, इस क्लास के अन्य फ़ंक्शन में NewApi से जुड़ी समस्या की जांच करता रहता है.

@SuppressLint("NewApi")
fun logNotificationChannelInfo() {
    // Uses NotificationChannel (requires API 26+)
    // ...
}

किसी भी कंपोज़ेबल पर ऐसा किया जा सकता है. यहां दिए गए कोड स्निपेट में बताया गया है कि किसी भी कंपोज़ेबल पर, NewApi की जांच की सुविधा को कैसे बंद किया जा सकता है.

@SuppressLint("NewApi")
@Composable
fun MyComposable() {
    // ...
}

यहां दिए गए उदाहरण में, FeedProvider क्लास में ParserError समस्या के लिए लिंट चेकिंग को बंद करने का तरीका बताया गया है:

@SuppressLint("ParserError")
class FeedProvider : ContentProvider() {

फ़ाइल में लिंट से जुड़ी सभी समस्याओं की जांच को रोकने के लिए, all कीवर्ड का इस्तेमाल करें:

@SuppressLint("all")

किसी भी कंपोज़ेबल फ़ंक्शन पर लिंट की जांच को रोकने के लिए, उसी एनोटेशन का इस्तेमाल किया जा सकता है.

एक्सएमएल में लिंट की जांच को कॉन्फ़िगर करना

अपनी एक्सएमएल फ़ाइलों के कुछ सेक्शन के लिए, लिंट चेकिंग की सुविधा बंद करने के लिए, tools:ignore एट्रिब्यूट का इस्तेमाल करें. lint.xml फ़ाइल में, यहां दी गई नेमस्पेस वैल्यू डालें, ताकि लिंट टूल एट्रिब्यूट की पहचान कर सके:

namespace xmlns:tools="http://schemas.android.com/tools"

यहां दिए गए उदाहरण में, strings.xml फ़ाइल के <resources> एलिमेंट में UnusedResources समस्या के लिए, लिंट चेकिंग को बंद करने का तरीका बताया गया है. ignore एट्रिब्यूट को उस पैरंट एलिमेंट के चाइल्ड एलिमेंट से इनहेरिट किया जाता है जहां एट्रिब्यूट का एलान किया जाता है. इस उदाहरण में, शामिल किए गए सभी <string> एलिमेंट के लिए भी लिंट की जांच बंद है:

<resources
    xmlns:tools="http://schemas.android.com/tools"
    tools:ignore="UnusedResources" >

    <string name="app_name">My App</string>
    <string name="unused_string">Unused String</string>
</resources>

एक से ज़्यादा समस्याओं को बंद करने के लिए, बंद की जाने वाली समस्याओं को कॉमा लगाकर अलग किए गए स्ट्रिंग में शामिल करें. उदाहरण के लिए:

tools:ignore="NewApi,StringFormatInvalid"

एक्सएमएल एलिमेंट में लिंट से जुड़ी सभी समस्याओं की जांच को रोकने के लिए, all कीवर्ड का इस्तेमाल करें:

tools:ignore="all"

Gradle की मदद से लिंट के विकल्प कॉन्फ़िगर करना

Android Gradle प्लगिन की मदद से, लिंट के कुछ विकल्प कॉन्फ़िगर किए जा सकते हैं. जैसे, कौनसी जांच करनी है या कौनसी नहीं. इसके लिए, आपको मॉड्यूल-लेवल की build.gradle फ़ाइल में lint{} ब्लॉक का इस्तेमाल करना होगा.

नीचे दिए गए कोड स्निपेट में, कुछ ऐसी प्रॉपर्टी दिखाई गई हैं जिन्हें कॉन्फ़िगर किया जा सकता है:

Kotlin

android {
    ...
    lint {
        // Turns off checks for the issue IDs you specify.
        disable += "TypographyFractions" + "TypographyQuotes"
        // Turns on checks for the issue IDs you specify. These checks are in
        // addition to the default lint checks.
        enable += "RtlHardcoded" + "RtlCompat" + "RtlEnabled"
        // To enable checks for only a subset of issue IDs and ignore all others,
        // list the issue IDs with the 'check' property instead. This property overrides
        // any issue IDs you enable or disable using the properties above.
        checkOnly += "NewApi" + "InlinedApi"
        // If set to true, turns off analysis progress reporting by lint.
        quiet = true
        // If set to true (default), stops the build if errors are found.
        abortOnError = false
        // If set to true, lint only reports errors.
        ignoreWarnings = true
        // If set to true, lint also checks all dependencies as part of its analysis.
        // Recommended for projects consisting of an app with library dependencies.
        checkDependencies = true
    }
}
...

Groovy

android {
    ...
    lint {
        // Turns off checks for the issue IDs you specify.
        disable 'TypographyFractions','TypographyQuotes'
        // Turns on checks for the issue IDs you specify. These checks are in
        // addition to the default lint checks.
        enable 'RtlHardcoded','RtlCompat', 'RtlEnabled'
        // To enable checks for only a subset of issue IDs and ignore all others,
        // list the issue IDs with the 'check' property instead. This property overrides
        // any issue IDs you enable or disable using the properties above.
        checkOnly 'NewApi', 'InlinedApi'
        // If set to true, turns off analysis progress reporting by lint.
        quiet true
        // If set to true (default), stops the build if errors are found.
        abortOnError false
        // If set to true, lint only reports errors.
        ignoreWarnings true
        // If set to true, lint also checks all dependencies as part of its analysis.
        // Recommended for projects consisting of an app with library dependencies.
        checkDependencies true
    }
}
...

किसी समस्या की गंभीरता के लेवल को बदलने वाले सभी लिंट तरीके, कॉन्फ़िगरेशन के क्रम का पालन करते हैं. उदाहरण के लिए, finalizeDsl() में किसी समस्या को गंभीर के तौर पर सेट करने से, मुख्य डीएसएल में उसे बंद करने की सेटिंग बदल जाती है.

चेतावनियों की बेसलाइन बनाना

अपने प्रोजेक्ट की मौजूदा चेतावनियों का स्नैपशॉट लिया जा सकता है. इसके बाद, स्नैपशॉट का इस्तेमाल आने वाले समय में जांच के लिए बेसलाइन के तौर पर किया जा सकता है, ताकि सिर्फ़ नई समस्याओं की शिकायत की जा सके. बेसलाइन स्नैपशॉट की मदद से, लिंट का इस्तेमाल करके बिल्ड को फ़ेल किया जा सकता है. इसके लिए, आपको पहले से मौजूद सभी समस्याओं को ठीक करने की ज़रूरत नहीं है.

बेसलाइन स्नैपशॉट बनाने के लिए, अपने प्रोजेक्ट की build.gradle फ़ाइल में यह बदलाव करें:

Kotlin

android {
    lint {
        baseline = file("lint-baseline.xml")
    }
}

Groovy

android {
    lintOptions {
        baseline file("lint-baseline.xml")
    }
}

इस लाइन को पहली बार जोड़ने पर, आपकी बेसलाइन तय करने के लिए lint-baseline.xml फ़ाइल बनाई जाती है. इसके बाद, टूल सिर्फ़ बेसलाइन तय करने के लिए फ़ाइल को पढ़ते हैं. अगर आपको नई बेसलाइन बनानी है, तो फ़ाइल को मैन्युअल तरीके से मिटाएं. इसके बाद, उसे फिर से बनाने के लिए लिंट को फिर से चलाएं.

इसके बाद, IDE से लिंट को चलाने के लिए, कोड > कोड की जांच करें को चुनें या कमांड लाइन से लिंट को चलाने के लिए, यह तरीका अपनाएं. आउटपुट में, lint-baseline.xml फ़ाइल की जगह की जानकारी दिखती है. आपके सेटअप के लिए फ़ाइल की जगह, यहां दिखाई गई जगह से अलग हो सकती है:

$ ./gradlew lintDebug -Dlint.baselines.continue=true
...
Wrote XML report to file:///app/lint-baseline.xml
Created baseline file /app/lint-baseline.xml

lint को चलाने से, lint-baseline.xml फ़ाइल में मौजूद सभी मौजूदा समस्याएं रिकॉर्ड हो जाती हैं. मौजूदा समस्याओं के सेट को बेसलाइन कहा जाता है. lint-baseline.xml फ़ाइल को वर्शन कंट्रोल में चेक किया जा सकता है, ताकि उसे दूसरों के साथ शेयर किया जा सके.

बेसलाइन को पसंद के मुताबिक बनाना

अगर आपको बेसलाइन में सिर्फ़ कुछ खास तरह की समस्याएं जोड़नी हैं, तो अपने प्रोजेक्ट की build.gradle फ़ाइल में बदलाव करके, जोड़ी जाने वाली समस्याएं बताएं. इसके लिए, यह तरीका अपनाएं:

Kotlin

android {
    lint {
        checkOnly += "NewApi" + "HandlerLeak"
        baseline = file("lint-baseline.xml")
    }
}

Groovy

android {
    lintOptions {
        checkOnly 'NewApi', 'HandlerLeak'
        baseline file("lint-baseline.xml")
    }
}

अगर बेसलाइन बनाने के बाद, कोड बेस में कोई नई चेतावनी जोड़ी जाती है, तो लिंट सिर्फ़ नए बग की सूची दिखाता है.

बेसलाइन से जुड़ी चेतावनी

जब कोई बेसलाइन लागू होती है, तो आपको जानकारी देने वाली चेतावनी मिलती है. इससे आपको पता चलता है कि एक या उससे ज़्यादा समस्याएं फ़िल्टर कर दी गई हैं, क्योंकि वे बेसलाइन में शामिल हैं. इस चेतावनी से आपको यह याद रखने में मदद मिलती है कि आपने बेसलाइन कॉन्फ़िगर की है और आपको किसी समय सभी समस्याओं को ठीक करना होगा.

जानकारी देने वाली यह चेतावनी, उन समस्याओं को भी ट्रैक करती है जिनकी शिकायत अब नहीं की जाती. इस जानकारी से आपको पता चलता है कि आपने समस्याओं को वाकई ठीक कर लिया है या नहीं. इससे आपको बेसलाइन को फिर से बनाने का विकल्प मिलता है, ताकि किसी गड़बड़ी का पता लगाए बिना उसे वापस आने से रोका जा सके.

ध्यान दें: आईडीई में बैच मोड में जांच करने पर, बेसलाइन चालू हो जाती हैं. हालांकि, किसी फ़ाइल में बदलाव करते समय बैकग्राउंड में चलने वाली इन-एडिटर जांच के लिए, इन्हें अनदेखा कर दिया जाता है. ऐसा इसलिए है, क्योंकि बेसलाइन का मकसद ऐसे मामलों में मदद करना है जहां कोड बेस में पहले से ही कई चेतावनियां मौजूद हों, लेकिन आपको कोड में बदलाव करते समय, समस्याओं को स्थानीय तौर पर ठीक करना हो.

मैन्युअल तरीके से जांच करना

कॉन्फ़िगर किए गए लिंट और अन्य आईडीई जांचों को मैन्युअल तरीके से चलाने के लिए, कोड > कोड की जांच करें को चुनें. जांच के नतीजे, जांच के नतीजे विंडो में दिखते हैं.

जांच का दायरा और प्रोफ़ाइल सेट करना

जिन फ़ाइलों का विश्लेषण करना है उन्हें चुनें (जांच का स्कोप) और जो जांच करनी है उन्हें चुनें (जांच की प्रोफ़ाइल). इसके लिए, यह तरीका अपनाएं:

  1. Android व्यू में, अपना प्रोजेक्ट खोलें. इसके बाद, वह प्रोजेक्ट, फ़ोल्डर या फ़ाइल चुनें जिसका आपको विश्लेषण करना है.
  2. मेन्यू बार में जाकर, Code > Inspect Code को चुनें.
  3. Specify Inspection Scope डायलॉग बॉक्स में, सेटिंग देखें.

    जांच के दायरे की सेटिंग देखना
    तीसरी इमेज. जांच के दायरे की सेटिंग देखें.

    Specify Inspection Scope डायलॉग में दिखने वाले विकल्प, इस बात पर निर्भर करते हैं कि आपने कोई प्रोजेक्ट, फ़ोल्डर या फ़ाइल चुनी है या नहीं:

    • किसी प्रोजेक्ट, फ़ाइल या डायरेक्ट्री को चुनने पर, Specify Inspection Scope डायलॉग बॉक्स में, चुने गए प्रोजेक्ट, फ़ाइल या डायरेक्ट्री का पाथ दिखता है.
    • एक से ज़्यादा प्रोजेक्ट, फ़ाइल या डायरेक्ट्री चुनने पर, जांच का दायरा तय करें डायलॉग बॉक्स में, चुनी गई फ़ाइलें के लिए चुना गया रेडियो बटन दिखता है.

    जांच करने के लिए, कोई दूसरा रेडियो बटन चुनें. जांच का दायरा तय करें डायलॉग बॉक्स में मौजूद सभी संभावित फ़ील्ड की जानकारी के लिए, जांच का दायरा तय करें डायलॉग बॉक्स देखें.

  4. जांच प्रोफ़ाइल में जाकर, वह प्रोफ़ाइल चुनें जिसका आपको इस्तेमाल करना है.
  5. जांच शुरू करने के लिए, ठीक है पर क्लिक करें.

    चौथी इमेज में, कोड की जांच करें रन से लिंट और अन्य IDE जांच के नतीजे दिखाए गए हैं:

    किसी समस्या का समाधान देखने के लिए, उसे चुनें.
    चौथी इमेज. जांच के नतीजे. समस्या का समाधान देखने के लिए, कोई समस्या चुनें.
  6. जांच के नतीजे पैनल में, गड़बड़ी की कैटगरी, टाइप या समस्याओं को बड़ा करके और चुनकर, जांच के नतीजे देखें.

    जांच की रिपोर्ट पैनल में, जांच के नतीजे पैनल में चुनी गई गड़बड़ी की कैटगरी, टाइप या समस्या की जांच की रिपोर्ट दिखती है. साथ ही, गड़बड़ी का नाम और जगह की जानकारी दिखती है. जहां लागू हो वहां जांच रिपोर्ट में अन्य जानकारी दिखती है. जैसे, समस्या की खास जानकारी. इससे आपको समस्या को ठीक करने में मदद मिलती है.

  7. जांच के नतीजे पैनल के ट्री व्यू में, किसी कैटगरी, टाइप या समस्या पर राइट क्लिक करें. इससे कॉन्टेक्स्ट मेन्यू दिखेगा.

    कॉन्टेंट के हिसाब से, ये काम किए जा सकते हैं:

    • सोर्स पर जाएं.
    • चुने गए आइटम शामिल करना और हटाना.
    • समस्याओं को दबाना.
    • सेटिंग में बदलाव करें.
    • जांच से जुड़ी सूचनाएं मैनेज करना.
    • जांच फिर से करना.

टूलबार के बटन, कॉन्टेक्स्ट मेन्यू के आइटम, और जांच रिपोर्ट के फ़ील्ड की जानकारी के लिए, जांच के नतीजों की टूल विंडो देखें.

कस्टम स्कोप का इस्तेमाल करना

Android Studio में दिए गए कस्टम स्कोप में से किसी एक का इस्तेमाल करें. इसके लिए, यह तरीका अपनाएं:

  1. जांच का दायरा तय करें डायलॉग बॉक्स में, कस्टम दायरा चुनें.
  2. विकल्प देखने के लिए, कस्टम स्कोप सूची पर क्लिक करें:

    वह Inspection Scope चुनें जिसका आपको इस्तेमाल करना है
    पांचवीं इमेज. चुनें कि आपको किस कस्टम स्कोप का इस्तेमाल करना है.
    • सभी जगहें: सभी फ़ाइलें.
    • प्रोजेक्ट की फ़ाइलें: मौजूदा प्रोजेक्ट की सभी फ़ाइलें.
    • प्रोजेक्ट की सोर्स फ़ाइलें: सिर्फ़ मौजूदा प्रोजेक्ट की सोर्स फ़ाइलें.
    • प्रोजेक्ट की प्रोडक्शन फ़ाइलें: मौजूदा प्रोजेक्ट की सिर्फ़ प्रोडक्शन फ़ाइलें.
    • प्रोजेक्ट की टेस्ट फ़ाइलें: मौजूदा प्रोजेक्ट में मौजूद सिर्फ़ टेस्ट फ़ाइलें.
    • स्क्रैच और कंसोल: सिर्फ़ वे स्क्रैच फ़ाइलें और कंसोल जो आपने मौजूदा प्रोजेक्ट में खोले हैं.
    • हाल ही में देखी गई फ़ाइलें: मौजूदा प्रोजेक्ट में हाल ही में देखी गई फ़ाइलें.
    • मौजूदा फ़ाइल: आपके मौजूदा प्रोजेक्ट की सिर्फ़ मौजूदा फ़ाइल. यह तब दिखता है, जब आपने कोई फ़ाइल या फ़ोल्डर चुना हो.
    • चुनी गई डायरेक्ट्री: आपके मौजूदा प्रोजेक्ट का सिर्फ़ मौजूदा फ़ोल्डर. यह तब दिखता है, जब आपने कोई फ़ोल्डर चुना हो.
    • क्लास की हैरारकी: इस विकल्प को चुनने और ठीक है पर क्लिक करने के बाद, एक डायलॉग बॉक्स दिखता है. इसमें मौजूदा प्रोजेक्ट की सभी क्लास मौजूद होती हैं. डायलॉग बॉक्स में, नाम के हिसाब से खोजें फ़ील्ड का इस्तेमाल करके, क्लास को फ़िल्टर करें और जांच के लिए क्लास चुनें. अगर क्लास की सूची को फ़िल्टर नहीं किया जाता है, तो कोड की जांच करने वाला टूल सभी क्लास की जांच करता है.
  3. अगर आपने प्रोजेक्ट के लिए वीसीएस कॉन्फ़िगर किया है, तो खोज को सिर्फ़ उन फ़ाइलों तक सीमित करने के विकल्प भी मौजूद हैं जिनमें बदलाव किया गया है.

  4. ठीक है पर क्लिक करें.

कस्टम स्कोप बनाना

अगर आपको ऐसी फ़ाइलों और डायरेक्ट्री की जांच करनी है जो उपलब्ध कस्टम स्कोप में से किसी में भी शामिल नहीं हैं, तो कस्टम स्कोप बनाया जा सकता है:

  1. जांच का दायरा तय करें डायलॉग बॉक्स में, कस्टम दायरा चुनें.
  2. कस्टम स्कोप सूची के बाद, तीन बिंदुओं पर क्लिक करें.

    Specify Inspection Scope dialog
    छठी इमेज. Specify Inspection Scope dialog.

    आपको स्कोप डायलॉग दिखेगा.

    कस्टम स्कोप बनाना
    सातवीं इमेज. कस्टम स्कोप बनाएं.
  3. नया स्कोप तय करने के लिए, डायलॉग बॉक्स के सबसे ऊपर बाएं कोने में मौजूद बटन पर क्लिक करें.
  4. इसके बाद, दायरा जोड़ें सूची में, लोकल को चुनें.

    कोड की जांच करें सुविधा के लिए, प्रोजेक्ट में लोकल और शेयर किए गए, दोनों स्कोप का इस्तेमाल किया जाता है. शेयर किए गए स्कोप का इस्तेमाल, प्रोजेक्ट की उन अन्य सुविधाओं के साथ भी किया जा सकता है जिनमें स्कोप फ़ील्ड होता है. उदाहरण के लिए, इस्तेमाल की गई जगहें ढूंढें की सेटिंग बदलने के लिए, सेटिंग में बदलाव करें पर क्लिक करने पर, आपको एक डायलॉग बॉक्स दिखेगा. इसमें स्कोप फ़ील्ड होगा, जहां शेयर किया गया स्कोप चुना जा सकता है.

    Find Usages डायलॉग से, शेयर किया गया स्कोप चुनें
    आठवीं इमेज. Find Usages डायलॉग से, शेयर किया गया कोई स्कोप चुनें.
  5. स्कोप को कोई नाम दें और ठीक है पर क्लिक करें.

    स्कोप डायलॉग बॉक्स के दाएं पैनल में, कस्टम स्कोप तय करने के विकल्प दिखते हैं.

  6. सूची में से, प्रोजेक्ट को चुनें.

    इसके बाद, उपलब्ध प्रोजेक्ट की सूची दिखेगी.

    ध्यान दें: प्रोजेक्ट या पैकेज के लिए कस्टम स्कोप बनाया जा सकता है. इसके लिए, ऊपर बताया गया तरीका ही अपनाएं.

  7. प्रोजेक्ट फ़ोल्डर को बड़ा करें और चुनें कि आपको कस्टम स्कोप में क्या जोड़ना है. इसके बाद, चुनें कि उसे शामिल करना है या नहीं.

    कस्टम स्कोप तय करना
    नौवीं इमेज. पसंद के मुताबिक स्कोप तय करें.
    • शामिल करें: इस फ़ोल्डर और इसकी फ़ाइलों को शामिल करें. हालांकि, इसके किसी भी सब-फ़ोल्डर को शामिल न करें.
    • बार-बार शामिल करें: इस फ़ोल्डर और इसकी फ़ाइलों के साथ-साथ इसके सब-फ़ोल्डर और उनकी फ़ाइलों को भी शामिल करें.
    • शामिल न करें: इस फ़ोल्डर और इसकी फ़ाइलों को शामिल न करें. हालांकि, इसके किसी भी सब-फ़ोल्डर को शामिल करें.
    • बार-बार शामिल न करें: इस फ़ोल्डर और इसकी फ़ाइलों के साथ-साथ इसके सब-फ़ोल्डर और उनकी फ़ाइलों को शामिल न करें.

    इमेज 10 से पता चलता है कि main फ़ोल्डर शामिल है. साथ ही, java और res फ़ोल्डर बार-बार शामिल किए गए हैं. नीले रंग का मतलब है कि फ़ोल्डर को आंशिक रूप से शामिल किया गया है. वहीं, हरे रंग का मतलब है कि फ़ोल्डर और फ़ाइलों को बार-बार शामिल किया गया है.

    कस्टम स्कोप के लिए पैटर्न का उदाहरण
    इमेज 10. कस्टम स्कोप के लिए पैटर्न का उदाहरण.
    • अगर आपने java फ़ोल्डर को चुना है और Exclude Recursively पर क्लिक किया है, तो java फ़ोल्डर और उसके अंदर मौजूद सभी फ़ोल्डर और फ़ाइलों से हरे रंग की हाइलाइट हट जाएगी.
    • अगर हरे रंग से हाइलाइट की गई MainActivity.kt फ़ाइल को चुनकर शामिल न करें पर क्लिक किया जाता है, तो MainActivity.kt फ़ाइल हरे रंग से हाइलाइट नहीं होगी. हालांकि, java फ़ोल्डर में मौजूद बाकी सभी चीज़ें हरे रंग से हाइलाइट रहेंगी.
  8. ठीक है पर क्लिक करें. कस्टम स्कोप, सूची में सबसे नीचे दिखता है.

जांच प्रोफ़ाइलों की समीक्षा करना और उनमें बदलाव करना

Android Studio में लिंट और अन्य जांच प्रोफ़ाइलें चुनी जा सकती हैं. इन्हें Android अपडेट के ज़रिए अपडेट किया जाता है. इन प्रोफ़ाइलों का इस्तेमाल, मौजूदा स्थिति में किया जा सकता है. इसके अलावा, इनके नाम, ब्यौरे, गंभीरता, और स्कोप में बदलाव किया जा सकता है. आपके पास प्रोफ़ाइलों के पूरे ग्रुप या किसी ग्रुप में मौजूद अलग-अलग प्रोफ़ाइलों को चालू और बंद करने का विकल्प भी होता है.

जांच की सेटिंग ऐक्सेस करने के लिए:

  1. फ़ाइल > सेटिंग को चुनें. (Windows पर) या Android Studio > Preferences (macOS या Linux पर).
  2. एडिटर > जांच को चुनें.
  3. जांच पैनल में, जांच के लिए उपलब्ध विकल्पों की सूची और उनके ब्यौरे दिखते हैं.

    इस्तेमाल की जा सकने वाली जांचें और उनकी जानकारी
    इमेज 11. इस्तेमाल की जा सकने वाली जांच और उनकी जानकारी.
  4. डिफ़ॉल्ट (Android Studio) और प्रोजेक्ट डिफ़ॉल्ट (ऐक्टिव प्रोजेक्ट) जांच के बीच टॉगल करने के लिए, प्रोफ़ाइल सूची चुनें.

    ज़्यादा जानकारी के लिए, IntelliJ का प्रोफ़ाइलें मैनेज करें पेज देखें.

  5. बाईं ओर मौजूद पैनल में, जांच की सूची में जाकर, टॉप-लेवल की प्रोफ़ाइल कैटगरी चुनें या किसी ग्रुप को बड़ा करें और कोई खास प्रोफ़ाइल चुनें.

    प्रोफ़ाइल की कोई कैटगरी चुनने पर, उस कैटगरी में मौजूद सभी जांचों में एक साथ बदलाव किया जा सकता है.

  6. निरीक्षणों को कॉपी करने, उनका नाम बदलने, उनमें ब्यौरे जोड़ने, उन्हें एक्सपोर्ट करने, और इंपोर्ट करने के लिए, स्कीमा कार्रवाइयां दिखाएं स्कीमा ऐक्शन आइकॉन दिखाएं सूची को चुनें.
  7. काम पूरा हो जाने पर, ठीक है पर क्लिक करें.