EditorConfig - सभी संपादकों / IDE के लिए एक सेटिंग्स

EditorConfig एक कॉन्फ़िगरेशन फ़ाइल और बड़ी संख्या में कोड संपादकों और IDE के एक्सटेंशन का एक सेट है (इसके बाद बस एक IDE)।

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

.editorconfig फाइलें jQuery , रूबी , वर्डप्रेस , और कई अन्य जैसे परियोजनाओं में पाई जा सकती हैं ।

बड़ी संख्या में IDE के लिए प्लगइन्स उपलब्ध हैं




आइए देखें कि यह कैसे काम करता है।

EditorConfig?

यहाँ एक उदाहरण .editorconfig फ़ाइल है जो पायथन और जावास्क्रिप्ट कोड के लिए इंडेंटेशन नियमों को परिभाषित करता है:

 ##            . ##  "ini"       ,    . ##   ,    -    . # #   EditorConfig root = true #     unix-   [*] end_of_line = lf insert_final_newline = true #   4  [*.py] indent_style = space indent_size = 4 #     (  ) [*.js] indent_style = tab #     js    lib [lib/**.js] indent_style = space indent_size = 2 #    package.json or .travis.yml [{package.json,.travis.yml}] indent_style = space indent_size = 2 

EditorConfig फाइलें थोड़े संशोधित INI प्रारूप का उपयोग करती हैं।
प्रत्येक .editorconfig UTF-8 एन्कोडिंग में होना चाहिए, और लाइनों के अंत में भी होना चाहिए
CRLF या LF ।

अनुभाग का नाम एक फ़ाइल मुखौटा है, उदाहरण के लिए [*.js] या [index.html] ।

सामान्य .ini प्रारूप के विपरीत, आप अनुभाग नाम में [ और ] उपयोग कर सकते हैं, जो आपको वर्णों की एक सूची निर्दिष्ट करने की अनुमति देता है, जिनमें से एक को निर्दिष्ट स्थिति में होना चाहिए। उदाहरण के लिए, इस तरह के निर्माण स्वीकार्य हैं: [file[123].js] । यह कैसे काम करता है - नीचे पढ़ें।

प्रत्येक टिप्पणी एक अलग लाइन पर होनी चाहिए और इसके साथ शुरू होनी चाहिए ; या # ।

* - (/)

उदाहरण: [* .js]
hello.js // मिलान
hellojs // कोई मुकाबला नहीं
index.html // कोई मेल नहीं
lib/source.js // कोई मेल नहीं

** -

उदाहरण: [**। Js]
hello.js // मिलान
hellojs // कोई मुकाबला नहीं
index.html // कोई मेल नहीं
lib/source.js // मिलान

? -

उदाहरण: [नर्क।
hello.js // मिलान
hell.js // कोई मेल नहीं

[name] - “name”

उदाहरण: [[abc] .js]
a.js // मैच
b.js // मैच
abc.js // कोई मुकाबला नहीं

[!name] - “name”

उदाहरण: [फ़ाइल [2468] .js]
file1.js // मिलान
file2.js // कोई मेल नहीं

{s1,s2,s3} -

उदाहरण: [सूचकांक। {जेएस, एचटीएमएल}]
index.js // मिलान
index.html // मिलान
package.json // कोई मेल नहीं

\ -

उदाहरण: [\ [abc \]। Js]
a.js // कोई मैच नहीं
[abc] .js // मैच

?

संपादक कॉन्फिग का लक्ष्य भाषा का स्वतंत्र होना और सभी IDE में काम करना है। दुर्भाग्य से, यह हमेशा संभव नहीं होता है, इसलिए कुछ प्लगइन्स सभी सेटिंग्स का समर्थन नहीं करते हैं। अधिक विवरण github में प्रत्येक प्लगइन के पृष्ठ पर पाया जा सकता है।

सभी सेटिंग्स केस असंवेदनशील हैं।

indent_style

मान: टैब, स्थान
आपको इंडेंटेशन के लिए हार्ड या सॉफ्ट टैब सेट करने की अनुमति देता है।

indent_size

मान: संख्या
आपको नरम टैब का उपयोग करके इंडेंट की चौड़ाई सेट करने की अनुमति देता है।

tab_width

मान: संख्या
आपको हार्ड टैब का उपयोग करके इंडेंट की चौड़ाई सेट करने की अनुमति देता है। यदि निर्दिष्ट नहीं किया गया है, तो इंडेंट_साइज़ से मान लेगा।

end_of_line

मान: lf, cr, crlf
आपको यह चुनने की अनुमति देता है कि लाइनों के सिरों पर क्या उपयोग किया जाए।

charset

मान: latin1, utf-8, utf-8-bomb, utf-16be, utf-16le
आपको फ़ाइलों के लिए एन्कोडिंग का चयन करने की अनुमति देता है।
Utf-8-bomb का उपयोग करने की अनुशंसा नहीं की जाती है

trim_trailing_whitespace

मान: सत्य, असत्य
आपको लाइनों के सिरों से रिक्त स्थान निकालने की अनुमति देता है।

insert_final_newline

मान: सत्य, असत्य
यह सुनिश्चित करें कि फ़ाइल के अंत में हमेशा एक नई पंक्ति होगी।

root

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

Ignore

कुछ फाइलें, जैसे कि थर्ड-पार्टी लाइब्रेरी या मिनिफाइज्ड फाइलें, सबसे अच्छी तरह से अछूती रहती हैं। ऐसे मामलों में, किसी भी सेटिंग को ignore करने के लिए सेट किया जा सकता है। उदाहरण के लिए:

 #    JS  CSS [*.{js,css}] indent_style = space indent_size = 2 #     JS  CSS . [*.min.*] indent_style = ignore trim_trailing_whitespace = false insert_final_newline = ignore 

?

EditorConfig का प्रारंभिक कार्य संपत्तियों का एक न्यूनतम सेट बनाना है जो सभी प्रमुख आईडीई में काम करता है।

कार्य आसान नहीं है, उदाहरण के लिए, आइए एक सेटिंग जोड़ने की संभावना पर विचार करें जो लाइन की चौड़ाई को सीमित करेगा: max_line_length
इस सेटिंग को जोड़ने के लिए, आपको कई मुद्दों को हल करने की आवश्यकता है:

• सुनिश्चित करें कि सभी संपादक / IDE इसका समर्थन करते हैं
• यह तय करें कि हार्ड या सॉफ्ट का उपयोग करना है (जब लाइन शारीरिक रूप से लंबी रहती है, लेकिन दो की तरह दिखती है) हाइफ़नेशन, या उपयोगकर्ता को एक और सेटिंग जोड़कर इसे चुनने दें (सभी संपादकों / आईडीई दोनों प्रकार के हाइफ़नेशन का समर्थन नहीं करते हैं)
  
• यदि आप हार्ड पोर्टिंग का उपयोग करते हैं, तो उन भाषाओं का क्या करें जहां हार्ड पोर्टिंग कोड को तोड़ सकती है? (उदा। HAML)

वर्तमान में, max_line_length गुण मौजूद है, लेकिन केवल vim में काम करता है।

EditorConfig

यदि या तो EditorConfig का उपयोग करने वाला कोई प्रोग्राम किसी अपरिचित सेटिंग का सामना करता है, तो उसे इसे अनदेखा करना चाहिए। यह आपको प्रारूप को एक्स्टेंसिबल बनाने की अनुमति देता है और मानक सेटिंग्स तक सीमित नहीं है।

विकास के दो क्षेत्र हैं:

/IDE

कुछ संपादकों / IDE की अपनी ख़ासियतें हैं, उदाहरण के लिए, jEdit में अधिक एनकोडिंग हैं, इसलिए एक jedit_charset सेटिंग है जो केवल jedit के लिए काम करती है।

/

तृतीय-पक्ष कार्यक्रम और प्लगइन्स EditorConfig का विस्तार कर सकते हैं और सेटिंग्स जोड़ सकते हैं जो केवल कुछ भाषाओं या फ़ाइल एक्सटेंशन के लिए काम करेंगे।

उदाहरण के लिए, npm CodePainter मॉड्यूल, जो कॉन्फ़िगरेशन फ़ाइल के रूप में EditorConfig का उपयोग करता है, आपको उद्धरण चिह्नों (एकल या दोहरे) का चयन करने की अनुमति देता है जो स्ट्रिंग्स (qoute_type) के लिए उपयोग किया जाएगा, या कोष्ठक (रिक्त स्थान_in_brackets) के अंदर रखा जाएगा। लेकिन यह सब केवल जावास्क्रिप्ट के लिए काम करेगा।

इसके अलावा, डेवलपर्स के पास भविष्य में उपयोग की जाने वाली संभावित सेटिंग्स के पूरे सेट की योजना है, उदाहरण के लिए:

curly_bracket_next_line

ब्रेस को अगली पंक्ति में स्थानांतरित करने के लिए सेट करता है, भाषाओं के लिए जहां यह है

java_class_path

अन्य प्लगइन्स द्वारा उपयोग किया जा सकता है।

language

आपको फ़ाइल एक्सटेंशन के लिए भाषा सेट करने की अनुमति देता है। जब Jinja2 जैसे टेम्पलेट इंजन .html फ़ाइलों का उपयोग करते हैं तो यह मदद कर सकता है।

पूरी सूची यहां पाई जा सकती है (संलग्न)

?

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

इस पथ वाली फ़ाइल के लिए: /Users/username/code/project/main.js , प्लगइन .editorconfig स्थानों में .editorconfig फ़ाइल की खोज करेगा:

 /Users/username/code/project/.editorconfig /Users/username/code/.editorconfig /Users/username/.editorconfig /Users/.editorconfig /.editorconfig 

आप रास्ते में किसी भी एक config फाइल में root=true सेट करके खोज को रोक सकते हैं।

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

?

जब Parser .editorconfig फ़ाइल पढ़ता है, तो यह नीचे दी गई सेटिंग्स को उच्च प्राथमिकता देता है।
लेखकों ने एक छोटा डेमो बनाया [जो फिलहाल किंडरड्रैगन के रूप में विख्यात है, पथों की गणना करते समय एक छोटी सी बग्गी है], जहां आप प्रारूप के साथ खेल सकते हैं और परिणाम देख सकते हैं

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

editorconfig-tools [ editorconfig-tools ]

कोड की जांच और सुधार के लिए उपकरणों का एक सेट। यह विकास के प्रारंभिक चरण में है और अभी तक बहुत स्थिर नहीं है।

ECLint [ ECLint ]

यह Editorconfig-tools की कार्यक्षमता में समान है, लेकिन, इसके अलावा, यह मौजूदा कोड का विश्लेषण कर सकता है और एक .editorconfig फ़ाइल उत्पन्न कर .editorconfig है। विकास के तहत भी।

CodePainter [ CodePainter , एनपीएम ]

.editorconfig उपयोग करता है, लेकिन केवल जावास्क्रिप्ट कोड के साथ काम करता है।
इसमें जेएस कोड के लिए विशेष सेटिंग्स हैं।

, ?

प्लग-इन रचनाकारों की मदद करने के लिए, मुख्य घटकों (गुठली) का एक सेट बनाया गया है, जिसका उपयोग प्लग-इन में किया जा सकता है और कॉन्फ़िगरेशन फ़ाइलों को खोजने और पार्स करने का काम ले सकता है। फिलहाल, सी , जावा , पायथन में संस्करण हैं, जावास्क्रिप्ट संस्करण पर काम चल रहा है।

प्लगइन्स स्वयं स्वरूपण करने के बजाय उपयुक्त IDE सेटिंग्स को अधिलेखित करने का प्रयास करते हैं।

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

अगर पाठकों में से कोई है जो प्लगइन्स का निर्माण करने के लिए तैयार है, तो यह बहुत अच्छी तरह से निर्धारित किया गया है कि कैसे शुरू किया जाए (संलग्न है।)

Windows

विंडोज एक्सप्लोरर में एक .editorconfig फ़ाइल बनाने के लिए, आपको .editorconfig. नामक एक फ़ाइल बनाने की आवश्यकता है .editorconfig. और विंडोज एक्सप्लोरर इसका नाम बदलकर .editorconfig कर .editorconfig ।

EditorConfig टीम ने एक उत्कृष्ट कार्य किया, लेकिन अभी भी बहुत सी कठिनाइयाँ, दिलचस्प कार्य और समाधान हैं:

• कम ज्ञात आईडीई के लिए प्लगइन्स लिखना और समर्थन करना।
• अन्य भाषाओं में प्लगइन्स के लिए गुठली का विकास और वर्तमान का शोधन
• कार्यक्षमता बढ़ाएँ और नई सेटिंग्स जोड़ें
• मौजूदा कोड परिवर्तन समाधान को परिष्कृत करना

यदि पाठकों में से एक परियोजना में भाग लेने में रुचि रखता है, तो यहां डेवलपर्स से संपर्क करने के कुछ अच्छे तरीके हैं (सभी अंग्रेजी में):

• Google समूह
• विकी
• बगट्रैकर
• FreeNode पर EditorConfig IRC चैनल भी बनाया गया था, लेकिन यह अभी भी आधा खाली है।

मैं प्रोजेक्ट टीम में नहीं हूं, लेकिन मैं खुद .editorconfig का उपयोग करता हूं और मैं ख़ुशी से आपके सुझाव और शुभकामनाएं दूंगा - अपने व्यक्तिगत मेल पर लिखूंगा।