क्लोज़र लिंटर को इस्तेमाल करने का तरीका

ध्यान दें: क्लोज़र लिंटर के इस्तेमाल पर रोक लगा दी गई है और Google में शायद ही कभी इसका इस्तेमाल होता है. ज़्यादा जानकारी के लिए, यह पेज देखें

यह दस्तावेज़, क्लोज़र लिंटर को इंस्टॉल करने और उसका इस्तेमाल करने का तरीका बताता है.

क्लोज़र लिंटर इंस्टॉल करें

Closure Linter को डाउनलोड और इंस्टॉल करने के लिए Python pip का उपयोग करें.

Linux

Linux पर क्लोज़र लिंटर इंस्टॉल करने के लिए, नीचे दिए गए निर्देशों का पालन करें:

$ sudo apt-get install python-pip
$ sudo pip install https://github.com/google/closure-linter/zipball/master

Mac OS X

Mac OS X पर क्लोज़र लिंटर इंस्टॉल करने के लिए, यह निर्देश दें:

$ sudo easy_install pip
$ sudo pip install https://github.com/google/closure-linter/zipball/master

Windows

Windows पर क्लोज़र लिंटर इंस्टॉल करने के लिए:

  1. Windows के लिए Python डाउनलोड करके इंस्टॉल करें.
  2. यह कमांड चलाएं:
> pip install https://github.com/google/closure-linter/zipball/master

ध्यान दें: क्लोज़र लिंटर के लिए Windows की सुविधा एक्सपेरिमेंटल है.

स्टाइल से जुड़ी समस्याएं देखें

किसी फ़ाइल पर क्लोज़र लिंटर चलाने के लिए, यह आज़माएं:

$ gjslint path/to/my/file.js

आपको इस तरह के नतीजे दिखेंगे:

Line 46, E:0110: Line too long (87 characters).
Line 54, E:0214: Missing description in @return tag
Line 66, E:0012: Illegal semicolon after function declaration
Line 150, E:0120: Binary operator should go on previous line "+"
Line 175, E:0011: Missing semicolon after function assigned to a variable
Line 210, E:0121: Illegal comma at end of array literal
Line 220, E:0002: Missing space before ":"

आप बार-बार पूरी डायरेक्ट्री की जांच कर सकते हैं, जैसे:

$ gjslint -r path/to/my/directory

क्लोज़र लिंटर डिफ़ॉल्ट रूप से JsDoc एनोटेशन की मौजूदगी की जांच करता है. अगर आपको अपने प्रोजेक्ट में छूटे हुए JsDoc एनोटेशन की जांच नहीं करनी है, तो इस तरह से जांच को बंद करें:

$ gjslint --nojsdoc -r path/to/my/directory

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

--सख्त फ़्लैग

अगर आप तय करना चाहते हैं कि 'क्लोज़र लिंटर', स्पेसिंग, JsDoc टाइप, और लेखक टैग जैसे स्टाइल के नियमों को लेकर ज़्यादा सख्त हो, तो --strictकमांड लाइन फ़्लैग का इस्तेमाल करें. अगर आप Closure लाइब्रेरी में कोड योगदान कर रहे हैं, तो आपको --strict का इस्तेमाल करना होगा.

शैली से जुड़ी समस्याएं ठीक करना

ऊपर दिए गए किसी भी निर्देश में, gjslint की जांच करने पर मिलने वाली कई गड़बड़ियों को अपने-आप ठीक करने के लिए, fixjsstyle को gjslint से बदला जा सकता है.

उदाहरण के लिए:

$ fixjsstyle path/to/file1.js path/to/file2.js

fixjsstyle का इस्तेमाल करने से पहले, आपको फ़ाइलों का बैक अप ले लेना चाहिए या उन्हें सोर्स कंट्रोल सिस्टम में सेव करना चाहिए. ऐसा तब किया जाता है, जब स्क्रिप्ट में ऐसे बदलाव किए जाते हैं जो आपको नहीं चाहिए.