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

ide_development_instance.md: updates & small fixes

Browse Source
This commit is contained in:
Yann Cébron 2020-07-06 16:39:02 +02:00
parent 12e33f57c0
commit 7ff2823784
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
basics/ide_development_instance.md
View File

@ -6,12 +6,12 @@ redirect_from:
<!-- 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. -->
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 [**Run**](getting_started/running_and_debugging_a_plugin.md) menu for a DevKit-based project, or the [**runIde**](/tutorials/build_system/prerequisites.md#running-a-simple-gradle-based-intellij-platform-plugin) task for a Gradle-based project will launch a _Development Instance_ of the IDE with the plugin enabled.
Selecting the [**runIde**](/tutorials/build_system/prerequisites.md#running-a-simple-gradle-based-intellij-platform-plugin) task for a Gradle-based project (or [**Run**](getting_started/running_and_debugging_a_plugin.md) menu for a DevKit-based project) will launch a _Development Instance_ of the IDE with the plugin enabled.
This page describes how to control some of the settings for the Development Instance.
## Using a JetBrains Runtime for the Development Instance
A common use case is to develop (build) a plugin project against a JDK, e.g. Java 8, and then run or debug the plugin in a Development Instance of the IDE.
In such a situation, it is important the Development Instance uses a JetBrains Runtime rather than the JDK used to build the plugin project.
In such a situation, it is important the Development Instance uses a JetBrains Runtime (JBR) rather than the JDK used to build the plugin project.
The JetBrains Runtime is an environment for running IntelliJ Platform-based IDEs on Windows, macOS, and Linux.
It has some modifications by JetBrains, such as fixes for native crashes not present in official JDK builds.
@ -25,20 +25,20 @@ If a plugin is being developed against the Java 8 SE Development Kit 8 for macOS
To acquire the compatible JetBrains Runtime:
* Go to the [JetBrains Bintray site](https://bintray.com/jetbrains/intellij-jbr).
* Select the package name corresponding to the platform and SDK version.
In this case the package name is `jbrsdk8-osx-x64` for **j**et **b**rains **r**untime _sdk_ version 8, maxOS x64 hardware.
In this case the package name is `jbrsdk8-osx-x64` for **j**et **b**rains **r**untime _sdk_ version 8, macOS x64 hardware.
* On the macOS package page of the JetBrains Bintray site, select the **Files** menu.
* In the list of files, find the name that satisfies:
* The version and build number match the JDK used to build the plugin project.
For example, `jbrx-8u212-osx-x64` matches the Java 8 JDK, build 212: `jdk-8u212-macosx-x64`.
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, as of this writing, the file is `jbrx-8u212-osx-x64-b1566.8.tar.gz`, meaning build 1566.8 for this JetBrains Runtime matching Java 8 JDK build 212.
For example, as of this writing, 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.
### 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.
In this situation no additional configuration is required.
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
The [Run Configuration](https://www.jetbrains.com/help/idea/creating-and-editing-run-debug-configurations.html#edit) for a DevKit-based plugin project controls the JDK used to run and debug a plugin project in a Development Instance.
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 use a downloaded JetBrains Runtime.