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

inc comments

Browse Source
This commit is contained in:
JohnHake 2019-11-14 19:30:05 -08:00
parent b551bd91c3
commit c29a987aa3
3 changed files with 25 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
code_samples/product_specific/pycharm_basics/build.gradle
View File

@ -2,7 +2,7 @@
plugins {
id 'java'
id 'org.jetbrains.intellij' version '0.4.10'
id 'org.jetbrains.intellij' version '0.4.13'
}
group 'com.intellij.sdk'

26
code_samples/product_specific/pycharm_basics/src/main/resources/META-INF/plugin.xml
View File

@ -1,10 +1,12 @@
<!-- Copyright 2000-2019 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. -->
<idea-plugin>
<!-- Unique id for this plugin. Must stay constant for the life of the plugin. -->
<id>com.intellij.sdk.pycharm</id>
<id>com.intellij.sdk.pycharm</id>
<!-- Text to display as name on Preferences/Settings | Plugin page -->
<name>SDK: PyCharm Sample Project</name>
<name>SDK: PyCharm Sample Project</name>
<!-- The version of this plugin -->
<version>0.1.0</version>
@ -30,15 +32,15 @@
<!-- Text to display as company information on Preferences/Settings | Plugin page -->
<vendor url="https://plugins.jetbrains.com">IntelliJ Platform SDK</vendor>
<actions>
<!-- Define a new menu group as a last entry in the main menu -->
<group id="com.intellij.sdk.pycharm.NewGroupedActions" text="SDK: Plugin" popup="true">
<add-to-group group-id="MainMenu" anchor="last"/>
<!-- Add a single action to the new group -->
<action id="com.intellij.sdk.pycharm.PopupDialogAction" class="com.intellij.sdk.pycharm.PopupDialogAction"
text="Pop a Dialog" description="SDK PyCharm basics example" icon="SdkIcons.Sdk_default_icon">
</action>
</group>
</actions>
<actions>
<!-- Define a new menu group as a last entry in the main menu -->
<group id="com.intellij.sdk.pycharm.NewGroupedActions" text="SDK: Plugin" popup="true">
<add-to-group group-id="MainMenu" anchor="last"/>
<!-- Add a single action to the new group -->
<action id="com.intellij.sdk.pycharm.PopupDialogAction" class="com.intellij.sdk.pycharm.PopupDialogAction"
text="Pop a Dialog" description="SDK PyCharm basics example" icon="SdkIcons.Sdk_default_icon">
</action>
</group>
</actions>
</idea-plugin>

20
products/pycharm.md
View File

@ -4,18 +4,18 @@ title: PyCharm Plugin Development
## Introduction
PyCharm is an IntelliJ Platform-based product.
Plugin projects for PyCharm can be developed using IntelliJ IDEA with the Gradle plugin.
Plugin projects for PyCharm can be developed using IntelliJ IDEA with the `gradle-intellij-plugin`.
## Configuring Plugin Projects Targeting PyCharm
The configuration of PyCharm plugin projects follows the methods described in [Configuring Plugin Projects using a Product-Specific Attribute](dev_alternate_products.md#configuring-plugin-projects-using-a-product-specific-attribute), and [Configuring the plugin.xml File](dev_alternate_products.md#configuring-the-plugin-pluginxml-file).
The table below summarizes the attributes to set in the `build.gradle` file:
The table below summarizes the `gradle-intellij-plugin` attributes to set in the `build.gradle` file:
| Gradle Plugin Attribute | Value |
| `gradle-intellij-plugin` Attribute | Attribute Value |
|-----------|-------|
| `intellij.type` | `PY` or `PC` |
| `intellij.version` | Match the targeted `PY` or `PC` version |
| `intellij.plugins` | No specific declaration is needed to use `PY` or `PC` APIs |
| `runIde.ideaDirectory` | Not needed; the Development Instance will automatically match `intellij.type` |
| [`intellij.type`](https://github.com/JetBrains/gradle-intellij-plugin/blob/master/README.md#intellij-platform-properties) | `PY` for PyCharm Professional Edition, or `PC` for PyCharm Community Edition |
| [`intellij.version`](https://github.com/JetBrains/gradle-intellij-plugin/blob/master/README.md#intellij-platform-properties) | Set to the targeted `PY` or `PC` version |
| [`intellij.plugins`](https://github.com/JetBrains/gradle-intellij-plugin/blob/master/README.md#intellij-platform-properties) | No specific declaration is needed to use `PY` or `PC` APIs |
| [`runIde.ideaDirectory`](https://github.com/JetBrains/gradle-intellij-plugin/blob/master/README.md#running-dsl) | Not needed; the Development Instance will automatically match `intellij.type` |
The dependency on the PyCharm APIs must be declared in the `plugin.xml` file.
As described in [Modules Specific to Functionality](/basics/getting_started/plugin_compatibility.md#modules-specific-to-functionality) table, the `<depends>` tags must declare `com.intellij.modules.python`
@ -28,6 +28,6 @@ APIs for PyCharm Professional are defined in the plugin [Python](https://plugins
The APIs for PyCharm Community are defined in the plugin [Python Community Edition](https://plugins.jetbrains.com/plugin/7322-python-community-edition/).
These are considered stable APIs, but care should be taken to test your plugin with any version of PyCharm you wish to support.
## Additional Articles and Resources
## Open Source Plugins for PyCharm
## Open Source Plugins for PyCharm
When learning new development configurations, it is helpful to have some representative projects for reference:
* [Flake8 Support](https://github.com/jansorg/pycharm-flake8) Adds support for flake8's # noqa comments in PyCharm.