JSCS: जावास्क्रिप्ट कोड शैली

जब मैंने नौ महीने पहले खुद के लिए एक छोटा सा कंसोल यूटिलिटी लिखा था, तो मुझे संदेह नहीं था कि यह जल्द ही एक गंभीर और एक-एक तरह के टूल में बदल जाएगा, यहां तक ​​कि jQuery , बूटस्ट्रैप , कोणीय जैसी प्रसिद्ध टीमों का भी उपयोग करेगा । अब, जब मैं इस लेख को लिख रहा हूं, तो मेरे प्रोजेक्ट में गीथब पर 1010 सितारे हैं, और मुझे यह सोचकर बहुत खुशी हुई कि इतने सारे लोग मेरी धारणा की मदद से अपने काम को और अधिक सुविधाजनक बनाने में सक्षम थे।



इस परियोजना का इतिहास मेरे व्यक्तिगत दर्द के साथ शुरू हुआ।



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



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



एक बार जब मैंने एक नई दृश्य इकाई विकसित की और इसे कोडिंग के लिए भेज दिया, ताकि लोग इसे तर्क में दोषों के लिए देखें। वह तब जैसा दिखता था।







यह इस समीक्षा में था कि निराशा ने मेरी प्रतीक्षा की।



कल्पना कीजिए, मैंने एक सप्ताह तक फीडबैक, डिबगिंग के नए रूप में काम किया, कोड को बांधा। लेकिन समीक्षा में मुझे जो पहली टिप्पणी मिली वह थी: "समारोह के बाद कोई जगह नहीं है"। और कोड के 5 और स्थानों में बिल्कुल वैसा ही! "



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



मुझे दुख हुआ। तब इसी तरह की दूसरी समीक्षा की गई थी, और "फ़ंक्शन" के बाद एक ही स्थिति के साथ एक ही स्थिति को दोहराया गया था। वह अंतर उन्हें दिया गया था! और उस क्षण मैं स्पष्ट रूप से समझ गया था कि यह इस तरह नहीं चल सकता है। मुझे गुस्सा आ गया।



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







थोड़ी देर के लिए मैंने अकेले इस उपयोगिता का उपयोग किया, और इसे किसी के साथ साझा नहीं किया। और क्यों? मैंने अपनी समस्याओं को हल किया और शांत किया। लेकिन यह जल्द ही स्पष्ट हो गया कि मेरे कई सहयोगियों को कोड शैली के साथ समान समस्याएं थीं। केवल वे "फ़ंक्शन" के बाद एक स्थान रखना नहीं भूलते थे, लेकिन, उदाहरण के लिए, फ़ाइल के अंत में एक पंक्ति फ़ीड जोड़ें। मैंने उनके साथ साझा किया।



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



बुरा है, Boolean(x)



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



यदि आप मुझसे पूछें कि इस परियोजना की लोकप्रियता में इस तरह की विस्फोटक वृद्धि का क्या कारण है, तो मैं जवाब दूंगा।



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



आपने jshint का विस्तार क्यों नहीं किया, क्योंकि jshint से पहले कोड की शैली की जाँच के लिए कई नियम थे?



ये नियम अधूरे, अव्यवस्थित थे, और स्वयं jshint डेवलपर्स उनसे छुटकारा पाना चाहते थे। यही कारण है कि टिकट नंबर 102 JSCS रिपॉजिटरी में दिखाई दिया जहां माइक (माइक शेरोव) ने स्टाइल चेकिंग के नियमों को जिश्ट से jscs में स्थानांतरित करना शुरू किया। अब jshint के नए संस्करण में स्टाइल की जाँच करने के लिए एक भी नियम नहीं है, और JSCS एकमात्र पूर्ण विकसित उपकरण बन गया है जो इस समस्या को हल करता है।



और इस परियोजना के दो और स्थायी रखवाले हैं। वे लोग हैं जो jQuery कर्नेल विकसित कर रहे हैं - माइक शेरोव ( mikesherov ) और ओलेग Gaydarenko ( markelog ), वे उपयोगकर्ताओं से आने वाले टिकटों की एक बड़ी संख्या में रेक करते हैं। और उन सितारों ने गिथब पर परियोजना अर्जित की, उनकी महान योग्यता। आप लोगों को बहुत बहुत धन्यवाद!



Github प्रोजेक्ट पेज: https://github.com/mdevils/node-jscs यह पृष्ठ 60 से अधिक नियमों का वर्णन करता है जिनके साथ आप परियोजना में कोड शैली सत्यापन को कॉन्फ़िगर कर सकते हैं।



आओ, उपयोग करें, और अचानक आप इसे भी पसंद करेंगे।