GradleProperties

sealed class GradleProperties<T : Any>

The IntelliJ Platform Gradle Plugin introduces custom Gradle properties to control some of the low-level Gradle plugin behaviors. To adjust a particular feature, add a Project property to the gradle.properties file with the following pattern:

org.jetbrains.intellij.platform.<propertyName>=<value>

Inheritors

Types

Link copied to clipboard

Controls whether default IntelliJ Platform dependencies (com.intellij and intellij.rider) should be added automatically when creating a dependency on the IntelliJ Platform.

Link copied to clipboard

Instruct the IDE that sources are needed to be downloaded when working with IntelliJ Platform Gradle Plugin. Value is passed directly to the Idea Gradle Plugin to the idea.module.downloadSources property.

Link copied to clipboard

Forces BuildSearchableOptionsTask to run even when the plugin descriptor analysis does not find any Configurable extension points. This overrides both the automatic skip optimization and IntelliJPlatformExtension.buildSearchableOptions.

Link copied to clipboard

Specifies the location of the local IntelliJ Platform cache directory for storing files related to the current project, like:

Link copied to clipboard

Specifies the location of the IntelliJ Platform IDEs cache directory for storing downloaded IDE distributions and related artifacts. This cache is used to avoid re-downloading the same IDE versions across different project builds and can be shared between multiple projects.

Link copied to clipboard

Indicates whether caching for IntelliJ Platform IDEs is enabled globally.

Link copied to clipboard

The IntelliJPlatformRepositoriesExtension.localPlatformArtifacts entry applied to the repositories {} block is required to apply to the project dependencies that need extra pre-processing before they can be correctly used by the IntelliJ Platform Gradle Plugin and loaded by Gradle.

Link copied to clipboard

When the BuildSearchableOptionsTask doesn't produce any results, for example, when the plugin doesn't implement any settings, a warning is shown to suggest disabling it for better performance with IntelliJPlatformExtension.buildSearchableOptions.

Link copied to clipboard

Due to IDE limitations, it is impossible to run the IDE in headless mode to collect searchable options for a paid plugin. As paid plugins require providing a valid license and presenting a UI dialog, it is impossible to handle such a case, and the task will fail. This feature flag displays the given warning when the task is run by a paid plugin.

Link copied to clipboard

Specifies the URL from which the list of all Android Studio releases is fetched. This listing is later parsed to provide a list of IDEs matching the filtering criteria for running the IntelliJ Plugin Verifier tool with the VerifyPluginTask task.

Link copied to clipboard

Specifies the URL from which JetBrains IDEs CDN releases are fetched. This listing is used for matching IDE releases, mapping IDE releases to build numbers, and resolving download links.

Link copied to clipboard

Checks whether the currently used Gradle IntelliJ Plugin is outdated and if a new release is available. The plugin performs an update check on every run asking the GitHub Releases page for the redirection URL to the latest version with HEAD HTTP request: https://github.com/JetBrains/intellij-platform-gradle-plugin/releases/latest.

Link copied to clipboard

Specifies the default Shim server port at which the local webserver is run. The Shim server is used to proxy requests to the authorized custom plugin repositories registered with IntelliJPlatformRepositoriesExtension.customPluginRepository.

Link copied to clipboard

Specifies the bundled plugin IDs or module IDs excluded from the TestIdeTask classpath. The property accepts a comma-separated list.

Link copied to clipboard

By default, JetBrains Cache Redirector is used when resolving Maven repositories or any resources used by the IntelliJ Platform Gradle Plugin. Due to limitations, sometimes it is desired to limit the list of remote endpoints accessed by Gradle.

Link copied to clipboard

Controls whether IntelliJPlatformExtension.PluginVerification.Ides.recommended IDEs should be added automatically when no IntelliJ Plugin Verifier IDEs were configured explicitly.

Allows muting specific messages reported by the VerifyPluginProjectConfigurationTask task. The property accepts a comma-separated list of message patterns to be muted. Each pattern is matched against the message text using a String.contains check (case-sensitive).

Properties

Link copied to clipboard

Functions

Link copied to clipboard
open override fun toString(): String