Prepare
Prepares a sandbox environment with the plugin and its dependencies installed. The sandbox directory is required by tasks that run IDE and tests in isolation from other instances, like when multiple IntelliJ Platforms are used for testing with RunIdeTask, TestIdeTask, TestIdeUiTask, or TestIdePerformanceTask tasks. The sandbox directory is created within the container configurable with IntelliJPlatformExtension.sandboxContainer.
Tasks based on the PrepareSandboxTask are sandbox producers and can be associated with sandbox consumers. To define the consumer task, make it extend from SandboxAware and apply the consumer.applySandboxFrom(producer) function.
Properties
Specifies the default sandbox destination directory where plugin files will be copied.
An internal field to hold a list of plugins to be disabled within the current sandbox.
Resolves the effective plugin installation target.
Holds the Configurations.INTELLIJ_PLATFORM_DEPENDENCY configuration with the IntelliJ Platform dependency added. It should not be directly accessed.
Holds the Configurations.INTELLIJ_PLATFORM_PLUGIN_DEPENDENCY configuration with the optional custom IntelliJ Platform plugins dependencies added. It should not be directly accessed.
Holds the Configurations.INTELLIJ_PLATFORM_TEST_RUNTIME_FIX_CLASSPATH configuration with the custom IntelliJ Platform core dependency required for running tests. It should not be directly accessed.
Provides access to the IntelliJ Platform dependency artifact path.
Specifies the directory where the plugin artifacts are to be placed.
Specifies in which part of the product the developed plugin should be installed.
Specifies the output of the Jar task. The proper Jar.archiveFile picked depends on whether code instrumentation is enabled.
Specifies the name of the plugin directory in the sandbox.
Specifies a list of dependencies on external plugins resolved from the Configurations.INTELLIJ_PLATFORM_PLUGIN configuration added with IntelliJPlatformDependenciesExtension.plugin and IntelliJPlatformDependenciesExtension.bundledPlugin.
Provides information about the IntelliJ Platform product. The information is retrieved from the product-info.json file in the IntelliJ Platform directory.
Dependencies defined with the JavaPlugin.RUNTIME_CLASSPATH_CONFIGURATION_NAME configuration.
A configuration directory located within the sandboxDirectory.
A frontend configuration directory located within the sandboxDirectory.
The directory containing content read and produced by the running IDE.
A log directory located within the sandboxDirectory.
A frontend log directory located within the sandboxDirectory.
A plugins directory located within the sandboxDirectory.
A frontend plugins directory located within the sandboxDirectory.
Represents the suffix used i.e., for test-related or custom tasks.
A system directory located within the sandboxDirectory.
A frontend system directory located within the sandboxDirectory.
Path to a file storing the OS process identifier (PID) of the running split-mode backend process.
Path to a file storing the current split-mode frontend join link.
Path to a file storing the OS process identifier (PID) of the running split-mode frontend process.
Path to a properties file which will be used to configure the frontend process if the IDE is started in Split Mode.
Deprecated alias for pluginInstallationTarget.
Defines if the current sandbox is related to testing.
Functions
Validates that the resolved IntelliJ Platform is supported by checking against the minimal supported IntelliJ Platform version.
Validates that the resolved IntelliJ Platform supports Split Mode.