IDEA插件开发指南_idea插件开发中文文档

ORG_GRADLE_PROJECT_intellijPublishToken='YOUR_HUB_TOKEN_HERE'

publishPlugin {

  token = System.getenv("ORG_GRADLE_PROJECT_intellijPublishToken")

}

<!-- Actions -->

<actions>

  <!-- The <action> element defines an action to register.

       The mandatory "id" attribute specifies a unique

       identifier for the action.

       The mandatory "class" attribute specifies the

       FQN of the class implementing the action.

       The mandatory "text" attribute specifies the default long-version text to be displayed for the

       action (tooltip for toolbar button or text for menu item).

       The optional "use-shortcut-of" attribute specifies the ID

       of the action whose keyboard shortcut this action will use.

       The optional "description" attribute specifies the text

       which is displayed in the status bar when the action is focused.

       The optional "icon" attribute specifies the icon which is

       displayed on the toolbar button or next to the menu item. -->

  <action id="VssIntegration.GarbageCollection" class="com.foo.impl.CollectGarbage" text="Garbage Collector: Collect _Garbage"

                description="Run garbage collector" icon="icons/garbage.png">

    <!-- The <override-text> element defines an alternate version of the text for the menu action.

         The mandatory "text" attribute defines the text to be displayed for the action.

         The mandatory "place" attribute declares where the alternate text should be used. In this example,

         any time the action is displayed in the IDE Main Menu (and submenus) the override-text

         version should be used.

         The second <override-text> element uses the alternate attribute "use-text-of-place" to define

         a location (EditorPopup) to use the same text as is used in MainMenu. It is a way to specify

         use of alternate menu text in multiple discrete menu groups. -->

    <override-text place="MainMenu" text="Collect _Garbage"/>

    <override-text place="EditorPopup" use-text-of-place="MainMenu"/>

    <!-- Provide alternative names for searching action by name -->

    <synonym text="GC"/>

    <!-- The <add-to-group> node specifies that the action should be added

         to an existing group. An action can be added to several groups.

         The mandatory "group-id" attribute specifies the ID of the group

         to which the action is added.

         The group must be implemented by an instance of the DefaultActionGroup class.

         The mandatory "anchor" attribute specifies the position of the

         action in the relative to other actions. It can have the values

         "first", "last", "before" and "after".

         The "relative-to-action" attribute is mandatory if the anchor

         is set to "before" and "after", and specifies the action before or after which

         the current action is inserted. -->

    <add-to-group group-id="ToolsMenu" relative-to-action="GenerateJavadoc" anchor="after"/>

      <!-- The <keyboard-shortcut> node specifies the keyboard shortcut

           for the action. An action can have several keyboard shortcuts.

           The mandatory "first-keystroke" attribute specifies the first

           keystroke of the action. The keystrokes are specified according

           to the regular Swing rules.

           The optional "second-keystroke" attribute specifies the second

           keystroke of the action.

           The mandatory "keymap" attribute specifies the keymap for which

           the action is active. IDs of the standard keymaps are defined as

           constants in the com.intellij.openapi.keymap.KeymapManager class.

           The optional "remove" attribute in the second <keyboard-shortcut>

           element below means the specified shortcut should be removed from

           the specified action.

           The optional "replace-all" attribute in the third <keyboard-shortcut>

           element below means remove all keyboard and mouse shortcuts from the specified

           action before adding the specified shortcut.  -->

    <!-- Add the first and second keystrokes to all keymaps  -->

    <keyboard-shortcut keymap="$default" first-keystroke="control alt G" second-keystroke="C"/>

    <!-- Except to the "Mac OS X" keymap and its children -->

    <keyboard-shortcut keymap="Mac OS X" first-keystroke="control alt G" second-keystroke="C" remove="true"/>

    <!-- The "Mac OS X 10.5+" keymap and its children will have only this keyboard shortcut for this action.  -->

    <keyboard-shortcut keymap="Mac OS X 10.5+" first-keystroke="control alt G" second-keystroke="C" replace-all="true"/>

    <!-- The <mouse-shortcut> node specifies the mouse shortcut for the

           action. An action can have several mouse shortcuts.

           The mandatory "keystroke" attribute specifies the clicks and

           modifiers for the action. It is defined as a sequence of words

           separated by spaces:

           "button1", "button2", "button3" for the mouse buttons;

           "shift", "control", "meta", "alt", "altGraph" for the modifier keys;

           "doubleClick" if the action is activated by a double-click of the button.

           The mandatory "keymap" attribute specifies the keymap for which

           the action is active. IDs of the standard keymaps are defined as

           constants in the com.intellij.openapi.keymap.KeymapManager class.

           The "remove" and "replace-all" attributes can also be used in

           a <mouse-shortcut> element. See <keyboard-shortcut> for documentation.  -->

    <mouse-shortcut keymap="$default" keystroke="control button3 doubleClick"/>

  </action>

  <!--  This action declares neither a text nor description attribute. If it has

        a resource bundle declared the text and descriptions will be retrieved

        based on the action-id incorporated in the key for a translated string -->

  <action id="sdk.action.PopupDialogAction" class="sdk.action.PopupDialogAction"

        icon="SdkIcons.Sdk_default_icon">

  </action>

  <!-- The <group> element defines an action group. <action>, <group> and

       <separator> elements defined within it are automatically included in the group.

       The mandatory "id" attribute specifies a unique identifier for the group.

       The optional "class" attribute specifies the FQN of

       the class implementing the group. If not specified,

       com.intellij.openapi.actionSystem.DefaultActionGroup is used.

       The optional "text" attribute specifies the text of the group (text

       for the menu item showing the submenu).

       The optional "description" attribute specifies the text which is displayed

       in the status bar when the group has focus.

       The optional "icon" attribute specifies the icon which is displayed on

       the toolbar button or next to the menu group.

       The optional "popup" attribute specifies how the group is presented in

       the menu. If a group has popup="true", actions in it are placed in a

       submenu; for popup="false", actions are displayed as a section of the

       same menu delimited by separators.

       The optional "compact" attribute specifies whether an action within that group is visible when disabled.

       Setting compact="true" specifies an action in the group isn't visible unless the action is enabled.        -->

  <group class="com.foo.impl.MyActionGroup" id="TestActionGroup" text="Test Group" description="Group with test actions" icon="icons/testgroup.png" popup="true" compact="true">

    <action id="VssIntegration.TestAction" class="com.foo.impl.TestAction" text="My Test Action" description="My test action"/>

    <!-- The <separator> element defines a separator between actions.

         It can also have an <add-to-group> child element. -->

    <separator/>

    <group id="TestActionSubGroup"/>

    <!-- The <reference> element allows to add an existing action to the group.

         The mandatory "ref" attribute specifies the ID of the action to add. -->

    <reference ref="EditorCopy"/>

    <add-to-group group-id="MainMenu" relative-to-action="HelpMenu" anchor="before"/>

  </group>

</actions>

<!-- An optional `url` attribute specifies the link to the plugin homepage. Displayed on the Plugin Page. -->

<idea-plugin url="https://plugins.jetbrains.com">

  <!-- 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>

  <!-- Public plugin name should be written in Title Case. Guidelines: Plugin Overview page | JetBrains Marketplace -->

  <name>Plugin Template</name>

  <!-- Plugin version. It is recommended to use the SemVer approach: https://semver.org

       Displayed in the "Plugins" settings dialog and the plugin repository Web interface. -->

  <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>

  <!-- 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:

       Plugin Development | JetBrains Marketplace -->

  <product-descriptor code="PLUGINTEMPLATE" release-date="20210901" release-version="20211" optional="true"/>

  <!-- Minimum and maximum build version of IDE 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: Plugin Overview page | JetBrains Marketplace -->

  <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.

  ]]>

  </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. -->

  <change-notes>Initial release of the plugin.</change-notes>

  <!-- Product and plugin compatibility requirements. Read more: Plugin Compatibility with IntelliJ Platform Products | IntelliJ Platform Plugin SDK -->

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

  <depends>com.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>

  <!-- 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: Extension Points | IntelliJ Platform Plugin SDK -->

  <extensionPoints>

    <extensionPoint name="testExtensionPoint" beanClass="com.foo.impl.MyExtensionBean"/>

    <applicationService serviceImplementation="com.foo.impl.MyApplicationService"/>

    <projectService serviceImplementation="com.foo.impl.MyProjectService"/>

  </extensionPoints>

  <!-- Application-level listeners, see: Listeners | IntelliJ Platform Plugin SDK -->

  <applicationListeners>

    <listener class="com.foo.impl.MyListener" topic="com.intellij.openapi.vfs.newvfs.BulkFileListener"/>

  </applicationListeners>

  <!-- Project-level listeners, see: Listeners | IntelliJ Platform Plugin SDK -->

  <projectListeners>

    <listener class="com.foo.impl.MyToolwindowListener" topic="com.intellij.openapi.wm.ex.ToolWindowManagerListener"/>

  </projectListeners>

  <!-- Actions, see: Actions | IntelliJ Platform Plugin SDK -->

  <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>

  </actions>

  <!-- Custom extensions declaration. Read more: Extensions | IntelliJ Platform Plugin SDK -->

  <extensions defaultExtensionNs="VssIntegration">

    <myExtensionPoint implementation="com.foo.impl.MyExtensionImpl"/>

  </extensions>

  <!-- DEPRECATED: Plugin's application components / do not use in new plugins.

       See Components | IntelliJ Platform Plugin SDK for migration steps. -->

  <application-components>

    <component>

      <!-- Component's interface class -->

      <interface-class>com.foo.Component1Interface</interface-class>

      <!-- Component's implementation class -->

      <implementation-class>com.foo.impl.Component1Impl</implementation-class>

    </component>

  </application-components>

  <!-- DEPRECATED: Plugin's project components - do not use in new plugins.

       See Components | IntelliJ Platform Plugin SDK for migration steps. -->

  <project-components>

    <component>

      <!-- Interface and implementation classes are the same -->

      <implementation-class>com.foo.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.  -->

      <option name="workspace" value="true" />

      <!-- 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 Components | IntelliJ Platform Plugin SDK for migration steps. -->

  <module-components>

    <component>

      <implementation-class>com.foo.Component3</implementation-class>

    </component>

  </module-components>

</idea-plugin>

插件名称,显示的位置如下图

标签为作者主站网址和邮箱配置。便于用户有疑问时联系你。

<vendor url="http://www.jetbrains.com" email="support@jetbrains.com" />

 标签之间可以配置多个 action 标签。

action 的快捷键标签。

first-keystroke：首选快捷键

second-keystroke：备选快捷键

keymap：默认快捷键

<action
id="包名 + 插件名称 + 类名"
class="com.duke.demo.HelloAction"
text="HelloActionMenu"
description="当前插件菜单功能说明"
icon="插件图标"
keymap="未知"
popup=""
project-type=""
use-shortcut-of=""/>
最核心的标签。每一个 action 标签代表一个菜单项或工具栏中的一个按钮。在 action 标签中间，还可以配置 keyboard-shortcut 标签，用来设置快捷键。

<keyboard-shortcut first-keystroke="control alt G" second-keystroke="C" keymap="$default"/>