mirror of
https://github.com/JetBrains/intellij-sdk-code-samples.git
synced 2025-07-29 17:57:53 +08:00
Add code formatting to titles in IntelliJ Platform Gradle Plugin pages
This commit is contained in:
Karol Lewandowski
parent
eb2bf88b1c
commit
1976691540
@ -40,7 +40,7 @@ intellijPlatform {
|
||||
```
|
||||
|
||||
|
||||
### cachePath
|
||||
### `cachePath`
|
||||
{#intellijPlatform-cachePath}
|
||||
|
||||
Provides read-only access to the IntelliJ Platform project cache location.
|
||||
@ -62,7 +62,7 @@ Default value
|
||||
: <path>[rootProject]/.intellijPlatform/</path>
|
||||
|
||||
|
||||
### platformPath
|
||||
### `platformPath`
|
||||
{#intellijPlatform-platformPath}
|
||||
|
||||
Provides read-only access to the IntelliJ Platform dependency artifact path.
|
||||
@ -78,7 +78,7 @@ Default value
|
||||
: Path of the current IntelliJ Platform
|
||||
|
||||
|
||||
### productInfo
|
||||
### `productInfo`
|
||||
{#intellijPlatform-productInfo}
|
||||
|
||||
Provides read-only access to the [`ProductInfo`](tools_intellij_platform_gradle_plugin_types.md#ProductInfo) object associated with the IntelliJ Platform dependency configured for the current project.
|
||||
@ -94,7 +94,7 @@ Default value
|
||||
: [`ProductInfo`](tools_intellij_platform_gradle_plugin_types.md#ProductInfo) of the current IntelliJ Platform
|
||||
|
||||
|
||||
### buildSearchableOptions
|
||||
### `buildSearchableOptions`
|
||||
{#intellijPlatform-buildSearchableOptions}
|
||||
|
||||
Builds an index of UI components (searchable options) for the plugin.
|
||||
@ -111,7 +111,7 @@ See also:
|
||||
- [Build Features: `noSearchableOptionsWarning`](tools_intellij_platform_gradle_plugin_gradle_properties.md#noSearchableOptionsWarning)
|
||||
|
||||
|
||||
### instrumentCode
|
||||
### `instrumentCode`
|
||||
{#intellijPlatform-instrumentCode}
|
||||
|
||||
Enables the [](tools_intellij_platform_gradle_plugin.md#code-instrumentation) of the compiled classes.
|
||||
@ -126,7 +126,7 @@ Default value
|
||||
: `true`
|
||||
|
||||
|
||||
### projectName
|
||||
### `projectName`
|
||||
{#intellijPlatform-projectName}
|
||||
|
||||
Defines the project name, which is used for creating file structure and the build archive.
|
||||
@ -139,7 +139,7 @@ Default value
|
||||
: `project.name`
|
||||
|
||||
|
||||
### sandboxContainer
|
||||
### `sandboxContainer`
|
||||
{#intellijPlatform-sandboxContainer}
|
||||
|
||||
The path to the sandbox container where tests and IDE instances read and write data.
|
||||
@ -197,7 +197,7 @@ See also:
|
||||
- [](#intellijPlatform-pluginConfiguration-vendor)
|
||||
|
||||
|
||||
### id
|
||||
### `id`
|
||||
{#intellijPlatform-pluginConfiguration-id}
|
||||
|
||||
The plugin's unique identifier.
|
||||
@ -217,7 +217,7 @@ See also:
|
||||
- [Plugin Configuration File: `id`](plugin_configuration_file.md#idea-plugin__id)
|
||||
|
||||
|
||||
### name
|
||||
### `name`
|
||||
{#intellijPlatform-pluginConfiguration-name}
|
||||
|
||||
The plugin's display name, visible to users (Title Case).
|
||||
@ -233,7 +233,7 @@ See also:
|
||||
- [Plugin Configuration File: `name`](plugin_configuration_file.md#idea-plugin__name)
|
||||
|
||||
|
||||
### version
|
||||
### `version`
|
||||
{#intellijPlatform-pluginConfiguration-version}
|
||||
|
||||
The plugin version, presented in the Plugins settings dialog and on its JetBrains Marketplace page.
|
||||
@ -251,7 +251,7 @@ See also:
|
||||
- [Plugin Configuration File: `version`](plugin_configuration_file.md#idea-plugin__version)
|
||||
|
||||
|
||||
### description
|
||||
### `description`
|
||||
{#intellijPlatform-pluginConfiguration-description}
|
||||
|
||||
The plugin description, which is presented on the JetBrains Marketplace plugin page and in the Plugins settings dialog.
|
||||
@ -270,7 +270,7 @@ See also:
|
||||
- [Plugin Configuration File: `description`](plugin_configuration_file.md#idea-plugin__description)
|
||||
|
||||
|
||||
### changeNotes
|
||||
### `changeNotes`
|
||||
{#intellijPlatform-pluginConfiguration-changeNotes}
|
||||
|
||||
A concise summary of new features, bug fixes, and alterations provided in the latest plugin version.
|
||||
@ -318,7 +318,7 @@ See also:
|
||||
- [How to add required parameters for paid plugins](https://plugins.jetbrains.com/docs/marketplace/add-required-parameters.html)
|
||||
|
||||
|
||||
### code
|
||||
### `code`
|
||||
{#intellijPlatform-pluginConfiguration-productDescriptor-code}
|
||||
|
||||
The product code for the plugin, used in the JetBrains Sales System, needs to be pre-approved by JetBrains and must adhere to [specified requirements](https://plugins.jetbrains.com/docs/marketplace/obtain-a-product-code-from-jetbrains.html).
|
||||
@ -334,7 +334,7 @@ See also:
|
||||
- [Plugin Configuration File: `product-descriptor`](plugin_configuration_file.md#idea-plugin__product-descriptor)
|
||||
|
||||
|
||||
### releaseDate
|
||||
### `releaseDate`
|
||||
{#intellijPlatform-pluginConfiguration-productDescriptor-releaseDate}
|
||||
|
||||
The release date of the major version, formatted as `YYYYMMDD`.
|
||||
@ -350,7 +350,7 @@ See also:
|
||||
- [Plugin Configuration File: `product-descriptor`](plugin_configuration_file.md#idea-plugin__product-descriptor)
|
||||
|
||||
|
||||
### releaseVersion
|
||||
### `releaseVersion`
|
||||
{#intellijPlatform-pluginConfiguration-productDescriptor-releaseVersion}
|
||||
|
||||
The major version, represented in a specific numerical format.
|
||||
@ -366,7 +366,7 @@ See also:
|
||||
- [Plugin Configuration File: `product-descriptor`](plugin_configuration_file.md#idea-plugin__product-descriptor)
|
||||
|
||||
|
||||
### optional
|
||||
### `optional`
|
||||
{#intellijPlatform-pluginConfiguration-productDescriptor-optional}
|
||||
|
||||
The boolean value that indicates if the plugin is a [Freemium](https://plugins.jetbrains.com/docs/marketplace/freemium.html) plugin.
|
||||
@ -412,7 +412,7 @@ See also:
|
||||
- [Plugin Configuration File: `idea-version`](plugin_configuration_file.md#idea-plugin__idea-version)
|
||||
- [](build_number_ranges.md)
|
||||
|
||||
### sinceBuild
|
||||
### `sinceBuild`
|
||||
{#intellijPlatform-pluginConfiguration-ideaVersion-sinceBuild}
|
||||
|
||||
The earliest IDE version that is compatible with the plugin.
|
||||
@ -432,7 +432,7 @@ See also:
|
||||
- [Tasks: `patchPluginXml.sinceBuild`](tools_intellij_platform_gradle_plugin_tasks.md#patchPluginXml-sinceBuild)
|
||||
|
||||
|
||||
### untilBuild
|
||||
### `untilBuild`
|
||||
{#intellijPlatform-pluginConfiguration-ideaVersion-untilBuild}
|
||||
|
||||
The latest IDE version that is compatible with the plugin.
|
||||
@ -483,7 +483,7 @@ intellijPlatform {
|
||||
See also:
|
||||
- [Plugin Configuration File: `vendor`](plugin_configuration_file.md#idea-plugin__vendor)
|
||||
|
||||
### name
|
||||
### `name`
|
||||
{#intellijPlatform-pluginConfiguration-vendor-name}
|
||||
|
||||
The name of the vendor or the organization ID (if created), as displayed in the Plugins settings dialog and on the JetBrains Marketplace plugin page.
|
||||
@ -498,7 +498,7 @@ See also:
|
||||
- [Tasks: `patchPluginXml.vendorName`](tools_intellij_platform_gradle_plugin_tasks.md#patchPluginXml-vendorName)
|
||||
|
||||
|
||||
### email
|
||||
### `email`
|
||||
{#intellijPlatform-pluginConfiguration-vendor-email}
|
||||
|
||||
The email address of the vendor.
|
||||
@ -513,7 +513,7 @@ See also:
|
||||
- [Tasks: `patchPluginXml.vendorEmail`](tools_intellij_platform_gradle_plugin_tasks.md#patchPluginXml-vendorEmail)
|
||||
|
||||
|
||||
### url
|
||||
### `url`
|
||||
{#intellijPlatform-pluginConfiguration-vendor-url}
|
||||
|
||||
The URL to the vendor's homepage.
|
||||
@ -551,7 +551,7 @@ intellijPlatform {
|
||||
```
|
||||
|
||||
|
||||
### host
|
||||
### `host`
|
||||
{#intellijPlatform-publishing-host}
|
||||
|
||||
The hostname used for publishing the plugin.
|
||||
@ -567,7 +567,7 @@ See also:
|
||||
- [Tasks: `publishPlugin.host`](tools_intellij_platform_gradle_plugin_tasks.md#publishPlugin-host)
|
||||
|
||||
|
||||
### token
|
||||
### `token`
|
||||
{#intellijPlatform-publishing-token}
|
||||
|
||||
Authorization token.
|
||||
@ -583,7 +583,7 @@ See also:
|
||||
- [Tasks: `publishPlugin.token`](tools_intellij_platform_gradle_plugin_tasks.md#publishPlugin-token)
|
||||
|
||||
|
||||
### channels
|
||||
### `channels`
|
||||
{#intellijPlatform-publishing-channels}
|
||||
|
||||
A list of channel names to upload plugin to.
|
||||
@ -599,7 +599,7 @@ See also:
|
||||
- [Tasks: `publishPlugin.channels`](tools_intellij_platform_gradle_plugin_tasks.md#publishPlugin-channels)
|
||||
|
||||
|
||||
### toolboxEnterprise
|
||||
### `toolboxEnterprise`
|
||||
{#intellijPlatform-publishing-toolboxEnterprise}
|
||||
|
||||
Specify if the Toolbox Enterprise plugin repository service should be used.
|
||||
@ -615,7 +615,7 @@ See also:
|
||||
- [Tasks: `publishPlugin.toolboxEnterprise`](tools_intellij_platform_gradle_plugin_tasks.md#publishPlugin-toolboxEnterprise)
|
||||
|
||||
|
||||
### hidden
|
||||
### `hidden`
|
||||
{#intellijPlatform-publishing-hidden}
|
||||
|
||||
Publish the plugin update and mark it as hidden to prevent public release after approval.
|
||||
@ -666,7 +666,7 @@ See also:
|
||||
- [Marketplace ZIP Signer](https://github.com/JetBrains/marketplace-zip-signer)
|
||||
|
||||
|
||||
### cliPath
|
||||
### `cliPath`
|
||||
{#intellijPlatform-signing-cliPath}
|
||||
|
||||
A path to the local Marketplace ZIP Signer CLI tool to be used.
|
||||
@ -679,7 +679,7 @@ See also:
|
||||
- [Task Awares: `SigningAware`](tools_intellij_platform_gradle_plugin_task_awares.md#SigningAware)
|
||||
|
||||
|
||||
### keyStore
|
||||
### `keyStore`
|
||||
{#intellijPlatform-signing-keyStore}
|
||||
|
||||
KeyStore file path.
|
||||
@ -693,7 +693,7 @@ See also:
|
||||
- [Tasks: `signPlugin.keyStore`](tools_intellij_platform_gradle_plugin_tasks.md#signPlugin-keyStore)
|
||||
|
||||
|
||||
### keyStorePassword
|
||||
### `keyStorePassword`
|
||||
{#intellijPlatform-signing-keyStorePassword}
|
||||
|
||||
KeyStore password.
|
||||
@ -707,7 +707,7 @@ See also:
|
||||
- [Tasks: `signPlugin.keyStorePassword`](tools_intellij_platform_gradle_plugin_tasks.md#signPlugin-keyStorePassword)
|
||||
|
||||
|
||||
### keyStoreKeyAlias
|
||||
### `keyStoreKeyAlias`
|
||||
{#intellijPlatform-signing-keyStoreKeyAlias}
|
||||
|
||||
KeyStore key alias.
|
||||
@ -721,7 +721,7 @@ See also:
|
||||
- [Tasks: `signPlugin.keyStoreKeyAlias`](tools_intellij_platform_gradle_plugin_tasks.md#signPlugin-keyStoreKeyAlias)
|
||||
|
||||
|
||||
### keyStoreType
|
||||
### `keyStoreType`
|
||||
{#intellijPlatform-signing-keyStoreType}
|
||||
|
||||
KeyStore type.
|
||||
@ -735,7 +735,7 @@ See also:
|
||||
- [Tasks: `signPlugin.keyStoreType`](tools_intellij_platform_gradle_plugin_tasks.md#signPlugin-keyStoreType)
|
||||
|
||||
|
||||
### keyStoreProviderName
|
||||
### `keyStoreProviderName`
|
||||
{#intellijPlatform-signing-keyStoreProviderName}
|
||||
|
||||
JCA KeyStore Provider name.
|
||||
@ -749,7 +749,7 @@ See also:
|
||||
- [Tasks: `signPlugin.keyStoreProviderName`](tools_intellij_platform_gradle_plugin_tasks.md#signPlugin-keyStoreProviderName)
|
||||
|
||||
|
||||
### privateKey
|
||||
### `privateKey`
|
||||
{#intellijPlatform-signing-privateKey}
|
||||
|
||||
Encoded private key in the PEM format.
|
||||
@ -765,7 +765,7 @@ See also:
|
||||
- [Tasks: `signPlugin.privateKey`](tools_intellij_platform_gradle_plugin_tasks.md#signPlugin-privateKey)
|
||||
|
||||
|
||||
### privateKeyFile
|
||||
### `privateKeyFile`
|
||||
{#intellijPlatform-signing-privateKeyFile}
|
||||
|
||||
A file with an encoded private key in the PEM format.
|
||||
@ -779,7 +779,7 @@ See also:
|
||||
- [Tasks: `signPlugin.privateKeyFile`](tools_intellij_platform_gradle_plugin_tasks.md#signPlugin-privateKeyFile)
|
||||
|
||||
|
||||
### password
|
||||
### `password`
|
||||
{#intellijPlatform-signing-password}
|
||||
|
||||
Password required to decrypt the private key.
|
||||
@ -793,7 +793,7 @@ See also:
|
||||
- [Tasks: `signPlugin.password`](tools_intellij_platform_gradle_plugin_tasks.md#signPlugin-password)
|
||||
|
||||
|
||||
### certificateChain
|
||||
### `certificateChain`
|
||||
{#intellijPlatform-signing-certificateChain}
|
||||
|
||||
A string containing X509 certificates.
|
||||
@ -810,7 +810,7 @@ See also:
|
||||
- [Tasks: `signPlugin.certificateChain`](tools_intellij_platform_gradle_plugin_tasks.md#signPlugin-certificateChain)
|
||||
|
||||
|
||||
### certificateChainFile
|
||||
### `certificateChainFile`
|
||||
{#intellijPlatform-signing-certificateChainFile}
|
||||
|
||||
Path to the file containing X509 certificates.
|
||||
@ -864,7 +864,7 @@ See also:
|
||||
- [IntelliJ Plugin Verifier CLI](https://github.com/JetBrains/intellij-plugin-verifier)
|
||||
|
||||
|
||||
### cliPath
|
||||
### `cliPath`
|
||||
{#intellijPlatform-verifyPlugin-cliPath}
|
||||
|
||||
A path to the local IntelliJ Plugin Verifier CLI tool to be used.
|
||||
@ -877,7 +877,7 @@ See also:
|
||||
- [Task Awares: `PluginVerifierAware`](tools_intellij_platform_gradle_plugin_task_awares.md#PluginVerifierAware)
|
||||
|
||||
|
||||
### downloadDirectory
|
||||
### `downloadDirectory`
|
||||
{#intellijPlatform-verifyPlugin-downloadDirectory}
|
||||
|
||||
The path to the directory where IDEs used for the verification will be downloaded.
|
||||
@ -890,7 +890,7 @@ Default value
|
||||
: <path>[`homeDirectory`](#intellijPlatform-verifyPlugin-homeDirectory)/ides</path>
|
||||
|
||||
|
||||
### failureLevel
|
||||
### `failureLevel`
|
||||
{#intellijPlatform-verifyPlugin-failureLevel}
|
||||
|
||||
Defines the verification level at which the task should fail if any reported issue matches.
|
||||
@ -906,7 +906,7 @@ See also:
|
||||
- [Tasks: `verifyPlugin.failureLevel`](tools_intellij_platform_gradle_plugin_tasks.md#verifyPlugin-failureLevel)
|
||||
|
||||
|
||||
### externalPrefixes
|
||||
### `externalPrefixes`
|
||||
{#intellijPlatform-verifyPlugin-externalPrefixes}
|
||||
|
||||
The list of class prefixes from the external libraries.
|
||||
@ -920,7 +920,7 @@ See also:
|
||||
- [Tasks: `verifyPlugin.externalPrefixes`](tools_intellij_platform_gradle_plugin_tasks.md#verifyPlugin-externalPrefixes)
|
||||
|
||||
|
||||
### freeArgs
|
||||
### `freeArgs`
|
||||
{#intellijPlatform-verifyPlugin-freeArgs}
|
||||
|
||||
The list of free arguments is passed directly to the IntelliJ Plugin Verifier CLI tool.
|
||||
@ -935,7 +935,7 @@ See also:
|
||||
- [Tasks: `verifyPlugin.freeArgs`](tools_intellij_platform_gradle_plugin_tasks.md#verifyPlugin-freeArgs)
|
||||
|
||||
|
||||
### homeDirectory
|
||||
### `homeDirectory`
|
||||
{#intellijPlatform-verifyPlugin-homeDirectory}
|
||||
|
||||
Retrieve the Plugin Verifier home directory used for storing downloaded IDEs.
|
||||
@ -952,7 +952,7 @@ Default value
|
||||
- <path>[buildDirectory]/tmp/pluginVerifier</path>
|
||||
|
||||
|
||||
### ignoredProblemsFile
|
||||
### `ignoredProblemsFile`
|
||||
{#intellijPlatform-verifyPlugin-ignoredProblemsFile}
|
||||
|
||||
A file that contains a list of problems that will be ignored in a report.
|
||||
@ -965,7 +965,7 @@ See also:
|
||||
- [Tasks: `verifyPlugin.ignoredProblemsFile`](tools_intellij_platform_gradle_plugin_tasks.md#verifyPlugin-ignoredProblemsFile)
|
||||
|
||||
|
||||
### subsystemsToCheck
|
||||
### `subsystemsToCheck`
|
||||
{#intellijPlatform-verifyPlugin-subsystemsToCheck}
|
||||
|
||||
Which subsystems of the IDE should be checked.
|
||||
@ -981,7 +981,7 @@ See also:
|
||||
- [Tasks: `verifyPlugin.subsystemsToCheck`](tools_intellij_platform_gradle_plugin_tasks.md#verifyPlugin-subsystemsToCheck)
|
||||
|
||||
|
||||
### teamCityOutputFormat
|
||||
### `teamCityOutputFormat`
|
||||
{#intellijPlatform-verifyPlugin-teamCityOutputFormat}
|
||||
|
||||
A flag that controls the output format.
|
||||
@ -998,7 +998,7 @@ See also:
|
||||
- [Tasks: `verifyPlugin.teamCityOutputFormat`](tools_intellij_platform_gradle_plugin_tasks.md#verifyPlugin-teamCityOutputFormat)
|
||||
|
||||
|
||||
### verificationReportsDirectory
|
||||
### `verificationReportsDirectory`
|
||||
{#intellijPlatform-verifyPlugin-verificationReportsDirectory}
|
||||
|
||||
The path to the directory where verification reports will be saved.
|
||||
@ -1014,7 +1014,7 @@ See also:
|
||||
- [Tasks: `verifyPlugin.verificationReportsDirectory`](tools_intellij_platform_gradle_plugin_tasks.md#verifyPlugin-verificationReportsDirectory)
|
||||
|
||||
|
||||
### verificationReportsFormats
|
||||
### `verificationReportsFormats`
|
||||
{#intellijPlatform-verifyPlugin-verificationReportsFormats}
|
||||
|
||||
The output formats of the verification reports.
|
||||
|
||||
@ -15,7 +15,7 @@ org.jetbrains.intellij.platform.<name>=<value>
|
||||
|
||||
## General Gradle Properties
|
||||
|
||||
### intellijPlatformCache
|
||||
### `intellijPlatformCache`
|
||||
{#intellijPlatformCache}
|
||||
|
||||
The plugin uses a dedicated cache directory to store files related to the current project configuration files, such as:
|
||||
@ -31,7 +31,7 @@ Example
|
||||
org.jetbrains.intellij.platform.intellijPlatformCache=/path/to/intellijPlatformCache/
|
||||
```
|
||||
|
||||
### localPlatformArtifacts
|
||||
### `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.
|
||||
@ -61,7 +61,7 @@ E.g., to disable the [](#selfUpdateCheck) feature, add this line:
|
||||
org.jetbrains.intellij.platform.buildFeature.selfUpdateCheck=false
|
||||
```
|
||||
|
||||
### downloadSources
|
||||
### `downloadSources`
|
||||
{#downloadSources}
|
||||
|
||||
Instruct IDE that sources are needed to be downloaded when working with IntelliJ Platform Gradle Plugin.
|
||||
@ -82,7 +82,7 @@ org.jetbrains.intellij.platform.buildFeature.downloadSources=true
|
||||
```
|
||||
|
||||
|
||||
### noSearchableOptionsWarning
|
||||
### `noSearchableOptionsWarning`
|
||||
{#noSearchableOptionsWarning}
|
||||
|
||||
When the [](tools_intellij_platform_gradle_plugin_tasks.md#buildSearchableOptions) doesn't produce any results, e.g., when the plugin doesn't implement any [Settings](settings.md), a warning is shown to suggest disabling it for better performance with [](tools_intellij_platform_gradle_plugin_extension.md#intellijPlatform-buildSearchableOptions).
|
||||
@ -97,7 +97,7 @@ Example
|
||||
org.jetbrains.intellij.platform.buildFeature.buildSearchableOptions=false
|
||||
```
|
||||
|
||||
### paidPluginSearchableOptionsWarning
|
||||
### `paidPluginSearchableOptionsWarning`
|
||||
{#paidPluginSearchableOptionsWarning}
|
||||
|
||||
Due to IDE limitations, it is impossible to run the IDE in headless mode to collect searchable options for a paid plugin.
|
||||
@ -114,7 +114,7 @@ Example
|
||||
org.jetbrains.intellij.platform.buildFeature.paidPluginSearchableOptionsWarning=false
|
||||
```
|
||||
|
||||
### selfUpdateCheck
|
||||
### `selfUpdateCheck`
|
||||
{#selfUpdateCheck}
|
||||
|
||||
Checks whether the currently used IntelliJ Platform Gradle Plugin is outdated and if a new release is available.
|
||||
@ -137,7 +137,7 @@ Example
|
||||
org.jetbrains.intellij.platform.buildFeature.selfUpdateCheck=false
|
||||
```
|
||||
|
||||
### useCacheRedirector
|
||||
### `useCacheRedirector`
|
||||
{#useCacheRedirector}
|
||||
|
||||
By default, JetBrains Cache Redirector is used when resolving Maven repositories or any resources used by the IntelliJ Platform Gradle Plugin.
|
||||
@ -155,7 +155,7 @@ Example
|
||||
org.jetbrains.intellij.platform.buildFeature.useCacheRedirector=false
|
||||
```
|
||||
|
||||
### useClosestJavaCompilerVersion
|
||||
### `useClosestJavaCompilerVersion`
|
||||
{#useClosestJavaCompilerVersion}
|
||||
|
||||
Java Compiler dependency required for the [](tools_intellij_platform_gradle_plugin.md#code-instrumentation) is tied to IntelliJ Platform build numbers and hosted in the IntelliJ Dependencies Repository.
|
||||
|
||||
@ -42,12 +42,12 @@ plugins {
|
||||
}
|
||||
```
|
||||
|
||||
## intellij {} extension
|
||||
## `intellij {}` extension
|
||||
|
||||
The `intellij {}` extension is no longer available and was replaced with `intellijPlatform {}`.
|
||||
Note that the available properties differ, see [](tools_intellij_platform_gradle_plugin_extension.md) for details.
|
||||
|
||||
### intellij.pluginName
|
||||
### `intellij.pluginName`
|
||||
|
||||
Use: [`intellijPlatform.pluginConfiguration.name`](tools_intellij_platform_gradle_plugin_extension.md#intellijPlatform-pluginConfiguration-name):
|
||||
|
||||
@ -59,9 +59,9 @@ intellijPlatform {
|
||||
}
|
||||
```
|
||||
|
||||
### intellij.type, intellij.version
|
||||
### `intellij.type`, `intellij.version`
|
||||
|
||||
Define the IntelliJ Platform dependency in `dependencies {}` block:
|
||||
Define the IntelliJ Platform dependency in `dependencies{}` block:
|
||||
|
||||
```kotlin
|
||||
repositories {
|
||||
@ -80,7 +80,7 @@ dependencies {
|
||||
|
||||
See: [](tools_intellij_platform_gradle_plugin_dependencies_extension.md)
|
||||
|
||||
### intellij.plugins
|
||||
### `intellij.plugins`
|
||||
|
||||
The `intellij.plugins` property is no longer available.
|
||||
|
||||
@ -114,7 +114,7 @@ See: [](tools_intellij_platform_gradle_plugin_dependencies_extension.md#plugins)
|
||||
|
||||
<include from="tools_intellij_platform_gradle_plugin_repositories_extension.md" element-id="localPlatformArtifacts_required"/>
|
||||
|
||||
### intellij.localPath
|
||||
### `intellij.localPath`
|
||||
|
||||
Define dependencies on local IDE instance in `dependencies {}` block:
|
||||
|
||||
@ -137,13 +137,13 @@ See: [](tools_intellij_platform_gradle_plugin_dependencies_extension.md#custom-t
|
||||
|
||||
<include from="tools_intellij_platform_gradle_plugin_repositories_extension.md" element-id="localPlatformArtifacts_required"/>
|
||||
|
||||
### intellij.updateSinceUntilBuild, intellij.sameSinceUntilBuild
|
||||
### `intellij.updateSinceUntilBuild`, `intellij.sameSinceUntilBuild`
|
||||
|
||||
The <path>plugin.xml</path> file is now fully managed by the [`intellijPlatform`](tools_intellij_platform_gradle_plugin_extension.md) extension.
|
||||
|
||||
### intellij.intellijRepository, intellij.pluginsRepositories, intellij.jreRepository
|
||||
### `intellij.intellijRepository`,` intellij.pluginsRepositories`, `intellij.jreRepository`
|
||||
|
||||
### intellij.sandboxDir
|
||||
### `intellij.sandboxDir`
|
||||
|
||||
Use the [`intellijPlatform.sandboxContainer`](tools_intellij_platform_gradle_plugin_extension.md#intellijPlatform-sandboxContainer).
|
||||
|
||||
@ -151,31 +151,31 @@ Use the `repositories {}` block to manage repositories instead.
|
||||
|
||||
See: [](tools_intellij_platform_gradle_plugin_repositories_extension.md)
|
||||
|
||||
### intellij.downloadSources
|
||||
### `intellij.downloadSources`
|
||||
|
||||
Downloading sources is managed by the Plugin DevKit plugin in version 2024.1+.
|
||||
|
||||
### intellij.ideaDependency
|
||||
### `intellij.ideaDependency`
|
||||
|
||||
Access now the [`ProductInfo`](tools_intellij_platform_gradle_plugin_types.md#ProductInfo) object using the [`intellijPlatform.productInfo`](tools_intellij_platform_gradle_plugin_types.md#ProductInfo) property.
|
||||
|
||||
## Tasks
|
||||
|
||||
### downloadRobotServerPlugin
|
||||
### `downloadRobotServerPlugin`
|
||||
|
||||
The Robot Server Plugin integration is not yet available. See [`testIdeUi`](tools_intellij_platform_gradle_plugin_tasks.md#testIdeUi).
|
||||
|
||||
### runIdeForUiTests
|
||||
### `runIdeForUiTests`
|
||||
|
||||
Use [`testIdeUi`](tools_intellij_platform_gradle_plugin_tasks.md#testIdeUi).
|
||||
|
||||
### runPluginVerifier
|
||||
### `runPluginVerifier`
|
||||
|
||||
The task for running the IntelliJ Plugin Verifier is now called [`verifyPlugin`](tools_intellij_platform_gradle_plugin_tasks.md#verifyPlugin).
|
||||
|
||||
Use [`intellijPlatform.verifyPlugin`](tools_intellij_platform_gradle_plugin_extension.md#intellijPlatform-verifyPlugin) extension to configure it.
|
||||
|
||||
### setupDependencies
|
||||
### `setupDependencies`
|
||||
|
||||
To make the IntelliJ SDK dependency available in the IDE, the `setupDependencies` task was provided by Gradle IntelliJ Plugin 1.x.
|
||||
This task is no longer required, but when switching from 1.x, Gradle may still want to execute it in the _afterSync_ phase.
|
||||
|
||||
@ -9,7 +9,7 @@
|
||||
The Task Awares is a set of interfaces that can be applied to custom Gradle tasks and, when registered using the dedicated register method, inject new features or properties with predefined values.
|
||||
|
||||
|
||||
## CoroutinesJavaAgentAware
|
||||
## `CoroutinesJavaAgentAware`
|
||||
{#CoroutinesJavaAgentAware}
|
||||
|
||||
<tldr>
|
||||
@ -24,7 +24,7 @@ The Task Awares is a set of interfaces that can be applied to custom Gradle task
|
||||
|
||||
The interface provides the path to the Java Agent file for the Coroutines library required to enable coroutines debugging.
|
||||
|
||||
### coroutinesJavaAgentFile
|
||||
### `coroutinesJavaAgentFile`
|
||||
{#CoroutinesJavaAgentAware-coroutinesJavaAgentFile}
|
||||
|
||||
The path to the coroutines Java Agent file.
|
||||
@ -37,7 +37,7 @@ Default value
|
||||
: [`initializeIntellijPlatformPlugin.coroutinesJavaAgent`](tools_intellij_platform_gradle_plugin_tasks.md#initializeIntelliJPlatformPlugin-coroutinesJavaAgent)
|
||||
|
||||
|
||||
## CustomIntelliJPlatformVersionAware
|
||||
## `CustomIntelliJPlatformVersionAware`
|
||||
{#CustomIntelliJPlatformVersionAware}
|
||||
|
||||
<tldr>
|
||||
@ -57,7 +57,7 @@ When applying this interface to the task, custom configurations to hold new depe
|
||||
Configurations, as well as the task preparing sandbox for running and testing the custom IntelliJ Platform (if required), have a random suffix applied to avoid collisions.
|
||||
|
||||
|
||||
### type
|
||||
### `type`
|
||||
{#CustomIntelliJPlatformVersionAware-type}
|
||||
|
||||
An input property to configure the type of the custom IntelliJ Platform.
|
||||
@ -69,7 +69,7 @@ Type
|
||||
: [`IntelliJPlatformType`](tools_intellij_platform_gradle_plugin_types.md#IntelliJPlatformType)
|
||||
|
||||
|
||||
### version
|
||||
### `version`
|
||||
{#CustomIntelliJPlatformVersionAware-version}
|
||||
|
||||
An input property to configure the version of the custom IntelliJ Platform.
|
||||
@ -81,7 +81,7 @@ Type
|
||||
: `Property<String>`
|
||||
|
||||
|
||||
### localPath
|
||||
### `localPath`
|
||||
{#CustomIntelliJPlatformVersionAware-localPath}
|
||||
|
||||
An input property to define the path to the local IntelliJ Platform instance to configure the version of the custom IntelliJ Platform.
|
||||
@ -93,7 +93,7 @@ Type
|
||||
: `DirectoryProperty`
|
||||
|
||||
|
||||
## IntelliJPlatformVersionAware
|
||||
## `IntelliJPlatformVersionAware`
|
||||
{#IntelliJPlatformVersionAware}
|
||||
|
||||
<tldr>
|
||||
@ -111,7 +111,7 @@ The [`intelliJPlatformConfiguration`](#IntelliJPlatformVersionAware-intelliJPlat
|
||||
It is required to have a dependency on the IntelliJ Platform added to the project with helpers available in [](tools_intellij_platform_gradle_plugin_dependencies_extension.md).
|
||||
|
||||
|
||||
### intelliJPlatformConfiguration
|
||||
### `intelliJPlatformConfiguration`
|
||||
{#IntelliJPlatformVersionAware-intelliJPlatformConfiguration}
|
||||
|
||||
Holds the `intellijPlatform` configuration with the IntelliJ Platform dependency added.
|
||||
@ -123,7 +123,7 @@ Type
|
||||
: `ConfigurableFileCollection`
|
||||
|
||||
|
||||
### platformPath
|
||||
### `platformPath`
|
||||
{#IntelliJPlatformVersionAware-platformPath}
|
||||
|
||||
Provides a direct path to the IntelliJ Platform dependency artifact.
|
||||
@ -135,7 +135,7 @@ Access
|
||||
Type
|
||||
: `Path`
|
||||
|
||||
### productInfo
|
||||
### `productInfo`
|
||||
{#IntelliJPlatformVersionAware-productInfo}
|
||||
|
||||
Provides information about the IntelliJ Platform product.
|
||||
@ -150,7 +150,7 @@ Type
|
||||
: [`ProductInfo`](tools_intellij_platform_gradle_plugin_types.md#ProductInfo)
|
||||
|
||||
|
||||
### validateIntelliJPlatformVersion()
|
||||
### `validateIntelliJPlatformVersion()`
|
||||
{#IntelliJPlatformVersionAware-validateIntelliJPlatformVersion}
|
||||
|
||||
Validates that the resolved IntelliJ Platform is supported by checking against the minimal supported IntelliJ Platform version.
|
||||
@ -162,7 +162,7 @@ Throws
|
||||
: `IllegalArgumentException`
|
||||
|
||||
|
||||
## JavaCompilerAware
|
||||
## `JavaCompilerAware`
|
||||
{#JavaCompilerAware}
|
||||
|
||||
<tldr>
|
||||
@ -176,7 +176,7 @@ Throws
|
||||
The interface provides the dependency on Java Compiler required for the [](tools_intellij_platform_gradle_plugin.md#code-instrumentation) to properly configure Ant tasks provided by the IntelliJ Platform.
|
||||
|
||||
|
||||
## PluginAware
|
||||
## `PluginAware`
|
||||
{#PluginAware}
|
||||
|
||||
<tldr>
|
||||
@ -194,7 +194,7 @@ This interface provides information about the currently built plugin.
|
||||
It resolves and parses the final <path>plugin.xml</path> descriptor file, making its details easily accessible.
|
||||
|
||||
|
||||
### pluginXml
|
||||
### `pluginXml`
|
||||
{#PluginAware-pluginXml}
|
||||
|
||||
Holds the path to the patched <path>plugin.xml</path> file.
|
||||
@ -207,13 +207,13 @@ Default value
|
||||
: [`patchPluginXml.outputFile`](tools_intellij_platform_gradle_plugin_tasks.md#patchPluginXml-outputFile)
|
||||
|
||||
|
||||
### parse {}
|
||||
### `parse {}`
|
||||
{#PluginAware-parse}
|
||||
|
||||
The `parse` method provides a possibility for parsing the <path>pluginXml</path> file and direct access to the [`PluginBean`](tools_intellij_platform_gradle_plugin_types.md#PluginBean) object.
|
||||
|
||||
|
||||
## PluginVerifierAware
|
||||
## `PluginVerifierAware`
|
||||
{#PluginVerifierAware}
|
||||
|
||||
<tldr>
|
||||
@ -229,7 +229,7 @@ The interface provides the path to the IntelliJ Plugin Verifier executable.
|
||||
It is required to have a dependency on the IntelliJ Plugin Verifier added to the project with [`intellijPlatform.pluginVerifier()`](tools_intellij_platform_gradle_plugin_dependencies_extension.md) dependencies extension.
|
||||
|
||||
|
||||
### pluginVerifierExecutable
|
||||
### `pluginVerifierExecutable`
|
||||
{#PluginVerifierAware-pluginVerifierExecutable}
|
||||
|
||||
Path to the IntelliJ Plugin Verifier executable.
|
||||
@ -239,7 +239,7 @@ Type
|
||||
: `RegularFileProperty`
|
||||
|
||||
|
||||
## RunnableIdeAware
|
||||
## `RunnableIdeAware`
|
||||
{#RunnableIdeAware}
|
||||
|
||||
<tldr>
|
||||
@ -260,7 +260,7 @@ The interface which uses a set of various interfaces required for running a gues
|
||||
- `JavaForkOptions`
|
||||
|
||||
|
||||
## RuntimeAware
|
||||
## `RuntimeAware`
|
||||
{#RuntimeAware}
|
||||
|
||||
<tldr>
|
||||
@ -273,7 +273,7 @@ The interface which uses a set of various interfaces required for running a gues
|
||||
|
||||
This interface provides access to the Java Runtime (i.e., JetBrains Runtime) resolved with `RuntimeResolver`.
|
||||
|
||||
### runtimeDirectory
|
||||
### `runtimeDirectory`
|
||||
{#RuntimeAware-runtimeDirectory}
|
||||
|
||||
Java Runtime parent directory.
|
||||
@ -283,7 +283,7 @@ Type
|
||||
: `DirectoryProperty`
|
||||
|
||||
|
||||
### runtimeExecutable
|
||||
### `runtimeExecutable`
|
||||
{#RuntimeAware-runtimeExecutable}
|
||||
|
||||
Path to the Java Runtime executable.
|
||||
@ -293,7 +293,7 @@ Type
|
||||
: `RegularFileProperty`
|
||||
|
||||
|
||||
### runtimeArch
|
||||
### `runtimeArch`
|
||||
{#RuntimeAware-runtimeArch}
|
||||
|
||||
An architecture of the Java Runtime currently used for running Gradle.
|
||||
@ -303,7 +303,7 @@ Type
|
||||
: `Property<String>`
|
||||
|
||||
|
||||
## SandboxAware
|
||||
## `SandboxAware`
|
||||
{#SandboxAware}
|
||||
|
||||
<tldr>
|
||||
@ -323,7 +323,7 @@ The path to the sandbox container is obtained using the [`intellijPlatform.sandb
|
||||
Paths respect custom IntelliJ Platform when combined with [`CustomIntelliJPlatformVersionAware`](#CustomIntelliJPlatformVersionAware).
|
||||
|
||||
|
||||
### sandboxSuffix
|
||||
### `sandboxSuffix`
|
||||
{#SandboxAware-sandboxSuffix}
|
||||
|
||||
Represents the suffix used i.e., for test-related tasks.
|
||||
@ -333,7 +333,7 @@ Type
|
||||
: `Property<String>`
|
||||
|
||||
|
||||
### sandboxContainerDirectory
|
||||
### `sandboxContainerDirectory`
|
||||
{#SandboxAware-sandboxContainerDirectory}
|
||||
|
||||
The container for all sandbox-related directories.
|
||||
@ -345,7 +345,7 @@ Type
|
||||
: `DirectoryProperty`
|
||||
|
||||
|
||||
### sandboxConfigDirectory
|
||||
### `sandboxConfigDirectory`
|
||||
{#SandboxAware-sandboxConfigDirectory}
|
||||
|
||||
A configuration directory located within the [`sandboxContainerDirectory`](#SandboxAware-sandboxContainerDirectory).
|
||||
@ -355,7 +355,7 @@ Type
|
||||
: `DirectoryProperty`
|
||||
|
||||
|
||||
### sandboxPluginsDirectory
|
||||
### `sandboxPluginsDirectory`
|
||||
{#SandboxAware-sandboxPluginsDirectory}
|
||||
|
||||
A plugins directory located within the [`sandboxContainerDirectory`](#SandboxAware-sandboxContainerDirectory).
|
||||
@ -365,7 +365,7 @@ Type
|
||||
: `DirectoryProperty`
|
||||
|
||||
|
||||
### sandboxSystemDirectory
|
||||
### `sandboxSystemDirectory`
|
||||
{#SandboxAware-sandboxSystemDirectory}
|
||||
|
||||
A system directory located within the [`sandboxContainerDirectory`](#SandboxAware-sandboxContainerDirectory).
|
||||
@ -375,7 +375,7 @@ Type
|
||||
: `DirectoryProperty`
|
||||
|
||||
|
||||
### sandboxLogDirectory
|
||||
### `sandboxLogDirectory`
|
||||
{#SandboxAware-sandboxLogDirectory}
|
||||
|
||||
A log directory located within the [`sandboxContainerDirectory`](#SandboxAware-sandboxContainerDirectory).
|
||||
@ -385,7 +385,7 @@ Type
|
||||
: `DirectoryProperty`
|
||||
|
||||
|
||||
## SigningAware
|
||||
## `SigningAware`
|
||||
{#SigningAware}
|
||||
|
||||
<tldr>
|
||||
@ -401,7 +401,7 @@ The interface provides the path to the Marketplace ZIP Signer executable.
|
||||
It is required to have a dependency on the Marketplace ZIP Signer added to the project with [`intellijPlatform.zipSigner()`](tools_intellij_platform_gradle_plugin_dependencies_extension.md) dependencies extension.
|
||||
|
||||
|
||||
### zipSignerExecutable
|
||||
### `zipSignerExecutable`
|
||||
{#SigningAware-zipSignerExecutable}
|
||||
|
||||
Path to the Marketplace ZIP Signer executable.
|
||||
|
||||
@ -114,7 +114,7 @@ flowchart LR
|
||||
style setupDependencies stroke-dasharray: 5 5
|
||||
```
|
||||
|
||||
## buildPlugin
|
||||
## `buildPlugin`
|
||||
{#buildPlugin}
|
||||
|
||||
<tldr>
|
||||
@ -136,7 +136,7 @@ The [`archiveFile`](#buildPlugin-archiveFile) name and location can be controlle
|
||||
By default, the `archiveBaseName` is set to the plugin name specified in the <path>plugin.xml</path> file, after it gets patched with the [`patchPluginXml`](#patchPluginXml) task.
|
||||
|
||||
|
||||
### archiveFile
|
||||
### `archiveFile`
|
||||
{#buildPlugin-archiveFile}
|
||||
|
||||
The archive file which represents the output file produced by the task.
|
||||
@ -149,7 +149,7 @@ Default value
|
||||
: [`buildPlugin.archiveFile`](#buildPlugin-archiveFile)
|
||||
|
||||
|
||||
## buildSearchableOptions
|
||||
## `buildSearchableOptions`
|
||||
{#buildSearchableOptions}
|
||||
|
||||
<tldr>
|
||||
@ -171,7 +171,7 @@ In the case of running the task for the plugin using [`intellijPlatform.pluginCo
|
||||
It is possible to mute this warning with the [`paidPluginSearchableOptionsWarning`](tools_intellij_platform_gradle_plugin_gradle_properties.md#paidPluginSearchableOptionsWarning) build feature.
|
||||
|
||||
|
||||
### outputDirectory
|
||||
### `outputDirectory`
|
||||
{#buildSearchableOptions-outputDirectory}
|
||||
|
||||
The directory to which searchable options will be generated.
|
||||
@ -184,7 +184,7 @@ Default value
|
||||
: <path>[buildDirectory]/searchableOptions</path>
|
||||
|
||||
|
||||
### showPaidPluginWarning
|
||||
### `showPaidPluginWarning`
|
||||
{#buildSearchableOptions-showPaidPluginWarning}
|
||||
|
||||
Emit warning if the task is executed by a paid plugin.
|
||||
@ -198,7 +198,7 @@ Default value
|
||||
: [`paidPluginSearchableOptionsWarning`](tools_intellij_platform_gradle_plugin_gradle_properties.md#paidPluginSearchableOptionsWarning) && `productDescriptor` is defined
|
||||
|
||||
|
||||
## classpathIndexCleanup
|
||||
## `classpathIndexCleanup`
|
||||
{#classpathIndexCleanup}
|
||||
|
||||
> Deprecated?
|
||||
@ -206,7 +206,7 @@ Default value
|
||||
{style="warning"}
|
||||
|
||||
|
||||
## initializeIntelliJPlatformPlugin
|
||||
## `initializeIntelliJPlatformPlugin`
|
||||
{#initializeIntelliJPlatformPlugin}
|
||||
|
||||
<tldr>
|
||||
@ -228,7 +228,7 @@ The self-update check can be disabled via [`selfUpdateCheck`](tools_intellij_pla
|
||||
To make the Coroutines Java Agent available for the task, inherit from [`CoroutinesJavaAgentAware`](tools_intellij_platform_gradle_plugin_task_awares.md#CoroutinesJavaAgentAware).
|
||||
|
||||
|
||||
### offline
|
||||
### `offline`
|
||||
{#initializeIntelliJPlatformPlugin-offline}
|
||||
|
||||
Determines if the operation is running in offline mode.
|
||||
@ -247,7 +247,7 @@ See also:
|
||||
- [Command Line Execution Options](https://docs.gradle.org/current/userguide/command_line_interface.html#sec:command_line_execution_options)
|
||||
|
||||
|
||||
### selfUpdateCheck
|
||||
### `selfUpdateCheck`
|
||||
{#initializeIntelliJPlatformPlugin-selfUpdateCheck}
|
||||
|
||||
Represents the property for checking if self-update checks are enabled.
|
||||
@ -260,7 +260,7 @@ Default value
|
||||
: [`selfUpdateCheck`](tools_intellij_platform_gradle_plugin_gradle_properties.md#selfUpdateCheck)
|
||||
|
||||
|
||||
### selfUpdateLock
|
||||
### `selfUpdateLock`
|
||||
{#initializeIntelliJPlatformPlugin-selfUpdateLock}
|
||||
|
||||
Represents a lock file used to limit the plugin version checks in time.
|
||||
@ -271,7 +271,7 @@ Type
|
||||
: `RegularFileProperty`
|
||||
|
||||
|
||||
### coroutinesJavaAgent
|
||||
### `coroutinesJavaAgent`
|
||||
{#initializeIntelliJPlatformPlugin-coroutinesJavaAgent}
|
||||
|
||||
Java Agent file for the Coroutines library, which is required to enable coroutines debugging.
|
||||
@ -284,7 +284,7 @@ Default value
|
||||
: <path>[buildDirectory]/tmp/initializeIntelliJPlatformPlugin/coroutines-javaagent.jar</path>
|
||||
|
||||
|
||||
### pluginVersion
|
||||
### `pluginVersion`
|
||||
{#initializeIntelliJPlatformPlugin-pluginVersion}
|
||||
|
||||
Represents the current version of the plugin.
|
||||
@ -294,7 +294,7 @@ Type
|
||||
: `Property<String>`
|
||||
|
||||
|
||||
## instrumentCode
|
||||
## `instrumentCode`
|
||||
{#instrumentCode}
|
||||
|
||||
<tldr>
|
||||
@ -317,7 +317,7 @@ See also:
|
||||
- [](tools_intellij_platform_gradle_plugin.md#code-instrumentation)
|
||||
|
||||
|
||||
## instrumentedJar
|
||||
## `instrumentedJar`
|
||||
{#instrumentedJar}
|
||||
|
||||
> Not implemented.
|
||||
@ -325,7 +325,7 @@ See also:
|
||||
{style="warning"}
|
||||
|
||||
|
||||
## jarSearchableOptions
|
||||
## `jarSearchableOptions`
|
||||
{#jarSearchableOptions}
|
||||
|
||||
<tldr>
|
||||
@ -341,7 +341,7 @@ See also:
|
||||
Creates a JAR file with searchable options to be distributed with the plugin.
|
||||
|
||||
|
||||
### destinationDirectory
|
||||
### `destinationDirectory`
|
||||
{#jarSearchableOptions-destinationDirectory}
|
||||
|
||||
The directory where the JAR file will be created.
|
||||
@ -354,7 +354,7 @@ Default value
|
||||
: <path>[buildDirectory]/libsSearchableOptions</path>
|
||||
|
||||
|
||||
### inputDirectory
|
||||
### `inputDirectory`
|
||||
{#jarSearchableOptions-inputDirectory}
|
||||
|
||||
The directory from which
|
||||
@ -367,7 +367,7 @@ Default value
|
||||
: <path>[buildDirectory]/tmp/initializeIntelliJPlatformPlugin/coroutines-javaagent.jar</path>
|
||||
|
||||
|
||||
### noSearchableOptionsWarning
|
||||
### `noSearchableOptionsWarning`
|
||||
{#jarSearchableOptions-noSearchableOptionsWarning}
|
||||
|
||||
Emit a warning if no searchable options are found.
|
||||
@ -381,7 +381,7 @@ Default value
|
||||
: [`noSearchableOptionsWarning`](tools_intellij_platform_gradle_plugin_gradle_properties.md#noSearchableOptionsWarning)
|
||||
|
||||
|
||||
## patchPluginXml
|
||||
## `patchPluginXml`
|
||||
{#patchPluginXml}
|
||||
|
||||
<tldr>
|
||||
@ -393,7 +393,7 @@ Default value
|
||||
</tldr>
|
||||
|
||||
|
||||
### inputFile
|
||||
### `inputFile`
|
||||
{#patchPluginXml-inputFile}
|
||||
|
||||
Represents an input <path>plugin.xml</path> file.
|
||||
@ -408,7 +408,7 @@ Default value
|
||||
: <path>src/main/<kotlin|java>/resources/META-INF/plugin.xml</path>
|
||||
|
||||
|
||||
### outputFile
|
||||
### `outputFile`
|
||||
{#patchPluginXml-outputFile}
|
||||
|
||||
Represents the output <path>plugin.xml</path> file property for the task.
|
||||
@ -423,7 +423,7 @@ Default value
|
||||
: <path>[buildDirectory]/tmp/patchPluginXml/plugin.xml</path>
|
||||
|
||||
|
||||
### pluginId
|
||||
### `pluginId`
|
||||
{#patchPluginXml-pluginId}
|
||||
|
||||
A unique identifier of the plugin.
|
||||
@ -446,7 +446,7 @@ See also:
|
||||
- [Plugin Configuration File: `id`](plugin_configuration_file.md#idea-plugin__id)
|
||||
|
||||
|
||||
### pluginName
|
||||
### `pluginName`
|
||||
{#patchPluginXml-pluginName}
|
||||
|
||||
The user-visible plugin display name (Title Case).
|
||||
@ -464,7 +464,7 @@ See also:
|
||||
- [Plugin Configuration File: `name`](plugin_configuration_file.md#idea-plugin__name)
|
||||
|
||||
|
||||
### pluginVersion
|
||||
### `pluginVersion`
|
||||
{#patchPluginXml-pluginVersion}
|
||||
|
||||
The plugin version is displayed in the Plugins settings dialog and on the JetBrains Marketplace plugin page.
|
||||
@ -484,7 +484,7 @@ See also:
|
||||
- [Plugin Configuration File: `version`](plugin_configuration_file.md#idea-plugin__version)
|
||||
|
||||
|
||||
### pluginDescription
|
||||
### `pluginDescription`
|
||||
{#patchPluginXml-pluginDescription}
|
||||
|
||||
The plugin description is displayed on the JetBrains Marketplace plugin page and in the Plugins settings dialog.
|
||||
@ -505,7 +505,7 @@ See also:
|
||||
- [Plugin Configuration File: `description`](plugin_configuration_file.md#idea-plugin__description)
|
||||
|
||||
|
||||
### changeNotes
|
||||
### `changeNotes`
|
||||
{#patchPluginXml-changeNotes}
|
||||
|
||||
A short summary of new features, bugfixes, and changes provided with the latest plugin version.
|
||||
@ -527,7 +527,7 @@ See also:
|
||||
- [Plugin Configuration File: `change-notes`](plugin_configuration_file.md#idea-plugin__change-notes)
|
||||
|
||||
|
||||
### productDescriptorCode
|
||||
### `productDescriptorCode`
|
||||
{#patchPluginXml-productDescriptorCode}
|
||||
|
||||
The plugin product code used in the JetBrains Sales System.
|
||||
@ -546,7 +546,7 @@ See also:
|
||||
- [Plugin Configuration File: `product-descriptor`](plugin_configuration_file.md#idea-plugin__product-descriptor)
|
||||
|
||||
|
||||
### productDescriptorReleaseDate
|
||||
### `productDescriptorReleaseDate`
|
||||
{#patchPluginXml-productDescriptorReleaseDate}
|
||||
|
||||
Date of the major version release in the `YYYYMMDD` format.
|
||||
@ -564,7 +564,7 @@ See also:
|
||||
- [Plugin Configuration File: `product-descriptor`](plugin_configuration_file.md#idea-plugin__product-descriptor)
|
||||
|
||||
|
||||
### productDescriptorReleaseVersion
|
||||
### `productDescriptorReleaseVersion`
|
||||
{#patchPluginXml-productDescriptorReleaseVersion}
|
||||
|
||||
A major version in a special number format.
|
||||
@ -582,7 +582,7 @@ See also:
|
||||
- [Plugin Configuration File: `product-descriptor`](plugin_configuration_file.md#idea-plugin__product-descriptor)
|
||||
|
||||
|
||||
### productDescriptorOptional
|
||||
### `productDescriptorOptional`
|
||||
{#patchPluginXml-productDescriptorOptional}
|
||||
|
||||
The boolean value determining whether the plugin is a [Freemium](https://plugins.jetbrains.com/docs/marketplace/freemium.html) plugin.
|
||||
@ -603,7 +603,7 @@ See also:
|
||||
- [Plugin Configuration File: `product-descriptor`](plugin_configuration_file.md#idea-plugin__product-descriptor)
|
||||
|
||||
|
||||
### sinceBuild
|
||||
### `sinceBuild`
|
||||
{#patchPluginXml-sinceBuild}
|
||||
|
||||
The lowest IDE version compatible with the plugin.
|
||||
@ -621,7 +621,7 @@ See also:
|
||||
- [Plugin Configuration File: `idea-version`](plugin_configuration_file.md#idea-plugin__idea-version)
|
||||
|
||||
|
||||
### untilBuild
|
||||
### `untilBuild`
|
||||
{#patchPluginXml-untilBuild}
|
||||
|
||||
The highest IDE version compatible with the plugin.
|
||||
@ -643,7 +643,7 @@ See also:
|
||||
- [Plugin Configuration File: `idea-version`](plugin_configuration_file.md#idea-plugin__idea-version)
|
||||
|
||||
|
||||
### vendorName
|
||||
### `vendorName`
|
||||
{#patchPluginXml-vendorName}
|
||||
|
||||
The vendor name or organization ID (if created) in the Plugins settings dialog and on the JetBrains Marketplace plugin page.
|
||||
@ -661,7 +661,7 @@ See also:
|
||||
- [Plugin Configuration File: `vendor`](plugin_configuration_file.md#idea-plugin__vendor)
|
||||
|
||||
|
||||
### vendorEmail
|
||||
### `vendorEmail`
|
||||
{#patchPluginXml-vendorEmail}
|
||||
|
||||
The vendor's email address.
|
||||
@ -679,7 +679,7 @@ See also:
|
||||
- [Plugin Configuration File: `vendor`](plugin_configuration_file.md#idea-plugin__vendor)
|
||||
|
||||
|
||||
### vendorUrl
|
||||
### `vendorUrl`
|
||||
{#patchPluginXml-vendorUrl}
|
||||
|
||||
The link to the vendor's homepage.
|
||||
@ -697,7 +697,7 @@ See also:
|
||||
- [Plugin Configuration File: `vendor`](plugin_configuration_file.md#idea-plugin__vendor)
|
||||
|
||||
|
||||
## prepareSandbox
|
||||
## `prepareSandbox`
|
||||
{#prepareSandbox}
|
||||
|
||||
<tldr>
|
||||
@ -720,7 +720,7 @@ See also:
|
||||
- [Extension: `intellijPlatform.sandboxContainer`](tools_intellij_platform_gradle_plugin_extension.md#intellijPlatform-sandboxContainer)
|
||||
|
||||
|
||||
### defaultDestinationDirectory
|
||||
### `defaultDestinationDirectory`
|
||||
{#prepareSandbox-defaultDestinationDirectory}
|
||||
|
||||
Default sandbox destination directory to where the plugin files will be copied into.
|
||||
@ -733,7 +733,7 @@ Default value
|
||||
: [`SandboxAware.sandboxPluginsDirectory`](tools_intellij_platform_gradle_plugin_task_awares.md#SandboxAware-sandboxPluginsDirectory)
|
||||
|
||||
|
||||
### pluginJar
|
||||
### `pluginJar`
|
||||
{#prepareSandbox-pluginJar}
|
||||
|
||||
The output of `Jar` task.
|
||||
@ -750,7 +750,7 @@ See also:
|
||||
- [Extension: `intellijPlatform.instrumentCode`](tools_intellij_platform_gradle_plugin_extension.md#intellijPlatform-instrumentCode)
|
||||
|
||||
|
||||
### pluginsClasspath
|
||||
### `pluginsClasspath`
|
||||
{#prepareSandbox-pluginsClasspath}
|
||||
|
||||
List of dependencies on external plugins resolved from the `intellijPlatformPluginsExtracted` configuration.
|
||||
@ -763,7 +763,7 @@ See also:
|
||||
- [Dependencies Extension](tools_intellij_platform_gradle_plugin_dependencies_extension.md)
|
||||
|
||||
|
||||
### runtimeClasspath
|
||||
### `runtimeClasspath`
|
||||
{#prepareSandbox-runtimeClasspath}
|
||||
|
||||
Dependencies defined with the `runtimeClasspath` configuration.
|
||||
@ -773,7 +773,7 @@ Type
|
||||
: `ConfigurableFileCollection`
|
||||
|
||||
|
||||
## printBundledPlugins
|
||||
## `printBundledPlugins`
|
||||
{#printBundledPlugins}
|
||||
|
||||
<tldr>
|
||||
@ -787,7 +787,7 @@ Type
|
||||
Prints the list of bundled plugins available within the currently targeted IntelliJ Platform.
|
||||
|
||||
|
||||
## printProductsReleases
|
||||
## `printProductsReleases`
|
||||
{#printProductsReleases}
|
||||
|
||||
<tldr>
|
||||
@ -801,7 +801,7 @@ Prints the list of bundled plugins available within the currently targeted Intel
|
||||
Prints the list of binary product releases that, by default, match the currently selected IntelliJ Platform along with [`intellijPlatform.pluginConfiguration.ideaVersion.sinceBuild`](tools_intellij_platform_gradle_plugin_extension.md#intellijPlatform-pluginConfiguration-ideaVersion-sinceBuild) and [`intellijPlatform.pluginConfiguration.ideaVersion.untilBuild`](tools_intellij_platform_gradle_plugin_extension.md#intellijPlatform-pluginConfiguration-ideaVersion-untilBuild) properties.
|
||||
|
||||
|
||||
### productsReleases
|
||||
### `productsReleases`
|
||||
{#printProductsReleases-productsReleases}
|
||||
|
||||
Property holds the list of product releases to print.
|
||||
@ -814,7 +814,7 @@ Default value
|
||||
: The output of `ProductReleasesValueSource` using default configuration
|
||||
|
||||
|
||||
## publishPlugin
|
||||
## `publishPlugin`
|
||||
{#publishPlugin}
|
||||
|
||||
<tldr>
|
||||
@ -835,7 +835,7 @@ See also:
|
||||
- [Plugin upload API](https://plugins.jetbrains.com/docs/marketplace/plugin-upload.html)
|
||||
|
||||
|
||||
### archiveFile
|
||||
### `archiveFile`
|
||||
{#publishPlugin-archiveFile}
|
||||
|
||||
ZIP archive to be published to the remote repository.
|
||||
@ -853,7 +853,7 @@ See also:
|
||||
- [Extension: `intellijPlatform.signing`](tools_intellij_platform_gradle_plugin_extension.md#intellijPlatform-signing)
|
||||
|
||||
|
||||
### host
|
||||
### `host`
|
||||
{#publishPlugin-host}
|
||||
|
||||
URL host of a plugin repository.
|
||||
@ -866,7 +866,7 @@ Default value
|
||||
: [`intellijPlatform.publishing.host`](tools_intellij_platform_gradle_plugin_extension.md#intellijPlatform-publishing-host)
|
||||
|
||||
|
||||
### token
|
||||
### `token`
|
||||
{#publishPlugin-token}
|
||||
|
||||
Authorization token.
|
||||
@ -882,7 +882,7 @@ Default value
|
||||
: [`intellijPlatform.publishing.token`](tools_intellij_platform_gradle_plugin_extension.md#intellijPlatform-publishing-token)
|
||||
|
||||
|
||||
### channels
|
||||
### `channels`
|
||||
{#publishPlugin-channels}
|
||||
|
||||
A list of channel names to upload plugin to.
|
||||
@ -895,7 +895,7 @@ Default value
|
||||
: [`intellijPlatform.publishing.channels`](tools_intellij_platform_gradle_plugin_extension.md#intellijPlatform-publishing-channels)
|
||||
|
||||
|
||||
### hidden
|
||||
### `hidden`
|
||||
{#publishPlugin-hidden}
|
||||
|
||||
Publish the plugin update and mark it as hidden to prevent public release after approval.
|
||||
@ -911,7 +911,7 @@ See also:
|
||||
- [Hidden release](https://plugins.jetbrains.com/docs/marketplace/hidden-plugin.html)
|
||||
|
||||
|
||||
### toolboxEnterprise
|
||||
### `toolboxEnterprise`
|
||||
{#publishPlugin-toolboxEnterprise}
|
||||
|
||||
Specifies if the Toolbox Enterprise plugin repository service should be used.
|
||||
@ -924,7 +924,7 @@ Default value
|
||||
: [`intellijPlatform.publishing.toolboxEnterprise`](tools_intellij_platform_gradle_plugin_extension.md#intellijPlatform-publishing-toolboxEnterprise)
|
||||
|
||||
|
||||
## runIde
|
||||
## `runIde`
|
||||
{#runIde}
|
||||
|
||||
<tldr>
|
||||
@ -956,7 +956,7 @@ tasks {
|
||||
}
|
||||
```
|
||||
|
||||
## signPlugin
|
||||
## `signPlugin`
|
||||
{#signPlugin}
|
||||
|
||||
<tldr>
|
||||
@ -978,7 +978,7 @@ As soon as [`privateKey`](#signPlugin-privateKey) (or [`privateKeyFile`](#signPl
|
||||
For more details, see [](plugin_signing.md).
|
||||
|
||||
|
||||
### archiveFile
|
||||
### `archiveFile`
|
||||
{#signPlugin-archiveFile}
|
||||
|
||||
Input, unsigned ZIP archive file.
|
||||
@ -994,7 +994,7 @@ Default value
|
||||
: [`buildPlugin.archiveFile`](#buildPlugin-archiveFile)
|
||||
|
||||
|
||||
### signedArchiveFile
|
||||
### `signedArchiveFile`
|
||||
{#signPlugin-signedArchiveFile}
|
||||
|
||||
Output, signed ZIP archive file.
|
||||
@ -1011,7 +1011,7 @@ Default value
|
||||
: [`signPlugin.archiveFile`](#signPlugin-archiveFile) with `-signed` suffix applied to the name
|
||||
|
||||
|
||||
### keyStore
|
||||
### `keyStore`
|
||||
{#signPlugin-keyStore}
|
||||
|
||||
KeyStore file path.
|
||||
@ -1025,7 +1025,7 @@ Default value
|
||||
: [`intellijPlatform.signing.keyStore`](tools_intellij_platform_gradle_plugin_extension.md#intellijPlatform-signing-keyStore)
|
||||
|
||||
|
||||
### keyStorePassword
|
||||
### `keyStorePassword`
|
||||
{#signPlugin-keyStorePassword}
|
||||
|
||||
KeyStore password.
|
||||
@ -1039,7 +1039,7 @@ Default value
|
||||
: [`intellijPlatform.signing.keyStorePassword`](tools_intellij_platform_gradle_plugin_extension.md#intellijPlatform-signing-keyStorePassword)
|
||||
|
||||
|
||||
### keyStoreKeyAlias
|
||||
### `keyStoreKeyAlias`
|
||||
{#signPlugin-keyStoreKeyAlias}
|
||||
|
||||
KeyStore key alias.
|
||||
@ -1053,7 +1053,7 @@ Default value
|
||||
: [`intellijPlatform.signing.keyStoreKeyAlias`](tools_intellij_platform_gradle_plugin_extension.md#intellijPlatform-signing-keyStoreKeyAlias)
|
||||
|
||||
|
||||
### keyStoreType
|
||||
### `keyStoreType`
|
||||
{#signPlugin-keyStoreType}
|
||||
|
||||
KeyStore type.
|
||||
@ -1067,7 +1067,7 @@ Default value
|
||||
: [`intellijPlatform.signing.keyStoreType`](tools_intellij_platform_gradle_plugin_extension.md#intellijPlatform-signing-keyStoreType)
|
||||
|
||||
|
||||
### keyStoreProviderName
|
||||
### `keyStoreProviderName`
|
||||
{#signPlugin-keyStoreProviderName}
|
||||
|
||||
JCA KeyStore Provider name.
|
||||
@ -1081,7 +1081,7 @@ Default value
|
||||
: [`intellijPlatform.signing.keyStoreProviderName`](tools_intellij_platform_gradle_plugin_extension.md#intellijPlatform-signing-keyStoreProviderName)
|
||||
|
||||
|
||||
### privateKey
|
||||
### `privateKey`
|
||||
{#signPlugin-privateKey}
|
||||
|
||||
Encoded private key in the PEM format.
|
||||
@ -1095,7 +1095,7 @@ Default value
|
||||
: [`intellijPlatform.signing.privateKey`](tools_intellij_platform_gradle_plugin_extension.md#intellijPlatform-signing-privateKey)
|
||||
|
||||
|
||||
### privateKeyFile
|
||||
### `privateKeyFile`
|
||||
{#signPlugin-privateKeyFile}
|
||||
|
||||
A file with an encoded private key in the PEM format.
|
||||
@ -1109,7 +1109,7 @@ Default value
|
||||
: [`intellijPlatform.signing.privateKeyFile`](tools_intellij_platform_gradle_plugin_extension.md#intellijPlatform-signing-privateKeyFile)
|
||||
|
||||
|
||||
### password
|
||||
### `password`
|
||||
{#signPlugin-password}
|
||||
|
||||
Password required to decrypt the private key.
|
||||
@ -1123,7 +1123,7 @@ Default value
|
||||
: [`intellijPlatform.signing.password`](tools_intellij_platform_gradle_plugin_extension.md#intellijPlatform-signing-password)
|
||||
|
||||
|
||||
### certificateChain
|
||||
### `certificateChain`
|
||||
{#signPlugin-certificateChain}
|
||||
|
||||
A string containing X509 certificates.
|
||||
@ -1138,7 +1138,7 @@ Default value
|
||||
: [`intellijPlatform.signing.certificateChain`](tools_intellij_platform_gradle_plugin_extension.md#intellijPlatform-signing-certificateChain)
|
||||
|
||||
|
||||
### certificateChainFile
|
||||
### `certificateChainFile`
|
||||
{#signPlugin-certificateChainFile}
|
||||
|
||||
Path to the file containing X509 certificates.
|
||||
@ -1153,7 +1153,7 @@ Default value
|
||||
: [`intellijPlatform.signing.certificateChainFile`](tools_intellij_platform_gradle_plugin_extension.md#intellijPlatform-signing-certificateChainFile)
|
||||
|
||||
|
||||
## testIde
|
||||
## `testIde`
|
||||
{#testIde}
|
||||
|
||||
|
||||
@ -1189,7 +1189,7 @@ tasks {
|
||||
```
|
||||
|
||||
|
||||
## testIdePerformance
|
||||
## `testIdePerformance`
|
||||
{#testIdePerformance}
|
||||
|
||||
> Not implemented.
|
||||
@ -1197,7 +1197,7 @@ tasks {
|
||||
{style="warning"}
|
||||
|
||||
|
||||
## testIdeUi
|
||||
## `testIdeUi`
|
||||
{#testIdeUi}
|
||||
|
||||
> Not implemented.
|
||||
@ -1205,7 +1205,7 @@ tasks {
|
||||
{style="warning"}
|
||||
|
||||
|
||||
## verifyPluginProjectConfiguration
|
||||
## `verifyPluginProjectConfiguration`
|
||||
{#verifyPluginProjectConfiguration}
|
||||
|
||||
<tldr>
|
||||
@ -1236,7 +1236,7 @@ See also:
|
||||
- [](using_kotlin.md#incremental-compilation)
|
||||
|
||||
|
||||
### reportDirectory
|
||||
### `reportDirectory`
|
||||
{#verifyPluginProjectConfiguration-reportDirectory}
|
||||
|
||||
Report directory where the verification result will be stored.
|
||||
@ -1249,7 +1249,7 @@ Default value
|
||||
: <path>[buildDirectory]/reports/verifyPluginConfiguration</path>
|
||||
|
||||
|
||||
### rootProject
|
||||
### `rootProject`
|
||||
{#verifyPluginProjectConfiguration-rootProject}
|
||||
|
||||
Root project path.
|
||||
@ -1262,7 +1262,7 @@ Default value
|
||||
: <path>[rootProject]</path>
|
||||
|
||||
|
||||
### sourceCompatibility
|
||||
### `sourceCompatibility`
|
||||
{#verifyPluginProjectConfiguration-sourceCompatibility}
|
||||
|
||||
The `JavaCompile.sourceCompatibility` property value defined in the build script.
|
||||
@ -1275,7 +1275,7 @@ Default value
|
||||
: `JavaCompile.sourceCompatibility`
|
||||
|
||||
|
||||
### targetCompatibility
|
||||
### `targetCompatibility`
|
||||
{#verifyPluginProjectConfiguration-targetCompatibility}
|
||||
|
||||
The `JavaCompile.targetCompatibility` property value defined in the build script.
|
||||
@ -1288,7 +1288,7 @@ Default value
|
||||
: `JavaCompile.targetCompatibility`
|
||||
|
||||
|
||||
### kotlinPluginAvailable
|
||||
### `kotlinPluginAvailable`
|
||||
{#verifyPluginProjectConfiguration-kotlinPluginAvailable}
|
||||
|
||||
Indicates that the Kotlin Gradle Plugin is loaded and available.
|
||||
@ -1301,7 +1301,7 @@ Default value
|
||||
: Kotlin Gradle Plugin presence
|
||||
|
||||
|
||||
### kotlinApiVersion
|
||||
### `kotlinApiVersion`
|
||||
{#verifyPluginProjectConfiguration-kotlinApiVersion}
|
||||
|
||||
The `apiVersion` property value of `compileKotlin.kotlinOptions` defined in the build script.
|
||||
@ -1314,7 +1314,7 @@ Default value
|
||||
: `compileKotlin.kotlinOptions.apiVersion`
|
||||
|
||||
|
||||
### kotlinLanguageVersion
|
||||
### `kotlinLanguageVersion`
|
||||
{#verifyPluginProjectConfiguration-kotlinLanguageVersion}
|
||||
|
||||
The `languageVersion` property value of `compileKotlin.kotlinOptions` defined in the build script.
|
||||
@ -1327,7 +1327,7 @@ Default value
|
||||
: `compileKotlin.kotlinOptions.languageVersion`
|
||||
|
||||
|
||||
### kotlinVersion
|
||||
### `kotlinVersion`
|
||||
{#verifyPluginProjectConfiguration-kotlinVersion}
|
||||
|
||||
The version of the Kotlin used in the project.
|
||||
@ -1340,7 +1340,7 @@ Default value
|
||||
: `kotlin.coreLibrariesVersion`
|
||||
|
||||
|
||||
### kotlinJvmTarget
|
||||
### `kotlinJvmTarget`
|
||||
{#verifyPluginProjectConfiguration-kotlinJvmTarget}
|
||||
|
||||
The `jvmTarget` property value of `compileKotlin.kotlinOptions` defined in the build script.
|
||||
@ -1353,7 +1353,7 @@ Default value
|
||||
: `compileKotlin.kotlinOptions.jvmTarget`
|
||||
|
||||
|
||||
### kotlinStdlibDefaultDependency
|
||||
### `kotlinStdlibDefaultDependency`
|
||||
{#verifyPluginProjectConfiguration-kotlinStdlibDefaultDependency}
|
||||
|
||||
`kotlin.stdlib.default.dependency` property value defined in the `gradle.properties` file.
|
||||
@ -1366,7 +1366,7 @@ Default value
|
||||
: `kotlin.stdlib.default.dependency` Gradle property
|
||||
|
||||
|
||||
### kotlinIncrementalUseClasspathSnapshot
|
||||
### `kotlinIncrementalUseClasspathSnapshot`
|
||||
{#verifyPluginProjectConfiguration-kotlinIncrementalUseClasspathSnapshot}
|
||||
|
||||
`kotlin.incremental.useClasspathSnapshot` property value defined in the `gradle.properties` file.
|
||||
@ -1379,7 +1379,7 @@ Default value
|
||||
: `kotlin.incremental.useClasspathSnapshot` Gradle property
|
||||
|
||||
|
||||
### kotlinxCoroutinesLibraryPresent
|
||||
### `kotlinxCoroutinesLibraryPresent`
|
||||
{#verifyPluginProjectConfiguration-kotlinxCoroutinesLibraryPresent}
|
||||
|
||||
This variable represents whether the Kotlin Coroutines library is added explicitly to the project dependencies.
|
||||
@ -1392,7 +1392,7 @@ Default value
|
||||
: The `org.jetbrains.kotlinx:kotlinx-coroutines` dependency presence
|
||||
|
||||
|
||||
## verifyPluginSignature
|
||||
## `verifyPluginSignature`
|
||||
{#verifyPluginSignature}
|
||||
|
||||
<tldr>
|
||||
@ -1412,7 +1412,7 @@ See also:
|
||||
- [Marketplace ZIP Signer](https://github.com/JetBrains/marketplace-zip-signer)
|
||||
|
||||
|
||||
### inputArchiveFile
|
||||
### `inputArchiveFile`
|
||||
{#verifyPluginSignature-inputArchiveFile}
|
||||
|
||||
Input, unsigned ZIP archive file.
|
||||
@ -1426,7 +1426,7 @@ Default value
|
||||
: [`signPlugin.signedArchiveFile`](#signPlugin-signedArchiveFile)
|
||||
|
||||
|
||||
### certificateChain
|
||||
### `certificateChain`
|
||||
{#verifyPluginSignature-certificateChain}
|
||||
|
||||
A string containing X509 certificates.
|
||||
@ -1440,7 +1440,7 @@ Type
|
||||
: `Property<String>`
|
||||
|
||||
|
||||
### certificateChainFile
|
||||
### `certificateChainFile`
|
||||
{#verifyPluginSignature-certificateChainFile}
|
||||
|
||||
Path to the file containing X509 certificates.
|
||||
@ -1455,7 +1455,7 @@ Default value
|
||||
: [`signPlugin.certificateChainFile`](#signPlugin-certificateChainFile) or [`signPlugin.certificateChain`](#signPlugin-certificateChain) written to a temporary file
|
||||
|
||||
|
||||
## verifyPluginStructure
|
||||
## `verifyPluginStructure`
|
||||
{#verifyPluginStructure}
|
||||
|
||||
<tldr>
|
||||
@ -1472,7 +1472,7 @@ See also:
|
||||
- [](plugin_configuration_file.md)
|
||||
|
||||
|
||||
### ignoreFailures
|
||||
### `ignoreFailures`
|
||||
{#verifyPluginStructure-ignoreFailures}
|
||||
|
||||
Specifies whether the build should fail when the verifications performed by this task fail.
|
||||
@ -1485,7 +1485,7 @@ Default value
|
||||
: `false`
|
||||
|
||||
|
||||
### ignoreUnacceptableWarnings
|
||||
### `ignoreUnacceptableWarnings`
|
||||
{#verifyPluginStructure-ignoreUnacceptableWarnings}
|
||||
|
||||
Specifies whether the build should fail when the verifications performed by this task emit unacceptable warnings.
|
||||
@ -1498,7 +1498,7 @@ Default value
|
||||
: `false`
|
||||
|
||||
|
||||
### ignoreWarnings
|
||||
### `ignoreWarnings`
|
||||
{#verifyPluginStructure-ignoreWarnings}
|
||||
|
||||
Specifies whether the build should fail when the verifications performed by this task emit warnings.
|
||||
@ -1511,7 +1511,7 @@ Default value
|
||||
: `true`
|
||||
|
||||
|
||||
### pluginDirectory
|
||||
### `pluginDirectory`
|
||||
{#verifyPluginStructure-pluginDirectory}
|
||||
|
||||
The location of the built plugin file which will be used for verification.
|
||||
@ -1524,7 +1524,7 @@ Default value
|
||||
: <path>[`prepareSandbox.defaultDestinationDirectory`](#prepareSandbox-defaultDestinationDirectory)/[`intellijPlatform.pluginConfiguration.name`](tools_intellij_platform_gradle_plugin_extension.md#intellijPlatform-pluginConfiguration-name)</path>
|
||||
|
||||
|
||||
## verifyPlugin
|
||||
## `verifyPlugin`
|
||||
{#verifyPlugin}
|
||||
|
||||
<tldr>
|
||||
@ -1548,7 +1548,7 @@ See also:
|
||||
- [IntelliJ Plugin Verifier](https://github.com/JetBrains/intellij-plugin-verifier)
|
||||
|
||||
|
||||
### ides
|
||||
### `ides`
|
||||
{#verifyPlugin-ides}
|
||||
|
||||
Holds a reference to IntelliJ Platform IDEs which will be used by the IntelliJ Plugin Verifier CLI tool for the binary plugin verification.
|
||||
@ -1560,7 +1560,7 @@ Type
|
||||
: `ConfigurableFileCollection`
|
||||
|
||||
|
||||
### archiveFile
|
||||
### `archiveFile`
|
||||
{#verifyPlugin-archiveFile}
|
||||
|
||||
Input ZIP archive file of the plugin to verify.
|
||||
@ -1574,7 +1574,7 @@ Default value
|
||||
: [`buildPlugin.archiveFile`](#buildPlugin-archiveFile)
|
||||
|
||||
|
||||
### externalPrefixes
|
||||
### `externalPrefixes`
|
||||
{#verifyPlugin-externalPrefixes}
|
||||
|
||||
The list of class prefixes from the external libraries.
|
||||
@ -1588,7 +1588,7 @@ Default value
|
||||
: [`intellijPlatform.verifyPlugin.externalPrefixes`](tools_intellij_platform_gradle_plugin_extension.md#intellijPlatform-verifyPlugin-externalPrefixes)
|
||||
|
||||
|
||||
### failureLevel
|
||||
### `failureLevel`
|
||||
{#verifyPlugin-failureLevel}
|
||||
|
||||
Defines the verification level at which the task should fail if any reported issue matches.
|
||||
@ -1601,7 +1601,7 @@ Default value
|
||||
: [`intellijPlatform.verifyPlugin.failureLevel`](tools_intellij_platform_gradle_plugin_extension.md#intellijPlatform-verifyPlugin-failureLevel)
|
||||
|
||||
|
||||
### freeArgs
|
||||
### `freeArgs`
|
||||
{#verifyPlugin-freeArgs}
|
||||
|
||||
The list of free arguments is passed directly to the IntelliJ Plugin Verifier CLI tool.
|
||||
@ -1616,7 +1616,7 @@ Default value
|
||||
: [`intellijPlatform.verifyPlugin.freeArgs`](tools_intellij_platform_gradle_plugin_extension.md#intellijPlatform-verifyPlugin-freeArgs)
|
||||
|
||||
|
||||
### ignoredProblemsFile
|
||||
### `ignoredProblemsFile`
|
||||
{#verifyPlugin-ignoredProblemsFile}
|
||||
|
||||
A file that contains a list of problems that will be ignored in a report.
|
||||
@ -1629,7 +1629,7 @@ Default value
|
||||
: [`intellijPlatform.verifyPlugin.ignoredProblemsFile`](tools_intellij_platform_gradle_plugin_extension.md#intellijPlatform-verifyPlugin-ignoredProblemsFile)
|
||||
|
||||
|
||||
### offline
|
||||
### `offline`
|
||||
{#verifyPlugin-offline}
|
||||
|
||||
Determines if the operation is running in offline mode.
|
||||
@ -1648,7 +1648,7 @@ See also:
|
||||
- [Command Line Execution Options](https://docs.gradle.org/current/userguide/command_line_interface.html#sec:command_line_execution_options)
|
||||
|
||||
|
||||
### subsystemsToCheck
|
||||
### `subsystemsToCheck`
|
||||
{#verifyPlugin-subsystemsToCheck}
|
||||
|
||||
Specifies which subsystems of IDE should be checked.
|
||||
@ -1661,7 +1661,7 @@ Default value
|
||||
: [`intellijPlatform.verifyPlugin.subsystemsToCheck`](tools_intellij_platform_gradle_plugin_extension.md#intellijPlatform-verifyPlugin-subsystemsToCheck)
|
||||
|
||||
|
||||
### teamCityOutputFormat
|
||||
### `teamCityOutputFormat`
|
||||
{#verifyPlugin-teamCityOutputFormat}
|
||||
|
||||
A flag that controls the output format.
|
||||
@ -1675,7 +1675,7 @@ Default value
|
||||
: [`intellijPlatform.verifyPlugin.teamCityOutputFormat`](tools_intellij_platform_gradle_plugin_extension.md#intellijPlatform-verifyPlugin-teamCityOutputFormat)
|
||||
|
||||
|
||||
### verificationReportsDirectory
|
||||
### `verificationReportsDirectory`
|
||||
{#verifyPlugin-verificationReportsDirectory}
|
||||
|
||||
The path to the directory where verification reports will be saved.
|
||||
@ -1688,7 +1688,7 @@ Default value
|
||||
: [`intellijPlatform.verifyPlugin.verificationReportsDirectory`](tools_intellij_platform_gradle_plugin_extension.md#intellijPlatform-verifyPlugin-verificationReportsDirectory)
|
||||
|
||||
|
||||
### verificationReportsFormats
|
||||
### `verificationReportsFormats`
|
||||
{#verifyPlugin-verificationReportsFormats}
|
||||
|
||||
The output formats of the verification reports.
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
This page lists various types used to configure [](tools_intellij_platform_gradle_plugin_tasks.md).
|
||||
|
||||
## FailureLevel
|
||||
## `FailureLevel`
|
||||
{#FailureLevel}
|
||||
|
||||
[`VerifyPluginTask.FailureLevel`](%gh-ijpgp%/src/main/kotlin/org/jetbrains/intellij/platform/gradle/tasks/VerifyPluginTask.kt)
|
||||
@ -37,7 +37,7 @@ See also:
|
||||
- [Tasks: `verifyPlugin.failureLevel`](tools_intellij_platform_gradle_plugin_tasks.md#verifyPlugin-failureLevel)
|
||||
|
||||
|
||||
## IntelliJPlatformType
|
||||
## `IntelliJPlatformType`
|
||||
{#IntelliJPlatformType}
|
||||
|
||||
[`IntelliJPlatformType`](%gh-ijpgp%/src/main/kotlin/org/jetbrains/intellij/platform/gradle/IntelliJPlatformType.kt)
|
||||
@ -64,7 +64,7 @@ Each entry is composed of a product code and coordinates used for dependency and
|
||||
| `Writerside` | `WRS` | `com.jetbrains.intellij.idea:writerside` |
|
||||
|
||||
|
||||
## PluginBean
|
||||
## `PluginBean`
|
||||
{#PluginBean}
|
||||
|
||||
[`PluginBean`](%gh-pv%/intellij-plugin-structure/structure-intellij/src/main/java/com/jetbrains/plugin/structure/intellij/beans/PluginBean.java)
|
||||
@ -74,7 +74,7 @@ Describes the content of the <path>plugin.xml</path> file.
|
||||
See also:
|
||||
- [](plugin_configuration_file.md)
|
||||
|
||||
## ProductInfo
|
||||
## `ProductInfo`
|
||||
{#ProductInfo}
|
||||
|
||||
[`ProductInfo`](%gh-ijpgp%/src/main/kotlin/org/jetbrains/intellij/platform/gradle/models/ProductInfo.kt)
|
||||
@ -99,7 +99,7 @@ The information is retrieved from the <path>product-info.json</path> file in the
|
||||
| fileExtensions | The list of file extensions associated with the product. |
|
||||
| modules | The list of modules of the product. |
|
||||
|
||||
### validateSupportedVersion()
|
||||
### `validateSupportedVersion()`
|
||||
{#ProductInfo-validateSupportedVersion}
|
||||
|
||||
Validates that the resolved IntelliJ Platform is supported by checking against the minimal supported IntelliJ Platform version.
|
||||
@ -111,7 +111,7 @@ Throws
|
||||
: `IllegalArgumentException`
|
||||
|
||||
|
||||
## ProductRelease.Channel
|
||||
## `ProductRelease.Channel`
|
||||
{#ProductRelease-Channel}
|
||||
|
||||
[`ProductRelease.Channel`](%gh-ijpgp%/src/main/kotlin/org/jetbrains/intellij/platform/gradle/models/ProductRelease.kt)
|
||||
@ -134,7 +134,7 @@ See also:
|
||||
- [Tasks: `printProductsReleases`](tools_intellij_platform_gradle_plugin_tasks.md#printProductsReleases)
|
||||
|
||||
|
||||
## ProductReleasesValueSource.FilterParameters
|
||||
## `ProductReleasesValueSource.FilterParameters`
|
||||
{#ProductReleasesValueSource-FilterParameters}
|
||||
|
||||
[`ProductReleasesValueSource.FilterParameters`](%gh-ijpgp%/src/main/kotlin/org/jetbrains/intellij/platform/gradle/providers/ProductReleasesValueSource.kt)
|
||||
@ -153,7 +153,7 @@ See also:
|
||||
- [Tasks: `printProductsReleases`](tools_intellij_platform_gradle_plugin_tasks.md#printProductsReleases)
|
||||
|
||||
|
||||
## Subsystems
|
||||
## `Subsystems`
|
||||
{#Subsystems}
|
||||
|
||||
[`VerifyPluginTask.Subsystems`](%gh-ijpgp%/src/main/kotlin/org/jetbrains/intellij/platform/gradle/tasks/VerifyPluginTask.kt)
|
||||
@ -171,7 +171,7 @@ See also:
|
||||
- [Tasks: `verifyPlugin.subsystemsToCheck`](tools_intellij_platform_gradle_plugin_tasks.md#verifyPlugin-subsystemsToCheck)
|
||||
|
||||
|
||||
## TestFrameworkType
|
||||
## `TestFrameworkType`
|
||||
{#TestFrameworkType}
|
||||
|
||||
Allows for adding `test-framework` testing library variants. See [Dependencies Extension: Testing](tools_intellij_platform_gradle_plugin_dependencies_extension.md#testing).
|
||||
@ -187,7 +187,7 @@ Allows for adding `test-framework` testing library variants. See [Dependencies E
|
||||
| `Maven` | `com.jetbrains.intellij.maven:maven-test-framework` |
|
||||
| `ReSharper` | `com.jetbrains.intellij.resharper:resharper-test-framework` |
|
||||
|
||||
## VerificationReportsFormats
|
||||
## `VerificationReportsFormats`
|
||||
{#VerificationReportsFormats}
|
||||
|
||||
[`VerifyPluginTask.VerificationReportsFormats`](%gh-ijpgp%/src/main/kotlin/org/jetbrains/intellij/platform/gradle/tasks/VerifyPluginTask.kt)
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user