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

ide_development_instance.md: use tabs

Browse Source
This commit is contained in:
Yann Cébron 2021-06-23 11:30:35 +02:00
parent 6541052d68
commit 40cb5bebe5
1 changed files with 49 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

67
topics/basics/ide_development_instance.md
View File

@ -1,6 +1,6 @@
[//]: # (title: IDE Development Instances)
<!-- Copyright 2000-2020 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. -->
<!-- Copyright 2000-2021 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. -->
A JetBrains feature for developing plugins is running or debugging a plugin project from within an IntelliJ Platform-based IDE such as IntelliJ IDEA.
Selecting the [**runIde**](gradle_prerequisites.md#running-a-simple-gradle-based-intellij-platform-plugin) task for a Gradle-based project (or [**Run**](running_and_debugging_a_plugin.md) menu for a DevKit-based project) will launch a _Development Instance_ of the IDE with the plugin enabled.
@ -21,7 +21,7 @@ To produce accurate results while running or debugging a plugin project in a Dev
### Determining a JetBrains Runtime Version
The JetBrains Runtime is determined from the JDK version used to build the plugin project, regardless of whether it is built on macOS, Windows, or Linux.
For example, if a plugin is developed against the Java 8 SE Development Kit 8 for macOS (`jdk-8u212-macosx-x64.dmg`) to acquire the compatible JetBrains Runtime:
For example, if a plugin is developed against the Java 8 SE Development Kit 8 for macOS (<path>jdk-8u212-macosx-x64.dmg</path>) to acquire the compatible JetBrains Runtime:
* Go to the [JetBrains Runtime Site](https://confluence.jetbrains.com/display/JBR/JetBrains+Runtime) for general information and the latest build.
* Open the [Release notes](https://confluence.jetbrains.com/display/JBR/Release+notes) page to access all releases.
@ -32,17 +32,27 @@ For example, if a plugin is developed against the Java 8 SE Development Kit 8 fo
* The version and build number match the JDK used to build the plugin project.
For example, `jbrx-8u252-osx-x64` matches the Java 8 JDK, build 252: `jdk-8u252-macosx-x64`.
* Pick the highest JetBrains Runtime build number available.
For example, the file is `jbrx-8u252-osx-x64-b1649.2.tar.gz`, meaning build 1649.2 for this JetBrains Runtime matching Java 8 JDK build 252.
For example, the file is <path>jbrx-8u252-osx-x64-b1649.2.tar.gz</path>, meaning build 1649.2 for this JetBrains Runtime matching Java 8 JDK build 252.
<tabs>
<tab title="Gradle">
### Setting a JetBrains Runtime for Gradle-Based Plugin Projects
By default, the Gradle plugin will fetch and use the version of the JetBrains Runtime for the Development Instance corresponding to the version of the IntelliJ Platform used for building the plugin project.
If required, an alternative version can be specified using `jbrVersion` attribute of `runIde` [task](https://github.com/JetBrains/gradle-intellij-plugin/#running-dsl).
### Setting a JetBrains Runtime for DevKit-Based Plugin Projects
</tab>
<tab title="DevKit">
The [Run Configuration](https://www.jetbrains.com/help/idea/run-debug-configuration.html) for a DevKit-based plugin project controls the JDK used to run and debug a plugin project in a Development Instance.
The default Run Configuration uses the same JDK for building the plugin project and running the plugin in a Development Instance.
To change the runtime for the Development Instance, set the _JRE_ field in the Run Configuration edit dialog to download a JetBrains Runtime.
</tab>
</tabs>
## Enabling Auto-Reload
Starting in 2020.1, this is available for compatible [dynamic plugins](dynamic_plugins.md).
@ -53,41 +63,62 @@ Please note that any unloading problems in a production environment will ask the
> Auto-Reload does not work when the sandbox IDE instance is running under a debugger.
{type="warning"}
### Gradle plugin 0.4.22 and Later
Enabled by default for target platform 2020.2 or later.
<tabs>
<tab title="Gradle">
Enabled by default for target platform 2020.2 or later (Gradle plugin version 0.4.22 and later).
Set `autoReloadPlugins = true` in [**runIde**](gradle_prerequisites.md#running-a-simple-gradle-based-intellij-platform-plugin) task to enable it for earlier platform versions or `autoReloadPlugins = false` to disable it explicitly.
### Gradle plugin 0.4.21 and Earlier/DevKit
</tab>
<tab title="DevKit">
Add system property `idea.auto.reload.plugins` in the [run configuration](running_and_debugging_a_plugin.md) (DevKit-based) or [**runIde**](gradle_prerequisites.md#running-a-simple-gradle-based-intellij-platform-plugin) task (Gradle-based).
For [Gradle-based plugins](gradle_prerequisites.md) using `gradle-intellij-plugin` 0.4.17 or later, this property is set automatically.
To disable auto-reload, set `idea.auto.reload.plugins` to `false` explicitly (2020.1.2+).
</tab>
</tabs>
## The Development Instance Sandbox Directory
The _Sandbox Home_ directory contains the [settings, caches, logs, and plugins](#development-instance-settings-caches-logs-and-plugins) 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).
### Sandbox Home Location for Gradle-Based Plugin Projects
<tabs>
<tab title="Gradle">
For Gradle-based plugins, the default Sandbox Home location is defined by the IntelliJ Platform `gradle-intellij-plugin`.
See [Configuring a Gradle Plugin Project](gradle_prerequisites.md) for more information about specifying a Sandbox Home location.
The default Sandbox Home location for Gradle-based plugin projects is:
* **Windows** `<Project Dir>\build\idea-sandbox`
* **Linux or macOS** `<Project Dir>/build/idea-sandbox`
### Sandbox Home Location for DevKit-Based Plugin Projects
The default Sandbox Home location is:
* **Windows**> <path>$PROJECT_DIRECTORY$\build\idea-sandbox</path>
* **Linux or macOS**: <path>$PROJECT_DIRECTORY$/build/idea-sandbox</path>
</tab>
<tab title="DevKit">
For DevKit-based plugins, the default Sandbox Home location is defined in the IntelliJ Platform Plugin SDK.
See specifying the [Sandbox Home for DevKit Projects](setting_up_environment.md) for more information.
The default Sandbox Home directory location for DevKit-based plugin projects is:
The default Sandbox Home directory location is:
* **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/`
</tab>
</tabs>
### Development Instance Settings, Caches, Logs, and Plugins
Within the Sandbox Home directory are subdirectories of 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.
* <path>config</path> contains settings for the IDE instance.
* <path>plugins</path> contains folders for each plugin being run in the IDE instance.
* <path>system/caches</path> or <path>system\caches</path> holds the IDE instance data.
* <path>system/log</path> or <path>system\log</path> contains the <path>idea.log</path> 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.