Git के माध्यम से php कोडिंग मानकों के अनुपालन की जाँच करना

विभिन्न स्तरों के डेवलपर्स अक्सर एक परियोजना के विकास में भाग लेते हैं। यह इस तथ्य की ओर जाता है कि कोड लिखने के लिए कोई सख्त प्रारूप नहीं है। प्रोजेक्ट पर कोड की गुणवत्ता को वरिष्ठ डेवलपर्स द्वारा लगातार मॉनिटर किया जाना है और इसके लिए उन्हें बहुत समय लगता है।

कोड रिव्यू करने वालों की पीड़ा को कम करने के लिए गोवनोकोडर को दंडित करने के लिए, आप स्वचालित कोड सत्यापन टूल का उपयोग कर सकते हैं जो लंबे समय से सभी को ज्ञात है। ये PEAR और PHP कोड स्निफर हैं।


कंपनी के अधिकांश प्रोजेक्ट जहां मैं काम करता हूं, वे Drupal पर बने हैं, इसलिए Drupal कोडिंग मानकों के अनुपालन की जांच करने का एक उदाहरण माना जाएगा, हालांकि नीचे वर्णित सभी उपकरण अन्य मानकों पर लागू किए जा सकते हैं, उदाहरण के लिए Zend।

हाल ही में, PHP कोड स्निफर के माध्यम से Drupal कोडिंग मानकों का परीक्षण करने के लिए नियमों का एक समूह उभरा है। इसे स्थापित करना और कॉन्फ़िगर करना बहुत सरल है, सबसे कठिन हिस्सा आगे शुरू होता है। सभी को अपने कोड की जांच कैसे करें? मानव कारक का प्रभाव प्रभावित करता है, पहला भूल गया, दूसरा नहीं चाहता था, और तीसरा बस मानता है कि उसके कोड में त्रुटियां नहीं हो सकती हैं और सामान्य तौर पर, यह सब समय की बर्बादी है।

समाधान विकास प्रक्रिया में कोड सत्यापन के लिए स्वैच्छिक-मजबूर कार्यान्वयन हो सकता है। हमारे लिए प्रत्येक प्रोग्रामर पर एक छड़ी के साथ छड़ी न करने के लिए, हम गिट संस्करण नियंत्रण प्रणाली का उपयोग करेंगे। गिट हुक के लिए धन्यवाद, आप आसानी से अपनी खुद की स्क्रिप्ट जोड़ सकते हैं जो कुछ निश्चित संचालन पर चलेंगे, जैसे कि प्रतिबद्ध।

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



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

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

मेल द्वारा भेजी गई रिपोर्ट इस प्रकार है:



इस प्रकार, किसी परियोजना पर कोड की गुणवत्ता की निगरानी की प्रक्रिया को स्वचालित करना आसान है।

इस विधि की ताकत:

• केंद्रीकृत नियंत्रण;
• कोड सत्यापन को पूरी तरह से टाला नहीं जा सकता है;
• कोड सत्यापन स्क्रिप्ट स्रोत फ़ाइलों को संशोधित नहीं करती है और किसी हॉटफ़िक्स के मामले में कोड के अतिरिक्त को ब्लॉक नहीं करती है;
• लिपियों को स्थापित करना और कॉन्फ़िगर करना आसान है;
• Drupal कोडिंग मानक त्रुटियों के अलावा, कार्यात्मक त्रुटियों को प्रदर्शित किया जाता है। उदाहरण के लिए, जब आप किसी पृष्ठ पर डेटा आउटपुट करते समय t या check_plain फ़ंक्शन (और यह पहले से ही एक सुरक्षा छेद है) का उपयोग करना भूल गए।

नुकसान:

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

संसाधन:

• ड्रुपल कोड स्निफर
• जीआईटी के माध्यम से स्वचालित रूप से कोड की जांच के लिए स्क्रिप्ट का एक सेट
• रूसी में स्क्रिप्ट स्थापित करने और कॉन्फ़िगर करने के निर्देश

UPD 05/19/2012:

कॉन्फ़िगरेशन फ़ाइल का उपयोग करके फ़ाइल सत्यापन को अनदेखा करने की क्षमता जोड़ा गया।

कुछ फ़ाइलों और निर्देशिकाओं की जाँच नहीं करने के लिए, आपको प्रोजेक्ट रूट में .hooks_ignore फ़ाइल बनाने की आवश्यकता है। फिर इसमें उन फ़ाइलों और निर्देशिकाओं के पथ डालें जिन्हें आप चेक नहीं करना चाहते हैं। यह इंजन या तीसरे पक्ष के मॉड्यूल का मूल हो सकता है।
नमूना .hooks_ignore फ़ाइल सामग्री
includes
sites/all/modules/contrib
sites/all/themes/garland/template.php

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

Drupal.org और GitHub पर स्रोत कोड अपडेट किए गए हैं।

मैं इस छोटी सी परियोजना पर आपकी इच्छाओं और टिप्पणियों का इंतजार कर रहा हूं।