hxuanyu/intellij-sdk-code-samples
1
0
Fork 0
mirror of https://github.com/JetBrains/intellij-sdk-code-samples.git synced 2025-07-30 10:17:50 +08:00
Code Issues Packages Projects Releases Wiki Activity

plugin_configuration_file.md: cleanups:

Browse Source 
- narrower formatting
- changed namespace and domains to example.com
- replaced "plugin template" with "my plugin" to avoid any potential confusions with the existing plugin template which is not a plugin
This commit is contained in:
Karol Lewandowski 2022-03-18 10:50:07 +01:00
parent 86d9ca3e8b
commit 4e512d99d3
1 changed files with 162 additions and 65 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

227
topics/basics/plugin_structure/plugin_configuration_file.md
View File

@ -13,128 +13,225 @@ Allowed HTML elements include text formatting, paragraphs, and lists.
When using Gradle, a number of metadata elements will be provided at build time by [`patchPluginXml` task](gradle_guide.md#patching-the-plugin-configuration-file).
```xml
<!-- An optional `url` attribute specifies the link to the plugin homepage. Displayed on the Plugin Page. -->
<idea-plugin url="https://plugins.jetbrains.com">
<!--
An optional "url" attribute specifies the link to the plugin homepage.
It is displayed on the plugin page in the Marketplace.
-->
<idea-plugin url="https://example.com/my-plugin-site">
<!-- Unique identifier of the plugin. It should be FQN. It cannot be changed between the plugin versions.
If not specified, <name> will be used (not recommended). -->
<id>org.jetbrains.plugins.template</id>
<!--
Unique identifier of the plugin. It should be a fully qualified name
including namespace to not collide with existing plugins. It cannot be
changed between the plugin versions. If not specified, <name> will be
used (not recommended).
-->
<id>com.example.myplugin</id>
<!-- Public plugin name should be written in Title Case. Guidelines: https://plugins.jetbrains.com/docs/marketplace/plugin-overview-page.html#plugin-name -->
<name>Plugin Template</name>
<!-- Public plugin name. It should use Title Cases. Guidelines:
https://plugins.jetbrains.com/docs/marketplace/plugin-overview-page.html#plugin-name
-->
<name>My Framework Support</name>
<!-- Plugin version. It is recommended to use the SemVer approach: https://semver.org.
For new plugins uploaded on JetBrains Marketplace, it is required to use SemVer: https://plugins.jetbrains.com/docs/marketplace/semver.html
Displayed in the "Plugins" settings dialog and the plugin repository Web interface. -->
<!--
Plugin version. Plugins uploaded to the Marketplace must follow
the semantic versioning: https://plugins.jetbrains.com/docs/marketplace/semver.html.
It is displayed in the "Plugins" settings dialog and in the Marketplace
plugin page.
-->
<version>1.0.0</version>
<!-- A displayed Vendor name or Organization ID (if you have one created. The optional `URL` attribute specifies
the link to the vendor's homepage.The optional `email` attribute specifies the vendor's e-mail address.
Displayed on the Plugins Page. -->
<vendor url="https://plugins.jetbrains.com" email="marketplace@jetbrains.com">JetBrains</vendor>
<!--
Vendor name or Organization ID (if you have one created).
Attributes:
- "url" (optional) - specifies the link to the vendor's homepage
- "email" (optional) - specifies the vendor's email address
Displayed on the Plugins Page.
-->
<vendor
url="https://plugins.jetbrains.com/my-company"
email="contact@example.com">My Company</vendor>
<!-- IMPORTANT: This tag should not be used in case of free plugins.
If you decide to make your plugin paid, you will need to define the parameters in the <product-descriptor> tag.
You can also enable free functionality in a paid plugin. Learn more in a guide to selling plugin:
https://plugins.jetbrains.com/build-and-market -->
<product-descriptor code="PLUGINTEMPLATE" release-date="20210901" release-version="20211" optional="true"/>
<!--
IMPORTANT: This tag should not be used in free plugins.
If you decide to make your plugin paid, you will need to define
the parameters in the <product-descriptor> tag.
You can also enable free functionality in a paid plugin. Learn more in
a guide to selling plugin: https://plugins.jetbrains.com/build-and-market
-->
<product-descriptor
code="PMYPLUGIN"
release-date="20210901"
release-version="20211"
optional="true"/>
<!-- Minimum and maximum build version of IDE compatible with the plugin. -->
<!-- Minimum and maximum IDE build versions compatible with the plugin. -->
<idea-version since-build="193" until-build="193.*"/>
<!-- Description of the plugin displayed on the Plugin Page and IDE Plugin Manager.
Simple HTML elements ( text formatting, paragraphs, and lists) can be added inside of <![CDATA[ ]]> tag.
Guidelines: https://plugins.jetbrains.com/docs/marketplace/plugin-overview-page.html#plugin-description -->
<!--
Plugin description displayed on the Marketplace plugin page and in
the IDE Plugin Manager.
Simple HTML elements (text formatting, paragraphs, lists, etc.) can be
added inside of <![CDATA[ ]]> tag. Guidelines:
https://plugins.jetbrains.com/docs/marketplace/plugin-overview-page.html#plugin-description
-->
<description>
<![CDATA[
Provides a boilerplate template for easier plugin creation. <br/>
Speed up the setup phase of plugin development for both new and experienced developers.
Provides support for <a href="https://example.com/my-framework">My
Framework</a>.
<p>Includes support for:
<ul>
<li>code completion</li>
<li>references</li>
<li>refactoring</li>
</ul>
</p>
]]>
</description>
<!-- Short summary of new features and bugfixes in the latest plugin version.
Displayed on the Plugin Page and IDE Plugin Manager. Simple HTML elements can be included between <![CDATA[ ]]> tags. -->
<!--
Short summary of new features and bugfixes in the latest plugin version.
Displayed on the Marketplace plugin page and in the IDE Plugin Manager.
Simple HTML elements can be included between <![CDATA[ ]]> tags.
-->
<change-notes>Initial release of the plugin.</change-notes>
<!-- Product and plugin compatibility requirements. Read more: https://plugins.jetbrains.com/docs/intellij/plugin-compatibility.html -->
<!--
Product and plugin compatibility requirements. Read more:
https://plugins.jetbrains.com/docs/intellij/plugin-compatibility.html
-->
<depends>com.intellij.modules.platform</depends>
<depends>com.third.party.plugin</depends>
<depends>com.example.third-party-plugin</depends>
<!-- Optional dependency on another plugin. If the plugin with the "com.MySecondPlugin" ID is installed,
the contents of mysecondplugin.xml (the format of this file conforms to the format of plugin.xml) will be loaded. -->
<depends optional="true" config-file="mysecondplugin.xml">com.MySecondPlugin</depends>
<!--
Optional dependency on another plugin. If the plugin with the
"com.MySecondPlugin" ID is installed, the contents of "mysecondplugin.xml"
(the format of this file conforms to the format of plugin.xml) will be
loaded.
-->
<depends
optional="true"
config-file="mysecondplugin.xml">com.MySecondPlugin</depends>
<!-- Resource bundle (/messages/MyPluginBundle.properties) to be used with `key` attributes in extension points
and implicit keys like `action.[ActionID].text|description`. -->
<!--
Resource bundle (/messages/MyPluginBundle.properties) to be used with
"key" attributes in extension points and implicit keys like
"action.[ActionID].text|description".
-->
<resource-bundle>messages.MyPluginBundle</resource-bundle>
<!-- Extension points defined by the plugin. Extension points are registered by a plugin so that other plugins can provide
this plugin with certain data. Read more: https://plugins.jetbrains.com/docs/intellij/plugin-extension-points.html -->
<!--
Extension points defined by the plugin. Extension points are registered
by a plugin so that other plugins can provide this plugin with certain
data. Read more:
https://plugins.jetbrains.com/docs/intellij/plugin-extension-points.html
-->
<extensionPoints>
<extensionPoint name="testExtensionPoint" beanClass="com.foo.impl.MyExtensionBean"/>
<applicationService serviceImplementation="com.foo.impl.MyApplicationService"/>
<projectService serviceImplementation="com.foo.impl.MyProjectService"/>
<extensionPoint
name="testExtensionPoint"
beanClass="com.example.impl.MyExtensionBean"/>
<applicationService
serviceImplementation="com.example.impl.MyApplicationService"/>
<projectService
serviceImplementation="com.example.impl.MyProjectService"/>
</extensionPoints>
<!-- Application-level listeners, see: https://plugins.jetbrains.com/docs/intellij/plugin-listeners.html#defining-application-level-listeners -->
<!--
Application-level listeners. For more information, see:
https://plugins.jetbrains.com/docs/intellij/plugin-listeners.html#defining-application-level-listeners
-->
<applicationListeners>
<listener class="com.foo.impl.MyListener" topic="com.intellij.openapi.vfs.newvfs.BulkFileListener"/>
<listener
class="com.example.impl.MyListener"
topic="com.intellij.openapi.vfs.newvfs.BulkFileListener"/>
</applicationListeners>
<!-- Project-level listeners, see: https://plugins.jetbrains.com/docs/intellij/plugin-listeners.html#defining-project-level-listeners -->
<!--
Project-level listeners. For more information, see:
https://plugins.jetbrains.com/docs/intellij/plugin-listeners.html#defining-project-level-listeners
-->
<projectListeners>
<listener class="com.foo.impl.MyToolwindowListener" topic="com.intellij.openapi.wm.ex.ToolWindowManagerListener"/>
<listener
class="com.example.impl.MyToolwindowListener"
topic="com.intellij.openapi.wm.ex.ToolWindowManagerListener"/>
</projectListeners>
<!-- Actions, see: https://plugins.jetbrains.com/docs/intellij/basic-action-system.html -->
<!--
Actions. For more information, see:
https://plugins.jetbrains.com/docs/intellij/basic-action-system.html
-->
<actions>
<action id="VssIntegration.GarbageCollection" class="com.foo.impl.CollectGarbage" text="Collect _Garbage" description="Run garbage collector">
<keyboard-shortcut first-keystroke="control alt G" second-keystroke="C" keymap="$default"/>
<action
id="VssIntegration.GarbageCollection"
class="com.example.impl.CollectGarbage"
text="Collect _Garbage"
description="Run garbage collector">
<keyboard-shortcut
first-keystroke="control alt G"
second-keystroke="C"
keymap="$default"/>
</action>
</actions>
<!-- Custom extensions declaration. Read more: https://plugins.jetbrains.com/docs/intellij/plugin-extensions.html#declaring-extensions -->
<!-- Custom extensions declaration. For more information, see:
https://plugins.jetbrains.com/docs/intellij/plugin-extensions.html#declaring-extensions
-->
<extensions defaultExtensionNs="VssIntegration">
<myExtensionPoint implementation="com.foo.impl.MyExtensionImpl"/>
<myExtensionPoint implementation="com.example.impl.MyExtensionImpl"/>
</extensions>
<!-- DEPRECATED: Plugin's application components / do not use in new plugins.
See https://plugins.jetbrains.com/docs/intellij/plugin-components.html for migration steps. -->
<!--
DEPRECATED: Do not use in new plugins!
Plugin's application components.
See https://plugins.jetbrains.com/docs/intellij/plugin-components.html
for migration steps.
-->
<application-components>
<component>
<!-- Component's interface class -->
<interface-class>com.foo.Component1Interface</interface-class>
<interface-class>com.example.Component1Interface</interface-class>
<!-- Component's implementation class -->
<implementation-class>com.foo.impl.Component1Impl</implementation-class>
<implementation-class>com.example.impl.Component1Impl</implementation-class>
</component>
</application-components>
<!-- DEPRECATED: Plugin's project components - do not use in new plugins.
See https://plugins.jetbrains.com/docs/intellij/plugin-components.html for migration steps. -->
<!--
DEPRECATED: Do not use in new plugins!
Plugin's project components.
See https://plugins.jetbrains.com/docs/intellij/plugin-components.html
for migration steps.
-->
<project-components>
<component>
<!-- Interface and implementation classes are the same -->
<implementation-class>com.foo.Component2</implementation-class>
<implementation-class>com.example.Component2</implementation-class>
<!-- If the "workspace" option is set "true", the component
saves its state to the .iws file instead of the .ipr file.
Note that the <option> element is used only if the component
implements the JDOMExternalizable interface. Otherwise, the
use of the <option> element takes no effect. -->
<!--
If the "workspace" option is set "true", the component saves its state
to the .iws file instead of the .ipr file. Note that the <option>
element is used only if the component implements the
JDOMExternalizable interface. Otherwise, the use of the <option>
element takes no effect.
-->
<option name="workspace" value="true"/>
<!-- If the "loadForDefaultProject" tag is present, the project component is instantiated also for the default project. -->
<!--
If the "loadForDefaultProject" tag is present, the project component
is instantiated also for the default project.
-->
<loadForDefaultProject/>
</component>
</project-components>
<!-- DEPRECATED: Plugin's module components - do not use in new plugins.
See https://plugins.jetbrains.com/docs/intellij/plugin-components.html for migration steps. -->
<!--
DEPRECATED: Do not use in new plugins!
Plugin's module components.
See https://plugins.jetbrains.com/docs/intellij/plugin-components.html
for migration steps.
-->
<module-components>
<component>
<implementation-class>com.foo.Component3</implementation-class>
<implementation-class>com.example.Component3</implementation-class>
</component>
</module-components>
</idea-plugin>