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

Clarified development/test tools vs. DevKit SDK basis

Browse Source
This commit is contained in:
JohnHake 2018-09-13 16:26:55 -07:00
parent dd6adab6e3
commit a8afe46ac2
2 changed files with 13 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
phpstorm/phpstorm.md
View File

@ -2,10 +2,12 @@
title: PhpStorm Plugin Development
---
Plugins for PhpStorm are developed in Java using either IntelliJ IDEA or PhpStorm. IntelliJ IDEA Community Edition does not support the PHP plugin.
IntelliJ IDEA Community Edition can be used to develop a PhpStorm plugin, but IntelliJ IDEA Ultimate must be used for testing.
You will also need a copy of PhpStorm to develop against. The [PsiViewer plugin](https://plugins.jetbrains.com/plugin/227-psiviewer) will also be useful.
### Development and Testing Tools
Plugins for PhpStorm are developed in Java using either edition of IntelliJ IDEA. The Community Edition of IntelliJ IDEA can
be used for developing, but not testing, a PhpStorm plugin. Although IntelliJ IDEA Ultimate Edition (with the PHP plugin) can be
used for testing PhpStorm plugins, the recommended approach is to use PhpStorm for testing.
The [PsiViewer plugin](https://plugins.jetbrains.com/plugin/227-psiviewer) is also recommended.
### PhpStorm Specifics

19
phpstorm/setting_up_environment.md
View File

@ -3,24 +3,19 @@ title: Setting-up the Environment for PhpStorm Plugin Development
---
### General information
Please review the information in the [Getting Started with Plugin Development](/basics/getting_started.md)
Please familiarize yourself with the [Getting Started with Plugin Development](/basics/getting_started.md)
section of this guide.
PhpStorm plugin development is done in Java using IntelliJ IDEA. However, a plugin can be developed to target either
IntelliJ IDEA or PhpStorm. The choice dictates how the plugin project SDK is configured:
1. Target IntelliJ IDEA Ultimate with the PHP plugin installed: base the plugin project SDK on the installed version of IntelliJ IDEA.
2. Target PhpStorm: base the plugin project SDK on the installed version of PhpStorm.
Choosing an installed product as the basis for a project is described on
the [Setting Up a Development Environment](/basics/getting_started/setting_up_environment.md) page.
> **Note** IntelliJ IDEA Community Edition does not support the PHP plugin. The IDE for developing a PhpStorm plugin can be IntelliJ IDEA Community Edition, but the IDE used for testing must be IntelliJ IDEA Ultimate.
If you are using a [DevKit](/basics/getting_started/using_dev_kit.md)
workflow to develop plugins for PhpStorm, the recommended approach is to base the plugin project SDK on an installation
of PhpStorm. An alternative approach is to base the plugin project SDK on an installation of IntelliJ IDEA Ultimate with the PHP plugin.
However, this runs the risk of accidentally using some APIs which are not available in PhpStorm.
### How to use the PhpStorm OpenAPI Library for Plugin Development
> OpenAPI is available for PhpStorm 6 and above.
> **Note** The OpenAPI is available for PhpStorm 6 and above.
The [Plugin Dependencies](/basics/plugin_structure/plugin_dependencies.md) instructions cover adding dependencies to the
The [Plugin Dependencies](/basics/plugin_structure/plugin_dependencies.md) page describes adding dependencies to the
DevKit as well as Gradle development environments. Follow the instructions to:
* Add the PHP OpenAPI classes to the classpath of your plugin: