mirror of
https://github.com/JetBrains/intellij-sdk-code-samples.git
synced 2025-07-30 18:27:49 +08:00
IntelliJ Platform Gradle Plugin: rename Build Features to Gradle Properties
This commit is contained in:
parent
69e7f0dcd3
commit
f1d4e4e5e6
2
ijs.tree
2
ijs.tree
@ -413,7 +413,7 @@
|
||||
<toc-element topic="tools_intellij_platform_gradle_plugin_tasks.md"/>
|
||||
<toc-element topic="tools_intellij_platform_gradle_plugin_task_awares.md"/>
|
||||
<toc-element topic="tools_intellij_platform_gradle_plugin_types.md"/>
|
||||
<toc-element topic="tools_intellij_platform_gradle_plugin_build_features.md"/>
|
||||
<toc-element topic="tools_intellij_platform_gradle_plugin_gradle_properties.md"/>
|
||||
<toc-element topic="tools_intellij_platform_gradle_plugin_migration.md"/>
|
||||
</toc-element>
|
||||
<toc-element topic="tools_gradle_grammar_kit_plugin.md"/>
|
||||
|
@ -169,7 +169,7 @@ dependencyResolutionManagement {
|
||||
Some repositories, by default, point to JetBrains Cache Redirector to provide better resources resolution.
|
||||
However, it is possible to use the direct repository URL, if available.
|
||||
|
||||
To switch off the default usage of JetBrains Cache Redirector, see the [](tools_intellij_platform_gradle_plugin_build_features.md#useCacheRedirector) build feature.
|
||||
To switch off the default usage of JetBrains Cache Redirector, see the [](tools_intellij_platform_gradle_plugin_gradle_properties.md#useCacheRedirector) build feature.
|
||||
|
||||
### Setting Up IntelliJ Platform
|
||||
|
||||
|
@ -53,7 +53,7 @@ Default value
|
||||
: `true`
|
||||
|
||||
See also:
|
||||
- [Build Features: `noSearchableOptionsWarning`](tools_intellij_platform_gradle_plugin_build_features.md#noSearchableOptionsWarning)
|
||||
- [Build Features: `noSearchableOptionsWarning`](tools_intellij_platform_gradle_plugin_gradle_properties.md#noSearchableOptionsWarning)
|
||||
|
||||
|
||||
### instrumentCode
|
||||
|
@ -1,14 +1,41 @@
|
||||
<!-- Copyright 2000-2024 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
|
||||
|
||||
# Build Features
|
||||
# Gradle Properties
|
||||
|
||||
<link-summary>IntelliJ Platform Gradle Plugin build features.</link-summary>
|
||||
<link-summary>IntelliJ Platform Gradle Plugin provides a set of Gradle properties and build features to control its behaviors.</link-summary>
|
||||
|
||||
<include from="tools_intellij_platform_gradle_plugin.md" element-id="EAP_Status"/>
|
||||
|
||||
The IntelliJ Platform Gradle Plugin exposes a number of build features to control some of the low-level Gradle plugin behaviors.
|
||||
To enable or disable a particular feature, add a Project property to the <path>gradle.properties</path> file with the following pattern:
|
||||
|
||||
```
|
||||
org.jetbrains.intellij.platform.<name>=<value>
|
||||
```
|
||||
|
||||
## General Gradle Properties
|
||||
|
||||
### localPlatformArtifacts
|
||||
{#localPlatformArtifacts}
|
||||
|
||||
The [`localPlatformArtifacts()`](tools_intellij_platform_gradle_plugin_repositories_extension.md#additional-repositories) 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.
|
||||
|
||||
This is resolved by creating an Ivy XML file in a dedicated directory, which by default points to the <path>[rootProject]/.gradle/</path>.
|
||||
|
||||
It is possible to customize this path using the `org.jetbrains.intellij.platform.localPlatformArtifacts` property.
|
||||
|
||||
Example
|
||||
:
|
||||
```
|
||||
org.jetbrains.intellij.platform.localPlatformArtifacts=/path/to/localPlatformArtifacts/
|
||||
```
|
||||
|
||||
|
||||
## Build Features
|
||||
|
||||
Build features are Gradle properties defined by the IntelliJ Platform Gradle Plugin to control specific features.
|
||||
Such properties have a simplified form:
|
||||
|
||||
```
|
||||
org.jetbrains.intellij.platform.buildFeature.<buildFeatureName>=<true|false>
|
||||
```
|
@ -168,7 +168,7 @@ This task runs a headless IDE instance to collect all the available options prov
|
||||
If your plugin doesn't implement custom settings, it is recommended to disable this task via [`intellijPlatform.buildSearchableOptions`](tools_intellij_platform_gradle_plugin_extension.md#intellijPlatform-buildSearchableOptions) build feature.
|
||||
|
||||
In the case of running the task for the plugin using [`intellijPlatform.pluginConfiguration.productDescriptor`](tools_intellij_platform_gradle_plugin_extension.md#intellijPlatform-pluginConfiguration-productDescriptor), a warning will be logged regarding potential issues with running headless IDE for paid plugins.
|
||||
It is possible to mute this warning with the [`paidPluginSearchableOptionsWarning`](tools_intellij_platform_gradle_plugin_build_features.md#paidPluginSearchableOptionsWarning) build feature.
|
||||
It is possible to mute this warning with the [`paidPluginSearchableOptionsWarning`](tools_intellij_platform_gradle_plugin_gradle_properties.md#paidPluginSearchableOptionsWarning) build feature.
|
||||
|
||||
|
||||
### outputDirectory
|
||||
@ -188,14 +188,14 @@ Default value
|
||||
{#buildSearchableOptions-showPaidPluginWarning}
|
||||
|
||||
Emit warning if the task is executed by a paid plugin.
|
||||
Can be disabled with the [`paidPluginSearchableOptionsWarning`](tools_intellij_platform_gradle_plugin_build_features.md#paidPluginSearchableOptionsWarning) build feature.
|
||||
Can be disabled with the [`paidPluginSearchableOptionsWarning`](tools_intellij_platform_gradle_plugin_gradle_properties.md#paidPluginSearchableOptionsWarning) build feature.
|
||||
|
||||
{style="narrow"}
|
||||
Type
|
||||
: `Property<Boolean>`
|
||||
|
||||
Default value
|
||||
: [`paidPluginSearchableOptionsWarning`](tools_intellij_platform_gradle_plugin_build_features.md#paidPluginSearchableOptionsWarning) && `productDescriptor` is defined
|
||||
: [`paidPluginSearchableOptionsWarning`](tools_intellij_platform_gradle_plugin_gradle_properties.md#paidPluginSearchableOptionsWarning) && `productDescriptor` is defined
|
||||
|
||||
|
||||
## classpathIndexCleanup
|
||||
@ -223,7 +223,7 @@ It is responsible for:
|
||||
- checking if the project uses IntelliJ Platform Gradle Plugin in the latest available version
|
||||
- preparing the KotlinX Coroutines Java Agent file to enable coroutines debugging when developing the plugin
|
||||
|
||||
The self-update check can be disabled via [`selfUpdateCheck`](tools_intellij_platform_gradle_plugin_build_features.md#selfUpdateCheck) build feature.
|
||||
The self-update check can be disabled via [`selfUpdateCheck`](tools_intellij_platform_gradle_plugin_gradle_properties.md#selfUpdateCheck) build feature.
|
||||
|
||||
To make the Coroutines Java Agent available for the task, inherit from [`CoroutinesJavaAgentAware`](tools_intellij_platform_gradle_plugin_task_awares.md#CoroutinesJavaAgentAware).
|
||||
|
||||
@ -257,7 +257,7 @@ Type
|
||||
: `Property<Boolean>`
|
||||
|
||||
Default value
|
||||
: [`selfUpdateCheck`](tools_intellij_platform_gradle_plugin_build_features.md#selfUpdateCheck)
|
||||
: [`selfUpdateCheck`](tools_intellij_platform_gradle_plugin_gradle_properties.md#selfUpdateCheck)
|
||||
|
||||
|
||||
### selfUpdateLock
|
||||
@ -359,14 +359,14 @@ Default value
|
||||
{#jarSearchableOptions-noSearchableOptionsWarning}
|
||||
|
||||
Emit warning if no searchable options are found.
|
||||
Can be disabled with [`noSearchableOptionsWarning`](tools_intellij_platform_gradle_plugin_build_features.md#noSearchableOptionsWarning) build feature.
|
||||
Can be disabled with [`noSearchableOptionsWarning`](tools_intellij_platform_gradle_plugin_gradle_properties.md#noSearchableOptionsWarning) build feature.
|
||||
|
||||
{style="narrow"}
|
||||
Type
|
||||
: `Property<Boolean>`
|
||||
|
||||
Default value
|
||||
: [`noSearchableOptionsWarning`](tools_intellij_platform_gradle_plugin_build_features.md#noSearchableOptionsWarning)
|
||||
: [`noSearchableOptionsWarning`](tools_intellij_platform_gradle_plugin_gradle_properties.md#noSearchableOptionsWarning)
|
||||
|
||||
|
||||
### pluginName
|
||||
|
Loading…
x
Reference in New Issue
Block a user