स्वचालित उपयोगिताओं के साथ कोड की गुणवत्ता में सुधार

काफी बड़ी संख्या में लोग अपनी परियोजनाओं के लिए स्रोत कोड को संग्रहीत करने के लिए गीथब का उपयोग करते हैं। फोर्क / पुल अनुरोध की विचारधारा कोड समीक्षा करना आसान बनाती है। कोड समीक्षा एक परियोजना में कोडिंग की गुणवत्ता में काफी सुधार कर सकती है। हालांकि, अक्सर कोड की समीक्षा करने वाले व्यक्ति को परियोजना में अपनाए गए कोडिंग मानकों की जांच करने के लिए मजबूर किया जाता है, और अन्य स्पष्ट चीजें सीधे पुल अनुरोध में हल की गई समस्या से संबंधित नहीं होती हैं। ऐसी कोडिंग त्रुटियां अपने आप पता चल सकती हैं और होनी चाहिए।

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

मैं आपके ध्यान में अच्छी तरह से ज्ञात लिंट-यूटिलिटीज द्वारा स्वचालित कोड सत्यापन के लिए एक सेवा लाता हूं। वर्तमान में समर्थित:

• C ++ / cpplint.py
  
• जावा / चेकस्टाइल
  
• स्काला / स्केलस्टाइल
  
• जावास्क्रिप्ट / jslint
  
• कॉफ़ीस्क्रिप्ट / कॉफ़ीलिंट
  
• पर्ल / पर्ल :: समालोचक
  
• CSS / CSS LINT
  
• PHP / PHPLint
  
• अजगर / pep8
  

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



लंबे विचार-विमर्श के बाद, आप पुल अनुरोध से सभी फाइलों पर एक उत्पन्न रिपोर्ट प्राप्त करेंगे।



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

सेवा का उपयोग करने के लिए एक अन्य विकल्प क्रोम या फ़ायरफ़ॉक्स ब्राउज़रों के लिए प्लग-इन का उपयोग करना है। उन्हें स्थापित करने के बाद, ब्राउज़र में एक बटन दिखाई देगा, जब क्लिक किया जाएगा, तो वर्तमान पृष्ठ पर खोले गए पुल अनुरोध के लिए एक अनुरोध की जांच की जाएगी।

लेकिन, इसका उपयोग करने का सबसे अच्छा तरीका आपकी रिपॉजिटरी के लिए पोस्ट-रिसीव हुक स्थापित करना है। इस मामले में, पुल अनुरोध के प्रत्येक अद्यतन के बाद, इसकी जांच की जाएगी, और अनुरोध पृष्ठ पर ही कोड की गुणवत्ता के बारे में एक छोटा विवरण होगा।

उदाहरण के लिए, एक अच्छा कोड:


और यह एक बहुत नहीं है:


अपनी रिपॉजिटरी के साथ काम करने के लिए सेवा को कॉन्फ़िगर करने के लिए, आपको एक WebHook URL बनाने की आवश्यकता है unlint.org/github/hook:token unlint.org/github/hook:token । unlint.org/github/hook:token पैरामीटर :token चेकिंग सेवा तक पहुंच प्रदान करने के लिए :token केवल निजी रिपॉजिटरी के लिए आवश्यक है। जो लोग github api से बहुत परिचित नहीं हैं, वे WebHook URL बनाने के लिए कर्ल अनुरोध उत्पन्न करने के लिए फ़ॉर्म का उपयोग कर सकते हैं।

महत्वपूर्ण। आप WebHook URL बनाने के लिए अपनी रिपॉजिटरी की सेटिंग में फॉर्म का उपयोग नहीं कर सकते क्योंकि यह आपके कमिट्स के लिए एक ऑब्जर्वर बनाता है और रिक्वेस्ट नहीं खींचने के लिए, आपको WebHook URL बनाने के लिए github एपीआई का उपयोग करने की आवश्यकता होती है जो पुल अनुरोधों की निगरानी करता है।

इस सेवा का उपयोग सत्यापनकर्ताओं के काम को सुविधाजनक बनाने और कंपनी में कोड को मानकीकृत करने की अनुमति देता है।

unlint.github.com
गिथब प्रोजेक्ट पेज