Intellij Platform (IntelliJ IDEA, RubyMine, WebStorm, PhpStorm, PyCharm और AppCode) के लिए एक प्लगइन बनाना

हेलो, हेब्र!
इस विषय में मैं आपको बताऊंगा कि IntelliJ IDEA और PyCharm के लिए एक सरल प्लगइन कैसे बनाया जाए। चूंकि सभी आईडीई में प्लगइन्स के साथ काम करने के लिए एक ही इंटरफ़ेस होता है, इसे अन्य प्रणालियों के लिए संशोधित करने से प्रत्यक्ष विकास की प्रक्रिया के विपरीत महत्वपूर्ण प्रयासों ( अधिक ) की आवश्यकता नहीं होती है।

मैं आपको चेतावनी देता हूं कि यदि आप अपना स्वयं का प्लग-इन बनाने का निर्णय लेते हैं, तो अपेक्षित परिणाम आपकी योजना के अनुरूप नहीं हो सकता है या इसके लिए काफी समय की आवश्यकता होगी। अगर मुझे पता होता कि मैंने क्या काम किया और कितना समय बिताया, तो मैं शायद ही इसे ले पाऊंगा।

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

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



तो फिर शुरू करते हैं:

1) पर्यावरण की तैयारी

IDE के लिए प्लगइन्स IDE में लिखे गए हैं। उन्हें स्थापित और कॉन्फ़िगर करना होगा।

उपकरण स्थापना:

हमें आवश्यकता होगी:
- जावा (डेवलपर्स 1.6 सलाह देते हैं);
- इंटेलीज आईडीईए कम्युनिटी एडिशन या अल्टीमेट। (मैंने पहली बार इस्तेमाल किया, जैसा कि यह मुफ़्त है। आप इसे यहाँ डाउनलोड कर सकते हैं )

उपकरण सेटअप:

आपको जावा एसडीके और इंटेलीज आईडीईए प्लगिन एसडीके को कॉन्फ़िगर करने की आवश्यकता है:
- IntelliJ IDEA लॉन्च
- मेनू आइटम खोलें फ़ाइल | परियोजना की संरचना
- एसडीके टैब चुनें, प्लस साइन पर क्लिक करें और जावा का रास्ता चुनें

- प्रोजेक्ट टैब चुनें
- नए पर क्लिक करें, फिर IntelliJ IDEA Plugin SDK और खुलने वाले मेनू में - IntelliJ IDEA का पथ चुनें



अब आप प्लगइन प्रोजेक्ट बना सकते हैं।

2) एक प्लगइन बनाना

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

एक प्लगइन परियोजना बनाएँ

फ़ाइल | नई परियोजना: एक नाम दर्ज करें, प्लगइन मॉड्यूल प्रकार का चयन करें, चरण 1 में कॉन्फ़िगर एसडीके का चयन करें, एक परियोजना बनाएं।




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

Plugin.xml का संपादन

प्रोजेक्ट बनाने के बाद, प्लगइन संरचना और मुख्य कॉन्फ़िगरेशन फ़ाइल दिखाई दी - plugin.xml।



इसमें हम अपनी कक्षाओं को पंजीकृत करेंगे और उनका अनुकूलन करेंगे। आप दस्तावेज़ में इस फ़ाइल के बारे में अधिक पढ़ सकते हैं।
फ़ाइल कोड:

<idea-plugin version="2"> <name>DocPy</name> <description>Python standard documentation</description> <version>1.0</version> <vendor>YourCompany</vendor> <!-- please see http://confluence.jetbrains.net/display/IDEADEV/Build+Number+Ranges for description --> <idea-version since-build="107.105"/> <application-components> <!-- Add your application components here --> </application-components> <project-components> <!-- Add your project components here --> </project-components> <actions> <!-- Add your actions here --> </actions> <extensions defaultExtensionNs="com.intellij"> <!-- Add your extensions here --> </extensions> </idea-plugin> 

मेरे प्लगइन के लिए, मैंने दो लाइनें जोड़ीं:

विचार-प्लगइन अनुभाग में:
com.intellij.modules.lang - इस प्लगइन के लिए PyCharme में काम करने के लिए, यदि आप कोई निर्भरता निर्दिष्ट नहीं करते हैं, तो प्लगइन केवल IntelliJ IDEA में काम करेगा। इस अनुभाग में, आप कार्य करने के लिए प्लगइन के लिए आवश्यक निर्भरता भी निर्दिष्ट कर सकते हैं।

एक्सटेंशन अनुभाग में:
- IDE और उसके प्रारंभिक स्थान पर कक्षा शुरू करने के लिए: लंगर - खिड़की की स्थिति, factoryClass - हमारी कक्षा

संक्षेप में:

 <idea-plugin version="2"> <name>DocPy</name> <description>Python standard documentation</description> <version>1.0</version> <vendor>YourCompany</vendor> <idea-version since-build="107.105"/> <depends>com.intellij.modules.lang</depends> <application-components> </application-components> <project-components> </project-components> <actions> </actions> <extensions defaultExtensionNs="com.intellij"> <toolWindow id="PythonDoc" secondary="true" anchor="right" factoryClass="MainPanel" > </extensions> </idea-plugin> 

एक वर्ग और चित्रमय इंटरफ़ेस बनाएँ

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


परिणाम इस वर्ग है:

 public class MainPanel { private JPanel panel1; private JTabbedPane tabbedPane1; private JTextArea MainText; private JList FileList; private JPanel FilesTab; private JPanel TextTab; private JScrollPane TextPane; } 

यहां हमारे पास दो टैब के साथ एक पैनल है, फाइलों की पहली सूची पर, इस फाइल से दूसरे पाठ पर।
ToolWindowFactory इंटरफ़ेस के साथ इस वर्ग का विस्तार करें। इसका उपयोग करके, आप मेरी कक्षा को आईडीई का हिस्सा बना सकते हैं और मानक नियंत्रण (आइकन, किसी भी स्थान पर स्थित होने की क्षमता, स्केलिंग, आदि) जोड़ सकते हैं।

मुझे इस इंटरफ़ेस के बारे में कैसे पता चला? - आप पूछें।
मैंने एक ऐसे उदाहरण से कॉपी किया जो अभी भी अज्ञात है और कहीं भी लिखा नहीं गया है, एक तरीका यह है कि अन्य प्लगइन्स के लिए स्रोत में देखें

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

 @Override public void createToolWindowContent(Project project, ToolWindow toolWindow) { final String[] FilesMas = getFileList("python-3.2.3-docs-text\library\"); FileList.setListData(FilesMas); //    FileList.addListSelectionListener(new ListSelectionListener() { @Override public void valueChanged(ListSelectionEvent e) { MainText.setText(readFileToStr("python-3.2.3-docs-text\library\" + FilesMas[FileList.getSelectedIndex()])); //     MainText.setSelectionStart(0); MainText.setSelectionEnd(0); //    TextPane.getVerticalScrollBar().setValue(0); //    tabbedPane1.setSelectedIndex(1); } }); MainText.setText(readFileToStr("A:\downloads\python-3.2.3-docs-text\library\sqlite3.txt")); //   ContentFactory contentFactory = ContentFactory.SERVICE.getInstance(); // ()   GUI Content content = contentFactory.createContent(panel1, "", false); //  IDE toolWindow.getContentManager().addContent(content); } 

दो और फ़ंक्शंस जोड़ने (फ़ाइलों की सूची प्राप्त करने और किसी फ़ाइल से पढ़ने) के बाद, प्लगइन अगले चरण के लिए तैयार है।

3) प्लगइन बनाएँ

प्लगइन का उपयोग करने के लिए, आपको इसे एक निश्चित तरीके से बनाने की आवश्यकता है:
निर्माण | तैनाती के लिए प्लगइन मॉड्यूल PyDoc तैयार करें

हम प्रोजेक्ट डायरेक्टरी में अपने प्रोजेक्ट के नाम के साथ जार फ़ाइल प्राप्त करते हैं।

4) आईडीई में प्लगइन स्थापित करें

सेटिंग्स के माध्यम से-> प्लगइन्स-> डिस्क से डाउनलोड (पिछले चरण में प्राप्त जार का चयन करें) या प्लग फ़ोल्डर में जार फ़ाइल की प्रतिलिपि बनाएँ।

निष्कर्ष

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

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

कुछ और जानकारी यहाँ है ।
मेरी परियोजना का स्रोत कोड।