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

Added new page for dev instance sandbox info. Added sandbox home info to setting up environment page.

Browse Source
This commit is contained in:
JohnHake 2018-08-25 14:44:00 -07:00
parent 60e2d62797
commit a1905badda
6 changed files with 58 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
_SUMMARY.md
View File

@ -34,7 +34,7 @@
* [Plugin Configuration File](basics/plugin_structure/plugin_configuration_file.md)
* [Plugin Dependencies](basics/plugin_structure/plugin_dependencies.md)
* [Kotlin for Plugin Developers](tutorials/kotlin.md)
* [IDE Development Instances](basics/settings_caches_logs.md)
* [IDE Development Instances](basics/ide_development_instance.md)
* [Plugin Development FAQ](faq.md)
## Part II - Base Platform

15
basics/getting_started/creating_plugin_project.md
View File

@ -5,7 +5,7 @@ title: Creating a Plugin Project
This section explains how you can create a new plugin project from scratch using the New Project wizard. Optionally, you can import an existing project or import a project from external models. You can also add a new plugin module to an existing *IntelliJ Platform* project.
For more information, refer to the [IntelliJ IDEA Web Help](https://www.jetbrains.com/idea/help/new-project-wizard.html).
## To create a plugin project:
### To Create an IntelliJ Platform Project:
* On the main menu, choose **File \| New \| Project**. The *New Project*
wizard starts.
@ -17,3 +17,16 @@ For more information, refer to the [IntelliJ IDEA Web Help](https://www.jetbrain
* Set desired project name
* Click **Finish** to generate project structure files
* Go to **File \| Project Structure** to customize project settings if required
### To Create an IntelliJ Platform Plugin Module
* Select **File \| New \| Module** and choose the *IntelliJ Platform Plugin* module type
![IntelliJ Platform Plugin Module](img/intellij_platform_plugin_module.png)
<br/>
<br/>
* Enter your desired plugin name.
* Go to **File \| Project Structure** and select the newly created *IntelliJ Platform SDK* as the default SDK for the plugin module:
![Set Plugin Module SDK](img/set_plugin_module_sdk.png)

BIN
basics/getting_started/img/plugins-sandbox.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 88 KiB

19
basics/getting_started/setting_up_environment.md
View File

@ -40,13 +40,12 @@ To set up your plugin development environment:
![Specify Source Paths](img/community_sources_directory.png)
<br/>
<br/>
* Select **File \| New \| Module** and choose the *IntelliJ Platform Plugin* module type
![IntelliJ Platform Plugin Module](img/intellij_platform_plugin_module.png)
<br/>
<br/>
* Enter your desired plugin name.
* Go to **File \| Project Structure** and select the newly created *IntelliJ Platform SDK* as the default SDK for the plugin module:
![Set Plugin Module SDK](img/set_plugin_module_sdk.png)
* Specify the **Sandbox Home** directory.
The *Sandbox Home* directory stores the settings of the IDE development instance launched from a Plugin Project's **Run** configration.
Shown below is the default *Sandbox Home* directory for a user on Mac OS X. Any directory can be chosen as the *Sandbox Home* location.
Use the ellipsis button (shown below) to define a custom location.
See the [IDE Development Instances](/basics/ide_development_instance.md) page for more information about default *Sandbox Home* directory
locations and contents.
![Specify Sandbox Path](img/plugins-sandbox.png)

34
basics/ide_development_instance.md Normal file
View File

@ -0,0 +1,34 @@
---
title: IDE Development Instances - Settings, Caches, Logs, and Plugins
---
A JetBrains feature for developing plugins is to run or debug a plugin project from within a JetBrains IDE, e.g. IntelliJ IDEA.
[Selecting the **Run** menu](https://www.jetbrains.com/help/idea/running-and-debugging-plugins.html) will launch
a _Development Instance_ of the IDE with your plugin enabled.
This page describes where the settings, caches, logs, and plugins are located for a Development Instance of the IDE.
This information is stored in a different location than for the
[installed IDE itself](https://intellij-support.jetbrains.com/hc/en-us/articles/206544519-Directories-used-by-the-IDE-to-store-settings-caches-plugins-and-logs).
Please review the documentation for the installed IDE to understand conventions about product names and versions.
These conventions are used below.
### Directory Locations for Development Instances of the IDE
Development Instance configuration data is stored in the **Sandbox Home** directory defined in the IntelliJ Platform SDK
for a plugin project. See [Specify the **Sandbox Home** directory](/basics/getting_started/setting_up_environment.md) for information about
specifying a custom **Sandbox Home** location.
The default **Sandbox Home** directory locations are:
* **Windows:** `<User home>\.<product_system_name><product_version>\system\plugins-sandbox\`
* **Linux:** `~/.<product_system_name><product_version>/system/plugins-sandbox/`
* **Macos** `~/Library/Caches/<product_system_name><product_version>/plugins-sandbox/`
Within those directories are folders pertaining to the Development Instance:
* `config` contains settings for the IDE instance.
* `plugins` contains folders for each plugin being run in the IDE instance.
* `system/caches or system\caches` holds the IDE instance data.
* `system/log or system\log` contains the `idea.log` file for the IDE instance.
Each of these **Sandbox Home** subdirectories can be manually cleared to reset the IDE Development Instance.
At the next launch of a Development Instance the subdirectories will be repopulated with the appropriate information.

40
basics/settings_caches_logs.md
View File

@ -1,40 +0,0 @@
---
title: Development Instance Settings, Caches, Logs, and Plugins
---
A useful workflow for developing plugins is to run or debug a plugin project from within a JetBrains IDE, e.g. IntelliJ IDEA.
[Selecting the **Run** menu](https://www.jetbrains.com/help/idea/running-and-debugging-plugins.html) will launch
a _Development Instance_ of the IDE with your plugin enabled.
This page describes where the settings, caches, logs, and plugins are located for the Development Instance of the IDE.
This information is stored in a different location than for the
[installed IDE itself](https://intellij-support.jetbrains.com/hc/en-us/articles/206544519-Directories-used-by-the-IDE-to-store-settings-caches-plugins-and-logs).
Please review the documentation for the installed IDE to understand conventions about product names and versions.
These conventions are used below.
### Directory Locations for Development Instances of the IDE - DevKit-Based Plugins
Development Instance configuration data is stored in the following directories:
* **Windows:** `<User home>\.<product_system_name><product_version>\system\plugins-sandbox\`
* **Linux:** `~/.<product_system_name><product_version>/system/plugins-sandbox/`
* **Macos** `~/Library/Caches/<product_system_name><product_version>/plugins-sandbox/`
Within those directories are folders pertaining to the Development Instance:
* `config` contains settings for the IDE instance.
* `plugins` contains folders for each plugin being run in the IDE instance.
* `system/caches or system\caches` caches the IDE instance data.
* `system/log or system\log` contains the `idea.log` file for the IDE instance.
### Directory Locations for Development Instances of the IDE - Gradle-Based Plugins
_**This is just Placeholder Content**_
Development Instance configuration data is stored in the following directories:
* **Windows:** `<User home>\.<product_system_name><product_version>\system\plugins-sandbox\`
* **Linux:** `~/.<product_system_name><product_version>/system/plugins-sandbox/`
* **Macos** `~/Library/Caches/<product_system_name><product_version>/plugins-sandbox/`
Within those directories are folders pertaining to the Development Instance:
* `config` contains settings for the IDE instance.
* `plugins` contains folders for each plugin being run in the IDE instance.
* `system/caches or system\caches` caches the IDE instance data.
* `system/log or system\log` contains the `idea.log` file for the IDE instance.