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

[md] screen shots fixed

Browse Source
This commit is contained in:
Anna Bulenkova 2015-04-16 09:53:34 +02:00
parent bf9cdff1f3
commit ae2ea5ad2d
5 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
checkout_and_build_community.md
View File

@ -23,7 +23,7 @@ You can check out the code either by using IntelliJ IDEA or from the command lin
* In the **Git Repository URL** field, enter ```git://git.jetbrains.org/idea/community.git``` * In the **Git Repository URL** field, enter ```git://git.jetbrains.org/idea/community.git```
![Check Out Community](/img/getting_started/checkout_and_build_community/check_out_community.png) ![Check Out Community](img/getting_started/checkout_and_build_community/check_out_community.png)
**Checking out from the command line** **Checking out from the command line**
@ -89,30 +89,30 @@ or
[Groovy plugin](https://plugins.jetbrains.com/plugin/1524) [Groovy plugin](https://plugins.jetbrains.com/plugin/1524)
enabled by going to **Settings \| Plugins** and enabling **Groovy** plugin checkbox. enabled by going to **Settings \| Plugins** and enabling **Groovy** plugin checkbox.
![Groovy plugin](/img/getting_started/checkout_and_build_community/groovy_plugin_enabled.png) ![Groovy plugin](img/getting_started/checkout_and_build_community/groovy_plugin_enabled.png)
Parts of IntelliJ IDEA are written in Groovy, and you will get compilation errors if you don't have the plugin enabled Parts of IntelliJ IDEA are written in Groovy, and you will get compilation errors if you don't have the plugin enabled
* Make sure you have the UI Designer plugin enabled. * Make sure you have the UI Designer plugin enabled.
Most of IntelliJ IDEA's UI is built using the UI Designer, and the version you build will not run correctly if you don't have the plugin enabled Most of IntelliJ IDEA's UI is built using the UI Designer, and the version you build will not run correctly if you don't have the plugin enabled
![UI Designer plugin](/img/getting_started/checkout_and_build_community/ui_designer_plugin_enabled.png) ![UI Designer plugin](img/getting_started/checkout_and_build_community/ui_designer_plugin_enabled.png)
* Open the directory with the source code as a directory-based project * Open the directory with the source code as a directory-based project
* Configure a Java SDK named *IDEA jdk* (case sensitive), pointing to an installation of JDK 1.8 * Configure a Java SDK named *IDEA jdk* (case sensitive), pointing to an installation of JDK 1.8
![Configure SDK](/img/getting_started/checkout_and_build_community/configure_sdk.png) ![Configure SDK](img/getting_started/checkout_and_build_community/configure_sdk.png)
* Add **lib\\tools.jar** from the JDK installation directory to the classpath of IDEA JDK * Add **lib\\tools.jar** from the JDK installation directory to the classpath of IDEA JDK
![tools.jar](/img/getting_started/checkout_and_build_community/tools_jar.png) ![tools.jar](img/getting_started/checkout_and_build_community/tools_jar.png)
* Use **Build \| Make Project** to build the code * Use **Build \| Make Project** to build the code
* To run the code, use the provided shared run configuration *IDEA* * To run the code, use the provided shared run configuration *IDEA*
![IDEA Run Configuration](/img/getting_started/checkout_and_build_community/idea_run_configuration.png) ![IDEA Run Configuration](img/getting_started/checkout_and_build_community/idea_run_configuration.png)
## Building and Running from the Command Line ## Building and Running from the Command Line
To build the distribution archive of *IntelliJ IDEA Community Edition*, execute To build the distribution archive of *IntelliJ IDEA Community Edition*, execute
@ -120,7 +120,7 @@ To build the distribution archive of *IntelliJ IDEA Community Edition*, execute
Ant build script in the root directory of the source code. Ant build script in the root directory of the source code.
![Execute Ant Build Script](/img/getting_started/checkout_and_build_community/ant_build_xml.png) ![Execute Ant Build Script](img/getting_started/checkout_and_build_community/ant_build_xml.png)
The results of the build execution can be found at *out/artifacts*. The results of the build execution can be found at *out/artifacts*.

2
creating_plugin_project.md
View File

@ -14,7 +14,7 @@ For more information, refer to
* On the main menu, choose **File \| New \| Project**. The *New Project* * On the main menu, choose **File \| New \| Project**. The *New Project*
wizard starts. wizard starts.
![New Project Wizard](/img/creating_plugin_project/new_project_wizard.png) ![New Project Wizard](img/creating_plugin_project/new_project_wizard.png)
* Set *IntelliJ Platform Plugin* project type * Set *IntelliJ Platform Plugin* project type

2
custom_language_support.md
View File

@ -255,7 +255,7 @@ is also used to search for TODO items.
In order to better understand the process of building a PSI tree for a simple expression, you can refer to the following diagram: In order to better understand the process of building a PSI tree for a simple expression, you can refer to the following diagram:
![PsiBuilder](/img/custom_language_support/PsiBuilder.gif) ![PsiBuilder](img/custom_language_support/PsiBuilder.gif)
In general, there is no single right way to implement a PSI for a custom language, and the plugin author can choose the PSI structure and set of methods which are the most convenient for the code which uses the PSI (error analysis, refactorings and so on). In general, there is no single right way to implement a PSI for a custom language, and the plugin author can choose the PSI structure and set of methods which are the most convenient for the code which uses the PSI (error analysis, refactorings and so on).
However, there is one base interface which needs to be used by a custom language PSI implementation in order to support features like rename and find usages. However, there is one base interface which needs to be used by a custom language PSI implementation in order to support features like rename and find usages.

2
parsing_test.md
View File

@ -35,7 +35,7 @@ tab : \u0009
The easiest way to get the expected PSI structure for any file is to use PSI Viewer. The easiest way to get the expected PSI structure for any file is to use PSI Viewer.
Run the project and call ```Tools``` → ```View PSI Structure```. Run the project and call ```Tools``` → ```View PSI Structure```.
![PSI Tree Copy](/img/writing_tests_for_plugins/plugin_copy_psi.png) ![PSI Tree Copy](img/writing_tests_for_plugins/plugin_copy_psi.png)
Use ```Copy PSI``` button to copy the expected PSI structure to the clipboard. Use ```Copy PSI``` button to copy the expected PSI structure to the clipboard.

12
setting_up_environment.md
View File

@ -11,13 +11,13 @@ In order to set up the plugin development environment, you should follow these s
* Create a new *IntelliJ IDEA SDK* * Create a new *IntelliJ IDEA SDK*
![Create IntelliJ IDEA SDK](/img/getting_started/setting_up_environment/create_intellij_idea_sdk.png) ![Create IntelliJ IDEA SDK](img/getting_started/setting_up_environment/create_intellij_idea_sdk.png)
* Set *IDEA jdk* created in * Set *IDEA jdk* created in
[Check Out And Build Community Edition](checkout_and_build_community.html) [Check Out And Build Community Edition](checkout_and_build_community.html)
as a default Java SDK as a default Java SDK
![Set IDEA JDK](/img/getting_started/setting_up_environment/set_idea_jdk.png) ![Set IDEA JDK](img/getting_started/setting_up_environment/set_idea_jdk.png)
* Specify your installation of *IntelliJ IDEA Community Edition* as the home path * Specify your installation of *IntelliJ IDEA Community Edition* as the home path
@ -26,17 +26,17 @@ In order to set up the plugin development environment, you should follow these s
* In the Sourcepath tab of the SDK settings, press ```Add``` button * In the Sourcepath tab of the SDK settings, press ```Add``` button
![Add Sourcepath](/img/getting_started/setting_up_environment/add_sourcepath.png) ![Add Sourcepath](img/getting_started/setting_up_environment/add_sourcepath.png)
* Specify the directory into which you have checked out the sources of the *Community Edition* * Specify the directory into which you have checked out the sources of the *Community Edition*
![Specify Source Paths](/img/getting_started/setting_up_environment/community_sources_directory.png) ![Specify Source Paths](img/getting_started/setting_up_environment/community_sources_directory.png)
* Go to **File \| New \| Module** * Go to **File \| New \| Module**
* Choose *IntelliJ Platform Plugin* module type * Choose *IntelliJ Platform Plugin* module type
![IntelliJ Platform Plugin Module](/img/getting_started/setting_up_environment/intellij_platform_plugin_module.png) ![IntelliJ Platform Plugin Module](img/getting_started/setting_up_environment/intellij_platform_plugin_module.png)
* Set desired plugin name * Set desired plugin name
@ -44,4 +44,4 @@ In order to set up the plugin development environment, you should follow these s
* Select the newly created *IntelliJ Platform SDK* as a default SDK for the plugin module * Select the newly created *IntelliJ Platform SDK* as a default SDK for the plugin module
![Set Plugin Module SDK](/img/getting_started/setting_up_environment/set_plugin_module_sdk.png) ![Set Plugin Module SDK](img/getting_started/setting_up_environment/set_plugin_module_sdk.png)