PhpStorm (IntelliJ IDEA) के लिए एक लिंक रिज़ॉल्यूशन प्लगइन बनाना

मैं वेब प्रोग्रामर के रूप में काम करता हूं, PHP में लिखता हूं और कोहना फ्रेमवर्क का उपयोग करता हूं। विकास के लिए, मैं अपनी राय में, PhpStorm पर्यावरण का उपयोग करता हूं।

जब बड़ी और बहुत परियोजनाओं के साथ काम नहीं कर रहा था, तो मैं हमेशा उदास रहता था कि मैं परियोजना को नेविगेट करने में बहुत समय बिताता हूं, परियोजना के पेड़ में एक विशेष फ़ाइल (नियंत्रक या टेम्पलेट) की खोज कर रहा हूं। Ctrl + Shift + N, दुर्भाग्य से, हमेशा सुविधाजनक नहीं होता है।

इसके साथ शुरू करने के लिए, मैं इसे बनाना चाहता था ताकि मैं Kokhanovsky View :: factory () को सीधे टेम्पलेट फ़ाइल में दिए गए टेम्पलेट के नाम से ऊपर Ctrl + B (या Ctrl + Click) दबाकर कंट्रोलर फ़ाइल से नेविगेट कर सकूँ:



इसलिए, मैंने PhpStorm के लिए एक छोटा सा प्लगइन लिखने का फैसला किया, जो मेरे काम को आसान बनाएगा और दिनचर्या के कुछ हिस्से को मुक्त करेगा।

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

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

चूंकि IDEA प्लगइन्स बनाने के लिए प्रलेखन बहुत दुर्लभ है, इसलिए यह अनुशंसा की जाती है कि आप Intellij IDEA स्रोत कोड की एक प्रति भी प्राप्त करें और इसे विज़ुअल प्रलेखन के रूप में उपयोग करें :)

उपकरण सेटअप:

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

- प्रोजेक्ट टैब चुनें
- नए पर क्लिक करें, फिर IntelliJ IDEA प्लग इन एसडीके और खुलने वाले मेनू में - PhpStorm के लिए पथ चुनें (यह IntelliJ IDEA के लिए भी संभव है, लेकिन तब हम PhstStorm में प्लगइन को डीबग नहीं कर पाएंगे)


आपको एक रन / डीबग कॉन्फ़िगरेशन बनाने की भी आवश्यकता है ताकि आप PhpStorm में प्लगइन को डीबग कर सकें।

एक प्रोजेक्ट बनाएं

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

Pathos कॉपीराइट को plugin.xml फ़ाइल में जोड़ें (इसके बिना, कुछ भी नहीं!)

<name>KohanaStorm</name> <description>KohanaStorm framework integration for PhpStorm<br/> Authors: zenden2k@gmail.com </description> <version>0.1</version> <vendor url="http://zenden.ws/" email="zenden2k@gmail.com">zenden.ws</vendor> <idea-version since-build="8000"/> 

हमारे प्लगइन को न केवल IDEA के तहत चलाने के लिए, बल्कि PhpStorm में भी प्लगइन के लिए निम्न निर्भरता जोड़ें। xml:

 <depends>com.intellij.modules.platform</depends> 

मूल बातें

प्रत्येक फ़ाइल के लिए, IntelliJ IDEA एक PSI ट्री बनाता है।

एक पीएसआई (प्रोग्राम स्ट्रक्चर इंटरफेस) एक संरचना है जो किसी विशेष प्रोग्रामिंग भाषा में तत्वों की पदानुक्रम के रूप में एक फ़ाइल की सामग्री का प्रतिनिधित्व करती है। PsiFile सभी PSI फ़ाइलों के लिए सामान्य अभिभावक वर्ग है, और विशिष्ट प्रोग्रामिंग भाषाओं को PsiFile से विरासत में मिली कक्षाओं के रूप में दर्शाया गया है। उदाहरण के लिए, PsiJavaFile वर्ग एक जावा फ़ाइल का प्रतिनिधित्व करता है, XmlFile वर्ग एक XML फ़ाइल का प्रतिनिधित्व करता है। PSI ट्री को PSI व्यूअर टूल (टूल्स -> View PSI स्ट्रक्चर) का उपयोग करके देखा जा सकता है:

प्लगइन विकास

इसलिए, मैं कंट्रोलर फ़ाइल से Ctrl + B (या Ctrl + क्लिक) द्वारा नियंत्रक फ़ाइल से स्विच करने में सक्षम होना चाहता था :: टेम्पलेट फ़ाइल में सीधे ('template_name')।

योजना कैसे लागू करें?

लिंक को हल करने के लिए, हमें विरासत में मिली 3 कक्षाएं बनाने की आवश्यकता है:

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

PsiReferenceProvider - एक वर्ग जो PSI पेड़ के एक तत्व के अंदर लिंक पाता है। यह PsiReference वस्तुओं की एक सरणी देता है।

PsiReferenceContributor - एक वर्ग जो PSI तत्वों के एक हैंडलर के रूप में हमारे PsiReferenceProvider को पंजीकृत करेगा।

1. एक संदर्भ वर्ग MyReference बनाएं जो PsiReference इंटरफ़ेस को लागू करता है, और इसमें निम्नलिखित विधियों को ओवरराइड करता है

 public class MyReference implements PsiReference { @Override public String toString() { } public PsiElement getElement() { } public TextRange getRangeInElement() { return textRange; } public PsiElement handleElementRename(String newElementName) } public PsiElement bindToElement(PsiElement element) throws IncorrectOperationException { } public boolean isReferenceTo(PsiElement element) { return resolve() == element; } public Object[] getVariants() { return new Object[0]; } public boolean isSoft() { return false; } @Nullable public PsiElement resolve() { } @Override public String getCanonicalText() { } } 

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

2. PsiReferenceProvider से विरासत में मिली एक क्लास बनाएँ और getReferencesByElement मेथड को ओवरराइड करें:

 public class MyPsiReferenceProvider extends PsiReferenceProvider { @Override public PsiReference[] getReferencesByElement(@NotNull PsiElement element, @NotNull final ProcessingContext context) { } } 

GetReferencesByElement विधि लिंक ( PsiReference ) की एक सूची को लौटा देना चाहिए जो PsiElement तत्व में सम्‍मिलित है । हमारे मामले में, केवल एक लिंक लौटाया जाता है, लेकिन सामान्य स्थिति में कई हो सकते हैं, प्रत्येक लिंक में संबंधित textRange (आरंभिक सूचकांक और psi तत्व के पाठ के अंदर लिंक के अंत सूचकांक) को समाहित करना होगा।

इस पद्धति को विकसित करने में मुख्य समस्या यह थी कि JetBrains ने भाषा API (हमारे मामले में, PHP) में प्लग-इन एक्सेस नहीं खोली थी। लेकिन यहां रिफ्लेक्शन बचाव में आया। हम तत्व वस्तु के बारे में क्या जानते हैं? यह StringLiteralExpressionImpl वर्ग का एक उदाहरण होना चाहिए।

  public PsiReference[] getReferencesByElement(@NotNull PsiElement element, @NotNull final ProcessingContext context) { Project project = element.getProject(); PropertiesComponent properties = PropertiesComponent.getInstance(project); String kohanaAppDir = properties.getValue("kohanaAppPath", "application/"); VirtualFile appDir = project.getBaseDir().findFileByRelativePath(kohanaAppDir); if (appDir == null) { return PsiReference.EMPTY_ARRAY; } String className = element.getClass().getName(); Class elementClass = element.getClass(); // ,     StringLiteralExpressionImpl if (className.endsWith("StringLiteralExpressionImpl")) { try { //   getValueRange,    ,      Method method = elementClass.getMethod("getValueRange"); Object obj = method.invoke(element); TextRange textRange = (TextRange) obj; Class _PhpPsiElement = elementClass.getSuperclass().getSuperclass().getSuperclass(); //   getText,    PHP- Method phpPsiElementGetText = _PhpPsiElement.getMethod("getText"); Object obj2 = phpPsiElementGetText.invoke(element); String str = obj2.toString(); String uri = str.substring(textRange.getStartOffset(), textRange.getEndOffset()); int start = textRange.getStartOffset(); int len = textRange.getLength(); // ,     PHP- (  )   if (uri.endsWith(".tpl") || uri.startsWith("smarty:") || isViewFactoryCall(element)) { PsiReference ref = new MyReference(uri, element, new TextRange(start, start + len), project, appDir); return new PsiReference[]{ref}; } } catch (Exception e) { } } return PsiReference.EMPTY_ARRAY; } 

यह निर्धारित करने के लिए कि हम न केवल एक PHP शाब्दिक रूप से पकड़े गए थे, बल्कि देखें :: factory () में पास किए गए स्ट्रिंग में, हम फिर से प्रतिबिंब के जादू का उपयोग करते हैं:

 public static boolean isViewFactoryCall(PsiElement element) { PsiElement prevEl = element.getParent(); String elClassName; if (prevEl != null) { elClassName = prevEl.getClass().getName(); } prevEl = prevEl.getParent(); if (prevEl != null) { elClassName = prevEl.getClass().getName(); if (elClassName.endsWith("MethodReferenceImpl")) { try { Method phpPsiElementGetName = prevEl.getClass().getMethod("getName"); String name = (String) phpPsiElementGetName.invoke(prevEl); if (name.toLowerCase().equals("factory")) { Method getClassReference = prevEl.getClass().getMethod("getClassReference"); Object classRef = getClassReference.invoke(prevEl); PrintElementClassDescription(classRef); String phpClassName = (String) phpPsiElementGetName.invoke(classRef); if (phpClassName.toLowerCase().equals("view")) { return true; } } } catch (Exception ex) { } } } return false; } 

यह स्पष्ट करने के लिए कि हम किसके साथ काम कर रहे हैं, चित्र:

यह कोड यह निर्धारित करता है कि हमारा तत्व वास्तव में एक मेथड कॉल (मेथिडेफरेंस) है, जिसे "फ़ैक्टरी" कहा जाता है और "व्यू" क्लास में स्थित है।

3. PsiReferenceContributor से विरासत में मिला एक वर्ग बनाएं और निम्नलिखित विधि को ओवरराइड करें:

  @Override public void registerReferenceProviders(PsiReferenceRegistrar registrar) { registrar.registerReferenceProvider(StandardPatterns.instanceOf(PsiElement.class), provider); } 

हमारी कक्षा जो कुछ भी करती है वह हमारे PsiReferenceProvider को एक रजिस्ट्री में पंजीकृत करती है, और टेम्पलेट सेट करती है कि PsiElement के किस प्रकार (उपवर्ग) को लागू किया जाना चाहिए। यदि हमें आवश्यक दस्तावेज़ तत्व, कहते हैं, एक XML विशेषता का मूल्य, सब कुछ सरल होगा:

  registrar.registerReferenceProvider(StandardPatterns.instanceOf(XmlAttributeValue.class), provider); 

लेकिन चूंकि JetBrains ने भाषा API (हमारे मामले में, PHP) तक पहुंच नहीं खोली है, हमें गतिशील रूप से यह निर्धारित करने के लिए कि हमें इस तत्व की आवश्यकता है या नहीं, बिल्कुल सभी PsiElement तत्वों की सदस्यता लेनी होगी।

4. plugin.xml फ़ाइल में योगदानकर्ता को पंजीकृत करें:

  <extensions defaultExtensionNs="com.intellij"> <psi.referenceContributor implementation="MyPsiReferenceContributor"/> </extensions> 

एक सेटिंग पृष्ठ बनाएँ

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

 public class KohanaStormSettingsPage implements Configurable { private JTextField appPathTextField; private JCheckBox enableKohanaStorm; private JTextField secretKeyTextField; Project project; public KohanaStormSettingsPage(Project project) { this.project = project; } @Nls @Override public String getDisplayName() { return "KohanaStorm"; } @Override public JComponent createComponent() { JPanel panel = new JPanel(); panel.setLayout(new BoxLayout (panel, BoxLayout.Y_AXIS)); JPanel panel1 = new JPanel(); panel1.setLayout(new BoxLayout(panel1, BoxLayout.X_AXIS)); enableKohanaStorm = new JCheckBox("Enable Kohana Storm for this project"); ... PropertiesComponent properties = PropertiesComponent.getInstance(project); appPathTextField.setText(properties.getValue("kohanaAppPath", DefaultSettings.kohanaAppPath)); return panel; } @Override public void apply() throws ConfigurationException { PropertiesComponent properties = PropertiesComponent.getInstance(project); properties.setValue("kohanaAppPath", appPathTextField.getText()); properties.setValue("enableKohanaStorm", String.valueOf(enableKohanaStorm.isSelected()) ); properties.setValue("kohanaStormSecretKey", secretKeyTextField.getText()); } @Override public boolean isModified() { return true; } @Override public String getHelpTopic() { return null; } @Override public void disposeUIResources() { } @Override public void reset() { } } 

हम plugin.xml फ़ाइल में अपनी सेटिंग पेज रजिस्टर करते हैं:

 <extensions defaultExtensionNs="com.intellij"> <psi.referenceContributor implementation="MyPsiReferenceContributor"/> <projectConfigurable implementation="KohanaStormSettingsPage"></projectConfigurable > </extensions> 

(यदि हमारी सेटिंग पृष्ठ वैश्विक थी, तो हम एप्लिकेशन का उपयोग करेंगे

सेटिंग्स भंडारण

एक प्लगइन के लिए सेटिंग्स को स्टोर करने के लिए कम से कम ट्रिकी तरीका है PropertiesComponent क्लास और setValue और getValue तरीकों का उपयोग करना। प्रलेखन में एक अधिक जटिल विधि वर्णित है।

प्लगइन स्थापना

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

डाउनलोड प्लगइन और स्रोत कोड