From faef8dd7bab15fc4c1dc8088c1b4d63eaa963546 Mon Sep 17 00:00:00 2001 From: Karol Lewandowski Date: Fri, 3 Jan 2025 11:53:24 +0100 Subject: [PATCH] Replace the deprecated deflist style attribute with type --- .../generate_descriptor_pages.main.kts | 6 +- .../tools_gradle_intellij_plugin.md | 230 +++++++++--------- ...s_gradle_intellij_plugin_build_features.md | 6 +- ...tellij_platform_gradle_plugin_extension.md | 104 ++++---- ...latform_gradle_plugin_gradle_properties.md | 20 +- ...llij_platform_gradle_plugin_task_awares.md | 58 ++--- ...s_intellij_platform_gradle_plugin_tasks.md | 210 ++++++++-------- ...s_intellij_platform_gradle_plugin_types.md | 2 +- .../tools/tools_gradle_grammar_kit_plugin.md | 24 +- .../plugin_configuration_file.md | 98 ++++---- .../live_templates_configuration_file.md | 10 +- 11 files changed, 384 insertions(+), 384 deletions(-) diff --git a/.github/scripts/generate_descriptor_pages.main.kts b/.github/scripts/generate_descriptor_pages.main.kts index 002363687..3442ed806 100755 --- a/.github/scripts/generate_descriptor_pages.main.kts +++ b/.github/scripts/generate_descriptor_pages.main.kts @@ -209,7 +209,7 @@ fun StringBuilder.appendReferences(references: List) { fun StringBuilder.appendDeprecationVersion(deprecatedSince: String?) { deprecatedSince ?: return - appendLine("{style=\"narrow\"}") + appendLine("{type=\"narrow\"}") appendLine("Deprecated") appendLine(":") appendLine("since $deprecatedSince\n") @@ -217,7 +217,7 @@ fun StringBuilder.appendDeprecationVersion(deprecatedSince: String?) { fun StringBuilder.appendSupportDetails(supportDetails: String?) { supportDetails ?: return - appendLine("{style=\"narrow\"}") + appendLine("{type=\"narrow\"}") appendLine("Supported") appendLine(":") appendLine(supportDetails) @@ -225,7 +225,7 @@ fun StringBuilder.appendSupportDetails(supportDetails: String?) { fun StringBuilder.appendRequirement(requirement: Requirement?) { if (requirement == null) return - appendLine("{style=\"narrow\"}") + appendLine("{type=\"narrow\"}") appendLine("Required") append(": ") val requiredText = when (requirement.required) { diff --git a/topics/appendix/tools/gradle_intellij_plugin/tools_gradle_intellij_plugin.md b/topics/appendix/tools/gradle_intellij_plugin/tools_gradle_intellij_plugin.md index 900102dcc..d1a6fa74f 100644 --- a/topics/appendix/tools/gradle_intellij_plugin/tools_gradle_intellij_plugin.md +++ b/topics/appendix/tools/gradle_intellij_plugin/tools_gradle_intellij_plugin.md @@ -287,7 +287,7 @@ All available JetBrains IDEs versions can be found in the repositories described The version of the IntelliJ Platform IDE that will be used to build the plugin. Please see [](plugin_compatibility.md) and [](build_number_ranges.md) for more details. -{style="narrow"} +{type="narrow"} Required : `true` @@ -310,7 +310,7 @@ Acceptable values The type of the IntelliJ-based IDE distribution. The type may also be specified as a prefix of the value for the [`intellij.version`](#intellij-extension-version) property instead. -{style="narrow"} +{type="narrow"} Type : `String` @@ -339,7 +339,7 @@ To build against IDEs not supported directly by `type`, please see their corresp The plugin name part used in the generated ZIP distribution: build/distributions/PluginName-1.0.0.zip, and the name of the plugin directory in the sandbox directory. -{style="narrow"} +{type="narrow"} Type : `String` @@ -353,7 +353,7 @@ Default value The path to the locally installed IDE distribution that should be used to build the plugin. Using `intellij.localPath` allows building the plugin using an IDE that is not available in [](intellij_artifacts.md). -{style="narrow"} +{type="narrow"} Type : `String` @@ -377,7 +377,7 @@ Samples The path to local archive with IDE sources. Used for resolving source files of the locally installed IDE distribution when [`intellij.localPath`](#intellij-extension-localpath) is specified. -{style="narrow"} +{type="narrow"} Type : `String` @@ -401,7 +401,7 @@ Notes: See [](tools_gradle_intellij_plugin_faq.md#how-to-add-a-dependency-on-a-plugin-available-in-the-file-system). - If you need to refer plugin's classes from your project, you also have to define a dependency in your [plugin.xml](plugin_configuration_file.md) file, see [](plugin_dependencies.md). -{style="narrow"} +{type="narrow"} Type : `List` @@ -428,7 +428,7 @@ Acceptable values Enables patching [plugin.xml](plugin_configuration_file.md) with the values of [`patchPluginXml.sinceBuild`](#tasks-patchpluginxml-sincebuild) and [`patchPluginXml.untilBuild`](#tasks-patchpluginxml-untilbuild) properties. -{style="narrow"} +{type="narrow"} Type : `Boolean` @@ -445,7 +445,7 @@ Notes: - Useful for building plugins against EAP builds. - If [`patchPluginXml.untilBuild`](#tasks-patchpluginxml-untilbuild) has a value set, then [`intellij.sameSinceUntilBuild`](#intellij-extension-samesinceuntilbuild) is ignored. -{style="narrow"} +{type="narrow"} Type : `Boolean` @@ -458,7 +458,7 @@ Default value Enables the instrumentation of Java classes with [nullability](https://www.jetbrains.com/help/idea/nullable-and-notnull-annotations.html) assertions and compilation of forms created by [IntelliJ GUI Designer](https://www.jetbrains.com/help/idea/gui-designer-basics.html). -{style="narrow"} +{type="narrow"} Type : `Boolean` @@ -471,7 +471,7 @@ Default value The path of [sandbox directory](ide_development_instance.md#the-development-instance-sandbox-directory) that is used for running IDE with developed plugin. -{style="narrow"} +{type="narrow"} Type : `String` @@ -484,7 +484,7 @@ Default value The IntelliJ-based IDE distributions repository URL. -{style="narrow"} +{type="narrow"} Type : `String` @@ -498,7 +498,7 @@ Default value Configures repositories for downloading plugin dependencies. See [Maven Interface](https://plugins.jetbrains.com/docs/marketplace/maven-interface.html) for details on Maven repository format. -{style="narrow"} +{type="narrow"} Type : `PluginsRepositoryConfiguration` @@ -518,7 +518,7 @@ Acceptable values URL of repository for downloading [JetBrains Runtime](ide_development_instance.md#using-a-jetbrains-runtime-for-the-development-instance). -{style="narrow"} +{type="narrow"} Type : `String` @@ -532,7 +532,7 @@ Default value Path to the directory where the IDE dependency cache is stored. If not set, the dependency will be extracted next to the downloaded ZIP archive in [Gradle cache](https://docs.gradle.org/current/userguide/directory_layout.html#dir:gradle_user_home) directory. -{style="narrow"} +{type="narrow"} Type : `String` @@ -546,7 +546,7 @@ Default value Enables downloading the IntelliJ Platform sources. It is enabled by default if the `CI` environment variable is not set – which is present in Continuous Integration environments, like GitHub Actions, TeamCity, and others. -{style="narrow"} +{type="narrow"} Type : `Boolean` @@ -560,7 +560,7 @@ Default value Enables configuration of the default IntelliJ Platform dependencies in the current project. Otherwise, the `DependenciesUtils.intellij()`, `DependenciesUtils.intellijPlugin()`, and `DependenciesUtils.intellijPlugins()` functions could be used for an explicit configuration. -{style="narrow"} +{type="narrow"} Type : `Boolean` @@ -574,7 +574,7 @@ Default value Configure extra dependency artifacts from the IntelliJ repository. The dependencies on them could be configured only explicitly using the `DependenciesUtils.intellijExtra()` function in the `dependencies` block. -{style="narrow"} +{type="narrow"} Type : `List` @@ -587,7 +587,7 @@ Default value List of dependencies on external plugins. -{style="narrow"} +{type="narrow"} Type : `List` @@ -614,7 +614,7 @@ The base name of the ZIP archive. This task is preconfigured automatically and takes the output artifacts of [`prepareSandbox`](#tasks-preparesandbox) and [`jarSearchableOptions`](#tasks-jarsearchableoptions) tasks as an input. -{style="narrow"} +{type="narrow"} Type : `String` @@ -638,7 +638,7 @@ Note, this is a [`runIde`](#tasks-runide)-based task with predefined arguments a #### `outputDir` {#tasks-buildsearchableoptions-outputdir} -{style="narrow"} +{type="narrow"} Type : `File` @@ -659,7 +659,7 @@ Task is enabled if [`intellij.version`](#intellij-extension-version) is set to ` The list of `classpath.index` files to be removed. -{style="narrow"} +{type="narrow"} Type : `ConfigurableFileCollection` @@ -679,7 +679,7 @@ The `robot-server` plugin is required for running the UI tests using the [`runId The version of the Robot Server Plugin to download. -{style="narrow"} +{type="narrow"} Type : `String` @@ -692,7 +692,7 @@ Default value The Robot Server Plugin archive, downloaded by default to the [Gradle cache](https://docs.gradle.org/current/userguide/directory_layout.html#dir:gradle_user_home). -{style="narrow"} +{type="narrow"} Type : `File` @@ -705,7 +705,7 @@ Default value Location of the extracted archive. -{style="narrow"} +{type="narrow"} Type : `File` @@ -724,7 +724,7 @@ Resolves and downloads Marketplace ZIP Signer CLI tool used by the [`signPlugin` Version of the ZIP Signer CLI tool to download. -{style="narrow"} +{type="narrow"} Type : `String` @@ -737,7 +737,7 @@ Default value Path to the ZIP Signer CLI tool. -{style="narrow"} +{type="narrow"} Type : `File` @@ -750,7 +750,7 @@ Default value The output of the ZIP Signer CLI tool. -{style="narrow"} +{type="narrow"} Type : `File` @@ -775,7 +775,7 @@ The following attributes help you to tune instrumenting behavior in the `instrum The dependency on IntelliJ IDEA. -{style="narrow"} +{type="narrow"} Type : `IdeaDependency` @@ -788,7 +788,7 @@ Default value Path to the javac2.jar file of IntelliJ IDEA. -{style="narrow"} +{type="narrow"} Type : `File` @@ -802,7 +802,7 @@ Default value A version of instrumenting compiler. It's used in cases when targeting non-IntelliJ IDEA IDEs (e.g., [CLion](clion.md) or [Rider](rider.md)). -{style="narrow"} +{type="narrow"} Type : `String` @@ -815,7 +815,7 @@ Default value The list of directories with compiled classes. -{style="narrow"} +{type="narrow"} Type : `FileCollection` @@ -828,7 +828,7 @@ Default value The list of directories with GUI Designer form files. -{style="narrow"} +{type="narrow"} Type : `FileCollection` @@ -841,7 +841,7 @@ Default value The output directory for instrumented classes. -{style="narrow"} +{type="narrow"} Type : `File` @@ -854,7 +854,7 @@ Default value The classpath for Java instrumentation compiler. -{style="narrow"} +{type="narrow"} Type : `FileCollection` @@ -876,7 +876,7 @@ Create a JAR file with searchable options to be distributed with the plugin. The output directory where the JAR file will be created. -{style="narrow"} +{type="narrow"} Type : `String` @@ -889,7 +889,7 @@ Default value The name of the plugin. -{style="narrow"} +{type="narrow"} Type : `String` @@ -902,7 +902,7 @@ Default value The sandbox output directory. -{style="narrow"} +{type="narrow"} Type : `String` @@ -925,7 +925,7 @@ See also [](#tasks-printBundledPlugins). The IDE dependency sources path. Configured automatically with the [`setupDependencies.idea`](#tasks-setupdependencies-idea) dependency. -{style="narrow"} +{type="narrow"} Type : `File` @@ -938,7 +938,7 @@ Default value Path to the file, where the output list will be stored. -{style="narrow"} +{type="narrow"} Type : `File` @@ -968,7 +968,7 @@ See also [](#tasks-printproductsreleases). Path to the products releases update files. By default, one is downloaded from `IntelliJPluginConstants.IDEA_PRODUCTS_RELEASES_URL`. -{style="narrow"} +{type="narrow"} Type : `FileCollection` @@ -981,7 +981,7 @@ Default value List of types of IDEs that will be listed in results. -{style="narrow"} +{type="narrow"} Type : `List` @@ -995,7 +995,7 @@ Default value Lower boundary of the listed results in product marketing version format, e.g., `2020.2.1`. It takes precedence over the [`listProductsReleases.sinceBuild`](#tasks-listproductsreleases-sincebuild) property. -{style="narrow"} +{type="narrow"} Type : `String` @@ -1009,7 +1009,7 @@ Default value Upper boundary of the listed results in product marketing version format, e.g., `2020.2.1`. It takes precedence over the [`listProductsReleases.untilBuild`](#tasks-listproductsreleases-untilbuild) property. -{style="narrow"} +{type="narrow"} Type : `String` @@ -1022,7 +1022,7 @@ Default value Lower boundary of the listed results in build number format, like `192`. -{style="narrow"} +{type="narrow"} Type : `String` @@ -1035,7 +1035,7 @@ Default value Upper boundary of the listed results in build number format, like `192`. -{style="narrow"} +{type="narrow"} Type : `String` @@ -1048,7 +1048,7 @@ Default value Release channels that product updates will be filtered with. -{style="narrow"} +{type="narrow"} Type : `Channel` @@ -1061,7 +1061,7 @@ Default value Path to the file, where the output list will be stored. -{style="narrow"} +{type="narrow"} Type : `File` @@ -1074,7 +1074,7 @@ Default value For [Android Studio releases](android_studio_releases_list.md), a separated storage for the updates is used. -{style="narrow"} +{type="narrow"} Type : `String` @@ -1096,7 +1096,7 @@ Patches [plugin.xml](plugin_configuration_file.md) files with value The directory where the patched [plugin.xml](plugin_configuration_file.md) will be written. -{style="narrow"} +{type="narrow"} Type : `String` @@ -1109,7 +1109,7 @@ Default value The list of [plugin.xml](plugin_configuration_file.md) files to patch. -{style="narrow"} +{type="narrow"} Type : `List` @@ -1122,7 +1122,7 @@ Default value The description of the plugin used in the [``](plugin_configuration_file.md#idea-plugin__description) tag. -{style="narrow"} +{type="narrow"} Type : `String` @@ -1135,7 +1135,7 @@ Default value The lower bound of the [version range](build_number_ranges.md) to be patched used in the `since-build` attribute of the [``](plugin_configuration_file.md#idea-plugin__idea-version) tag. -{style="narrow"} +{type="narrow"} Type : `String` @@ -1148,7 +1148,7 @@ Default value The upper bound of the [version range](build_number_ranges.md) to be patched used in the `until-build` attribute of the [``](plugin_configuration_file.md#idea-plugin__idea-version) tag. -{style="narrow"} +{type="narrow"} Type : `String` @@ -1161,7 +1161,7 @@ Default value The version of the plugin used in the [``](plugin_configuration_file.md#idea-plugin__version) tag. -{style="narrow"} +{type="narrow"} Type : `String` @@ -1174,7 +1174,7 @@ Default value The change notes of the plugin used in the [``](plugin_configuration_file.md#idea-plugin__change-notes) tag. -{style="narrow"} +{type="narrow"} Type : `String` @@ -1187,7 +1187,7 @@ Default value The ID of the plugin used in the [``](plugin_configuration_file.md#idea-plugin__id) tag. -{style="narrow"} +{type="narrow"} Type : `String` @@ -1206,7 +1206,7 @@ Prepares the sandbox directory with the installed plugin and its dependencies. The name of the plugin. -{style="narrow"} +{type="narrow"} Type : `String` @@ -1219,7 +1219,7 @@ Default value The directory with the plugin configuration. -{style="narrow"} +{type="narrow"} Type : `String` @@ -1232,7 +1232,7 @@ Default value The input plugin JAR file used to prepare the sandbox. -{style="narrow"} +{type="narrow"} Type : `File` @@ -1246,7 +1246,7 @@ Default value Libraries that will be ignored when preparing the sandbox. By default, it excludes all libraries that are a part of the [`setupDependenciesTask.idea`](#tasks-setupdependencies-idea) dependency. -{style="narrow"} +{type="narrow"} Type : `List` @@ -1259,7 +1259,7 @@ Default value List of dependencies on external plugins. -{style="narrow"} +{type="narrow"} Type : `List` @@ -1327,7 +1327,7 @@ Authentication token. **Required** -{style="narrow"} +{type="narrow"} Type : `String` @@ -1340,7 +1340,7 @@ Default value List of channel names to upload plugin to. -{style="narrow"} +{type="narrow"} Type : `List` @@ -1353,7 +1353,7 @@ Default value Mark the release as hidden to prevent public release after approval. See [Hidden release](https://plugins.jetbrains.com/docs/marketplace/hidden-plugin.html) in JetBrains Marketplace docs. -{style="narrow"} +{type="narrow"} Type : `Boolean` @@ -1366,7 +1366,7 @@ Default value URL host of a plugin repository. -{style="narrow"} +{type="narrow"} Type : `String` @@ -1379,7 +1379,7 @@ Default value ZIP file of plugin to upload. -{style="narrow"} +{type="narrow"} Type : `File` @@ -1393,7 +1393,7 @@ Default value Specify if the Toolbox Enterprise plugin repository service should be used. This feature is still in the incubating phase and is not yet available for public use. -{style="narrow"} +{type="narrow"} Type : `Boolean` @@ -1414,7 +1414,7 @@ Run the IDE instance with the developed plugin installed. The IDE dependency sources path. Configured automatically with the [`setupDependencies.idea`](#tasks-setupdependencies-idea) dependency. -{style="narrow"} +{type="narrow"} Type : `File` @@ -1427,7 +1427,7 @@ Default value Custom JetBrains Runtime (JBR) version to use for running the IDE. -{style="narrow"} +{type="narrow"} Type : `String` @@ -1450,7 +1450,7 @@ Accepted values JetBrains Runtime (JBR) variant to use when running the IDE with the plugin. -{style="narrow"} +{type="narrow"} Type : `String` @@ -1464,7 +1464,7 @@ Default value JetBrains Runtime architecture. By default, it's resolved based on the current OS and JRE architecture. -{style="narrow"} +{type="narrow"} Type : `String` @@ -1478,7 +1478,7 @@ Default value Path to the `plugins` directory within the sandbox prepared with the [`prepareSandbox`](#tasks-preparesandbox) task. Provided to the `idea.plugins.path` system property. -{style="narrow"} +{type="narrow"} Type : `Directory` @@ -1496,7 +1496,7 @@ Enabled by default in 2020.2 and higher. See [Enabling Auto-Reload](ide_development_instance.md#enabling-auto-reload) for more details. -{style="narrow"} +{type="narrow"} Type : `Boolean` @@ -1529,7 +1529,7 @@ Currently, the task is under adaptation; more documentation will be added in the Path to directory with test projects and .ijperf files. -{style="narrow"} +{type="narrow"} Type : `String` @@ -1543,7 +1543,7 @@ Default value Path to the directory where performance test artifacts (IDE logs, snapshots, screenshots, etc.) will be stored. If the directory doesn't exist, it will be created. -{style="narrow"} +{type="narrow"} Type : `String` @@ -1556,7 +1556,7 @@ Default value Name of the profiler which will be used during execution. -{style="narrow"} +{type="narrow"} Type : `ProfilerName` @@ -1589,7 +1589,7 @@ Plugin Verifier DSL `runPluginVerifier { ... }` allows to define the list of IDE The IDEs to be checked in [`intellij.version`](#intellij-extension-version) format, i.e.: `["IC-2019.3.5", "PS-2019.3.2"]`. Check the available build versions on [IntelliJ Platform Builds list](https://jb.gg/intellij-platform-builds-list). -{style="narrow"} +{type="narrow"} Type : `List` @@ -1603,7 +1603,7 @@ Default value IntelliJ Plugin Verifier version. Do not change unless absolutely required. -{style="narrow"} +{type="narrow"} Type : `String` @@ -1617,7 +1617,7 @@ Default value Local path to the pre-downloaded IntelliJ Plugin Verifier JAR file. If set, [`runPluginVerifier.verifierVersion`](#tasks-runpluginverifier-verifierversion) is ignored. -{style="narrow"} +{type="narrow"} Type : `String` @@ -1630,7 +1630,7 @@ Default value A list of the paths to locally installed IDE distributions that should be used for verification in addition to those specified in [`runPluginVerifier.ideVersions`](#tasks-runpluginverifier-ideversions). -{style="narrow"} +{type="narrow"} Type : `List` @@ -1644,7 +1644,7 @@ Default value ZIP file of the plugin to verify. If empty, the task will be skipped. -{style="narrow"} +{type="narrow"} Type : `File` @@ -1658,7 +1658,7 @@ Default value Defines the verification level at which the task should fail if any reported issue matches. Can be set as `FailureLevel` enum or `EnumSet`. -{style="narrow"} +{type="narrow"} Type : `org.jetbrains.intellij.tasks.RunPluginVerifierTask.FailureLevel` @@ -1688,7 +1688,7 @@ Accepted values The path to the directory where verification reports will be saved. -{style="narrow"} +{type="narrow"} Type : `String` @@ -1700,7 +1700,7 @@ Default value The output formats of the verification reports that will be emitted. -{style="narrow"} +{type="narrow"} Type : `List` @@ -1719,7 +1719,7 @@ Acceptable values The path to the directory where IDEs used for the verification will be downloaded. By default, it relies on the `plugin.verifier.home.dir` system property and falls back to the `XDG_CACHE_HOME` environment variable – see [XDG Base Directory](https://wiki.archlinux.org/title/XDG_Base_Directory) for more details. -{style="narrow"} +{type="narrow"} Type : `String` @@ -1732,7 +1732,7 @@ Default value Custom JetBrains Runtime (JBR) version to use for running the verification. -{style="narrow"} +{type="narrow"} Type : `String` @@ -1755,7 +1755,7 @@ Acceptable values JetBrains Runtime (JBR) variant to use when running the verification. -{style="narrow"} +{type="narrow"} Type : `String` @@ -1769,7 +1769,7 @@ Default value JetBrains Runtime architecture. By default, it's resolved based on the current OS and JRE architecture. -{style="narrow"} +{type="narrow"} Type : `String` @@ -1782,7 +1782,7 @@ Default value The path to the directory containing the JVM runtime. Overrides [`runPluginVerifier.jbrVersion`](#tasks-runpluginverifier-jbrversion). -{style="narrow"} +{type="narrow"} Type : `String` @@ -1796,7 +1796,7 @@ Default value The list of class prefixes from the external libraries. The Plugin Verifier will not report `No such class` for classes of these packages. -{style="narrow"} +{type="narrow"} Type : `List` @@ -1809,7 +1809,7 @@ Default value A file that contains a list of problems that will be ignored in the verification report. It must contain lines in form `::`. -{style="narrow"} +{type="narrow"} Type : `File` @@ -1821,7 +1821,7 @@ Default value A flag that controls the output format - if set to `true`, the [TeamCity Tests Format](https://www.jetbrains.com/help/teamcity/service-messages.html) – the TeamCity compatible output will be returned to stdout. -{style="narrow"} +{type="narrow"} Type : `Boolean` @@ -1834,7 +1834,7 @@ Default value Specify which subsystems of the IDE should be checked. -{style="narrow"} +{type="narrow"} Type : `String` @@ -1854,7 +1854,7 @@ Arbitrary command line arguments that are passed to the IntelliJ Plugin Verifier Arguments that require a value must be provided in the separate elements of the list. -{style="narrow"} +{type="narrow"} Type : `List` @@ -1896,7 +1896,7 @@ Prepares code instrumentation tasks. A flag that controls whether code instrumentation is enabled. -{style="narrow"} +{type="narrow"} Type : `Boolean` @@ -1909,7 +1909,7 @@ Default value The path to the directory where instrumented classes will be saved. -{style="narrow"} +{type="narrow"} Type : `Directory` @@ -1940,7 +1940,7 @@ Refers to `cert` CLI option. > {style="note"} -{style="narrow"} +{type="narrow"} Type : `String` @@ -1955,7 +1955,7 @@ A file containing X509 certificates. The first certificate from the chain will be used as a certificate authority (CA). Refers to `cert-file` CLI option. -{style="narrow"} +{type="narrow"} Type : `File` @@ -1973,7 +1973,7 @@ Refers to `key` CLI option. > {style="note"} -{style="narrow"} +{type="narrow"} Type : `String` @@ -1987,7 +1987,7 @@ Default value A file with the encoded private key in PEM format. Refers to `key-file` CLI option. -{style="narrow"} +{type="narrow"} Type : `File` @@ -2001,7 +2001,7 @@ Default value Password required to decrypt the private key. Refers to `key-pass` CLI option. -{style="narrow"} +{type="narrow"} Type : `String` @@ -2014,7 +2014,7 @@ Default value Returns the version of [JetBrains Marketplace ZIP Signer CLI](https://github.com/JetBrains/marketplace-zip-signer) that will be used. -{style="narrow"} +{type="narrow"} Type : `String` @@ -2028,7 +2028,7 @@ Default value Path to [JetBrains Marketplace ZIP Signer CLI](https://github.com/JetBrains/marketplace-zip-signer) file. Takes precedence over [`signPlugin.cliVersion`](#tasks-signplugin-cliversion). -{style="narrow"} +{type="narrow"} Type : `String` @@ -2042,7 +2042,7 @@ Default value KeyStore file path. Refers to `ks` CLI option. -{style="narrow"} +{type="narrow"} Type : `String` @@ -2055,7 +2055,7 @@ Default value KeyStore password. -{style="narrow"} +{type="narrow"} Type : `String` @@ -2069,7 +2069,7 @@ Default value KeyStore key alias. Refers to `ks-key-alias` CLI option. -{style="narrow"} +{type="narrow"} Type : `String` @@ -2082,7 +2082,7 @@ Default value KeyStore type. -{style="narrow"} +{type="narrow"} Type : `String` @@ -2096,7 +2096,7 @@ Default value JCA KeyStore Provider name. Refers to `ks-provider-name` CLI option. -{style="narrow"} +{type="narrow"} Type : `String` @@ -2120,7 +2120,7 @@ Refers to `out` CLI option. Predefined with the name of the ZIP archive file with `-signed` name suffix attached. -{style="narrow"} +{type="narrow"} Type : `File` @@ -2136,7 +2136,7 @@ Validates completeness and contents of [plugin.xml](plugin_configuration_f Specify whether the build should fail when the verifications performed by this task fail. -{style="narrow"} +{type="narrow"} Type : `Boolean` @@ -2149,7 +2149,7 @@ Default value Specify whether the build should fail when the verifications performed by this task emit warnings. -{style="narrow"} +{type="narrow"} Type : `Boolean` @@ -2162,7 +2162,7 @@ Default value Specify whether the build should fail when the verifications performed by this task emit unacceptable warnings. -{style="narrow"} +{type="narrow"} Type : `Boolean` @@ -2175,7 +2175,7 @@ Default value The location of the built plugin file which will be used for verification. -{style="narrow"} +{type="narrow"} Type : `File` @@ -2218,7 +2218,7 @@ For more details, see [Plugin Signing](plugin_signing.md) article. > {style="note"} -{style="narrow"} +{type="narrow"} Type : `String` @@ -2236,7 +2236,7 @@ Refers to `cert` CLI option. By default, the certificate chain file is set to the value of the [`signPlugin.certificateChainFile`](#tasks-signplugin-certificatechainfile) property. If absent, the [`signPlugin.certificateChain`](#tasks-signplugin-certificatechain) property is used instead, but due to the CLI tool limitations, a temporary file is created and the certificate chain is written to it. -{style="narrow"} +{type="narrow"} Type : `File` diff --git a/topics/appendix/tools/gradle_intellij_plugin/tools_gradle_intellij_plugin_build_features.md b/topics/appendix/tools/gradle_intellij_plugin/tools_gradle_intellij_plugin_build_features.md index ccfa2d7b8..fa360f0a2 100644 --- a/topics/appendix/tools/gradle_intellij_plugin/tools_gradle_intellij_plugin_build_features.md +++ b/topics/appendix/tools/gradle_intellij_plugin/tools_gradle_intellij_plugin_build_features.md @@ -27,7 +27,7 @@ org.jetbrains.intellij.buildFeature.selfUpdateCheck=false When the [`buildSearchableOptions`](tools_gradle_intellij_plugin.md#tasks-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 the task](tools_gradle_intellij_plugin_faq.md#how-to-disable-building-searchable-options) for better performance. -{style="narrow"} +{type="narrow"} Default value : `true` @@ -44,7 +44,7 @@ Due to IDE limitations, it is impossible to run the IDE in headless mode to coll 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. -{style="narrow"} +{type="narrow"} Default value : `true` @@ -67,7 +67,7 @@ Feature respects the Gradle [`--offline`](https://docs.gradle.org/current/usergu > It is strongly suggested to always use the latest available version. Older plugin versions may also not fully support the latest IDE releases. -{style="narrow"} +{type="narrow"} Default value : `true` diff --git a/topics/appendix/tools/intellij_platform_gradle_plugin/tools_intellij_platform_gradle_plugin_extension.md b/topics/appendix/tools/intellij_platform_gradle_plugin/tools_intellij_platform_gradle_plugin_extension.md index 47a4f7ec3..63a3dfcbe 100644 --- a/topics/appendix/tools/intellij_platform_gradle_plugin/tools_intellij_platform_gradle_plugin_extension.md +++ b/topics/appendix/tools/intellij_platform_gradle_plugin/tools_intellij_platform_gradle_plugin_extension.md @@ -83,7 +83,7 @@ The IntelliJ Platform cache is used for storing IntelliJ Platform Gradle Plugin- This path can be changed with the [`org.jetbrains.intellij.platform.intellijPlatformCache`](tools_intellij_platform_gradle_plugin_gradle_properties.md#intellijPlatformCache) Gradle property -{style="narrow"} +{type="narrow"} Access : Read-only @@ -99,7 +99,7 @@ Default value Provides read-only access to the IntelliJ Platform dependency artifact path. -{style="narrow"} +{type="narrow"} Access : Read-only @@ -115,7 +115,7 @@ Default value 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. -{style="narrow"} +{type="narrow"} Access : Read-only @@ -134,7 +134,7 @@ Dynamic plugin will be reloaded automatically when its content is modified. This allows a much faster development cycle by avoiding a full restart of the development instance after code changes. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -152,7 +152,7 @@ See also: Builds an index of UI components (searchable options) for the plugin. Controls the execution of the [`buildSearchableOptions`](tools_intellij_platform_gradle_plugin_tasks.md#buildSearchableOptions) task. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -170,7 +170,7 @@ Enables the [](tools_intellij_platform_gradle_plugin_tasks.md#instrumentCode) of Controls the execution of the [`instrumentCode`](tools_intellij_platform_gradle_plugin_tasks.md#instrumentCode) task. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -183,7 +183,7 @@ Default value Defines the project name, which is used for creating file structure and the build archive. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -196,7 +196,7 @@ Default value The path to the sandbox container where tests and IDE instances read and write data. -{style="narrow"} +{type="narrow"} Type : `DirectoryProperty` @@ -220,7 +220,7 @@ Allows for checking how a plugin works in remote development mode, when one mach This property allows running the IDE with backend and frontend parts running in separate processes. The developed plugin is installed in the backend part. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -240,7 +240,7 @@ See also: Specifies in which part of the product the developed plugin should be installed. -{style="narrow"} +{type="narrow"} Type : [`Property`](tools_intellij_platform_gradle_plugin_types.md#SplitModeAware-SplitModeTarget) @@ -342,7 +342,7 @@ Please restrict input to characters, numbers, and `.`/`-`/`_` symbols, and aim f The provided value will populate the [``](plugin_configuration_file.md#idea-plugin__id) element. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -358,7 +358,7 @@ It should use Title Case. The provided value is used to populate the [``](plugin_configuration_file.md#idea-plugin__name) element. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -375,7 +375,7 @@ For plugins uploaded to the JetBrains Marketplace, [semantic versioning](https:/ The provided value is used as a [``](plugin_configuration_file.md#idea-plugin__version) element. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -393,7 +393,7 @@ The description content is automatically enclosed in ``. The provided value is used to populate the [``](plugin_configuration_file.md#idea-plugin__description) element. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -412,7 +412,7 @@ The change notes content is automatically enclosed in ``. The provided value is used to populate the [``](plugin_configuration_file.md#idea-plugin__change-notes) element. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -485,7 +485,7 @@ The value must be pre-approved by JetBrains and must adhere to [specified requir The provided value is used for a `` element attribute. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -501,7 +501,7 @@ The release date of the major version, formatted as `YYYYMMDD`. The provided value is used for the `` element attribute. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -517,7 +517,7 @@ The major version, represented in a specific numerical format. The provided value is used for the `` element attribute. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -533,7 +533,7 @@ The boolean value that indicates if the plugin is a [Freemium](https://plugins.j The provided value is used for the `` element attribute. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -552,7 +552,7 @@ Specifies the boolean value determining whether the plugin is an EAP release. The provided value is used for the `` element attribute. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -624,7 +624,7 @@ The provided value is used for the `` element attr The default value is set to the `MAJOR.MINOR` version based on the currently selected IntelliJ Platform, like `233.12345`. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -678,7 +678,7 @@ intellijPlatform { -{style="narrow"} +{type="narrow"} Type : `Property` @@ -745,7 +745,7 @@ The name of the vendor or the organization ID (if created), as displayed in the The provided value is used as the value of the [``](plugin_configuration_file.md#idea-plugin__vendor) element. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -760,7 +760,7 @@ The email address of the vendor. The provided value is used for the `` element attribute. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -775,7 +775,7 @@ The URL to the vendor's homepage. The provided value is used for the `` element attribute. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -837,7 +837,7 @@ intellijPlatform { The hostname used for publishing the plugin. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -853,7 +853,7 @@ See also: Authorization token. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -869,7 +869,7 @@ See also: A list of channel names to upload plugin to. -{style="narrow"} +{type="narrow"} Type : `ListProperty` @@ -885,7 +885,7 @@ See also: Specify if the [IDE Services](https://www.jetbrains.com/ide-services/) plugin repository service should be used. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -901,7 +901,7 @@ See also: Publish the plugin update and mark it as hidden to prevent public visibility after approval. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -984,7 +984,7 @@ See also: A path to the local Marketplace ZIP Signer CLI tool to be used. -{style="narrow"} +{type="narrow"} Type : `RegularFileProperty` @@ -998,7 +998,7 @@ See also: KeyStore file path. Refers to `ks` CLI option. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -1012,7 +1012,7 @@ See also: KeyStore password. Refers to `ks-pass` CLI option. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -1026,7 +1026,7 @@ See also: KeyStore key alias. Refers to `ks-key-alias` CLI option. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -1040,7 +1040,7 @@ See also: KeyStore type. Refers to `ks-type` CLI option. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -1054,7 +1054,7 @@ See also: JCA KeyStore Provider name. Refers to `ks-provider-name` CLI option. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -1070,7 +1070,7 @@ Refers to `key` CLI option. Takes precedence over the [](#intellijPlatform-signing-privateKeyFile) property. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -1084,7 +1084,7 @@ See also: A file with an encoded private key in the PEM format. Refers to `key-file` CLI option. -{style="narrow"} +{type="narrow"} Type : `RegularFileProperty` @@ -1098,7 +1098,7 @@ See also: Password required to decrypt the private key. Refers to `key-pass` CLI option. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -1115,7 +1115,7 @@ Refers to `cert` CLI option. Takes precedence over the [](#intellijPlatform-signing-certificateChainFile) property. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -1130,7 +1130,7 @@ Path to the file containing X509 certificates. The first certificate from the chain will be used as a certificate authority (CA). Refers to `cert-file` CLI option. -{style="narrow"} +{type="narrow"} Type : `RegularFileProperty` @@ -1222,7 +1222,7 @@ See also: A path to the local IntelliJ Plugin Verifier CLI tool to be used. -{style="narrow"} +{type="narrow"} Type : `RegularFileProperty` @@ -1235,7 +1235,7 @@ See also: The path to the directory where IDEs used for the verification will be downloaded. -{style="narrow"} +{type="narrow"} Type : `DirectoryProperty` @@ -1248,7 +1248,7 @@ Default value Defines the verification level at which the task should fail if any reported issue matches. -{style="narrow"} +{type="narrow"} Type : [`ListProperty`](tools_intellij_platform_gradle_plugin_types.md#FailureLevel) @@ -1265,7 +1265,7 @@ See also: The list of class prefixes from the external libraries. The Plugin Verifier will not report `No such class` for classes of these packages. -{style="narrow"} +{type="narrow"} Type : `ListProperty` @@ -1280,7 +1280,7 @@ The list of free arguments is passed directly to the IntelliJ Plugin Verifier CL They can be used in addition to the arguments that are provided by dedicated options. -{style="narrow"} +{type="narrow"} Type : `ListProperty` @@ -1294,7 +1294,7 @@ See also: Retrieve the Plugin Verifier home directory used for storing downloaded IDEs. Following home directory resolving method is taken directly from the Plugin Verifier to keep the compatibility. -{style="narrow"} +{type="narrow"} Type : `DirectoryProperty` @@ -1310,7 +1310,7 @@ Default value A file that contains a list of problems that will be ignored in a report. -{style="narrow"} +{type="narrow"} Type : `RegularFileProperty` @@ -1323,7 +1323,7 @@ See also: Which subsystems of the IDE should be checked. -{style="narrow"} +{type="narrow"} Type : `Subsystems` @@ -1340,7 +1340,7 @@ See also: A flag that controls the output format. If set to `true`, the [TeamCity](https://www.jetbrains.com/teamcity/) compatible output will be returned to stdout. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -1356,7 +1356,7 @@ See also: The path to the directory where verification reports will be saved. -{style="narrow"} +{type="narrow"} Type : `DirectoryProperty` @@ -1372,7 +1372,7 @@ See also: The output formats of the verification reports. -{style="narrow"} +{type="narrow"} Type : `ListProperty` diff --git a/topics/appendix/tools/intellij_platform_gradle_plugin/tools_intellij_platform_gradle_plugin_gradle_properties.md b/topics/appendix/tools/intellij_platform_gradle_plugin/tools_intellij_platform_gradle_plugin_gradle_properties.md index 1eae9636f..bcc9664bd 100644 --- a/topics/appendix/tools/intellij_platform_gradle_plugin/tools_intellij_platform_gradle_plugin_gradle_properties.md +++ b/topics/appendix/tools/intellij_platform_gradle_plugin/tools_intellij_platform_gradle_plugin_gradle_properties.md @@ -24,7 +24,7 @@ Value is passed directly to the [IDEA Gradle Plugin](https://docs.gradle.org/cur See also: - [`IdeaModule.downloadSources`](https://docs.gradle.org/current/dsl/org.gradle.plugins.ide.idea.model.IdeaModule.html#org.gradle.plugins.ide.idea.model.IdeaModule:downloadSources) -{style="narrow"} +{type="narrow"} Default value : `true` @@ -46,7 +46,7 @@ Specifies the location of the local IntelliJ Platform cache directory for storin > {style="warning"} -{style="narrow"} +{type="narrow"} Default value : [rootProject]/.intellijPlatform/ @@ -62,7 +62,7 @@ org.jetbrains.intellij.platform.intellijPlatformCache=/path/to/intellijPlatformC 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. -{style="narrow"} +{type="narrow"} Default value : [intellijPlatformCache](#intellijPlatformCache)/localPlatformArtifacts/ @@ -78,7 +78,7 @@ org.jetbrains.intellij.platform.localPlatformArtifacts=/path/to/localPlatformArt When the [](tools_intellij_platform_gradle_plugin_tasks.md#buildSearchableOptions) doesn't produce any results, for example, 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). -{style="narrow"} +{type="narrow"} Default value : `true` @@ -96,7 +96,7 @@ Due to IDE limitations, it is impossible to run the IDE in headless mode to coll 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. -{style="narrow"} +{type="narrow"} Default value : `true` @@ -113,7 +113,7 @@ org.jetbrains.intellij.platform.paidPluginSearchableOptionsWarning=false Specifies the URL from which the list of all Android Studio releases is fetched. This listing is later parsed by `ProductReleasesValueSource` to provide a list of IDEs matching the filtering criteria for running the IntelliJ Plugin Verifier tool with the [`verifyPlugin`](tools_intellij_platform_gradle_plugin_tasks.md#verifyPlugin) task. -{style="narrow"} +{type="narrow"} Default value : `https://jb.gg/android-studio-releases-list.xml` @@ -130,7 +130,7 @@ org.jetbrains.intellij.platform.productsReleasesAndroidStudioUrl=https://... Specifies the URL from which the list of all Android Studio releases is fetched. This listing is later parsed by `ProductReleasesValueSource` to provide a list of IDEs matching the filtering criteria for running the IntelliJ Plugin Verifier tool with the [`verifyPlugin`](tools_intellij_platform_gradle_plugin_tasks.md#verifyPlugin) task. -{style="narrow"} +{type="narrow"} Default value : `https://www.jetbrains.com/updates/updates.xml` @@ -154,7 +154,7 @@ Feature respects the Gradle [`--offline`](https://docs.gradle.org/current/usergu > It is strongly suggested to always use the latest available version. Older plugin versions may also not fully support the latest IDE releases. -{style="narrow"} +{type="narrow"} Default value : `true` @@ -171,7 +171,7 @@ org.jetbrains.intellij.platform.selfUpdateCheck=false 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 [`customPluginRepository()`](tools_intellij_platform_gradle_plugin_repositories_extension.md#additional-repositories). -{style="narrow"} +{type="narrow"} Default value : `7348` @@ -190,7 +190,7 @@ Due to limitations, sometimes it is desired to limit the list of remote endpoint It is possible to refer to the direct location (whenever it is possible) by switching off JetBrains Cache Redirector globally. -{style="narrow"} +{type="narrow"} Default value : `true` diff --git a/topics/appendix/tools/intellij_platform_gradle_plugin/tools_intellij_platform_gradle_plugin_task_awares.md b/topics/appendix/tools/intellij_platform_gradle_plugin/tools_intellij_platform_gradle_plugin_task_awares.md index 8412c8f58..f3a1f2e03 100644 --- a/topics/appendix/tools/intellij_platform_gradle_plugin/tools_intellij_platform_gradle_plugin_task_awares.md +++ b/topics/appendix/tools/intellij_platform_gradle_plugin/tools_intellij_platform_gradle_plugin_task_awares.md @@ -71,7 +71,7 @@ Dynamic plugin will be reloaded automatically when its content is modified. This allows a much faster development cycle by avoiding a full restart of the development instance after code changes. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -101,7 +101,7 @@ Provides the path to the Java Agent file for the Coroutines library required to The path to the coroutines Java Agent file. -{style="narrow"} +{type="narrow"} Type : `RegularFileProperty` @@ -136,7 +136,7 @@ Holds the `intellijPlatform` configuration with the IntelliJ Platform dependency It should not be directly accessed. -{style="narrow"} +{type="narrow"} Type : `ConfigurableFileCollection` @@ -146,7 +146,7 @@ Type Provides a direct path to the IntelliJ Platform dependency artifact. -{style="narrow"} +{type="narrow"} Access : Read-only @@ -161,7 +161,7 @@ Provides information about the IntelliJ Platform product. The information is retrieved from the product-info.json file in the IntelliJ Platform directory. -{style="narrow"} +{type="narrow"} Access : Read-only @@ -176,7 +176,7 @@ Validates that the resolved IntelliJ Platform is supported by checking against t Invokes [`ProductInfo.validateSupportedVersion()`](tools_intellij_platform_gradle_plugin_types.md#ProductInfo-validateSupportedVersion). -{style="narrow"} +{type="narrow"} Throws : `IllegalArgumentException` @@ -201,7 +201,7 @@ Provides the dependency on Java Compiler required for the [code instrumentation] Holds the `intellijPlatformJavaCompiler` configuration with the Java Compiler dependency added. -{style="narrow"} +{type="narrow"} Type : `ConfigurableFileCollection` @@ -227,7 +227,7 @@ The task that inherits from this interface is automatically marked as dependent Indicates that the Kotlin Gradle Plugin is loaded and available. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -240,7 +240,7 @@ Default value This variable represents whether the Kotlin Coroutines library is added explicitly to the project dependencies. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -253,7 +253,7 @@ Default value The `apiVersion` property value of `compileKotlin.kotlinOptions` defined in the build script. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -266,7 +266,7 @@ Default value The `languageVersion` property value of `compileKotlin.kotlinOptions` defined in the build script. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -279,7 +279,7 @@ Default value The version of Kotlin used in the project. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -292,7 +292,7 @@ Default value The `jvmTarget` property value of `compileKotlin.kotlinOptions` defined in the build script. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -305,7 +305,7 @@ Default value `kotlin.stdlib.default.dependency` property value defined in the `gradle.properties` file. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -337,7 +337,7 @@ It resolves and parses the final plugin.xml descriptor file, making Holds the path to the patched plugin.xml file. -{style="narrow"} +{type="narrow"} Type : `RegularPropertyFile` @@ -405,7 +405,7 @@ It is required to have a dependency on the IntelliJ Plugin Verifier added to the Path to the IntelliJ Plugin Verifier executable. -{style="narrow"} +{type="narrow"} Type : `RegularFileProperty` @@ -453,7 +453,7 @@ Provides access to the Java Runtime (i.e., JetBrains Runtime) resolved with `Run Java Runtime parent directory. -{style="narrow"} +{type="narrow"} Type : `DirectoryProperty` @@ -463,7 +463,7 @@ Type An architecture of the Java Runtime currently used for running Gradle. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -473,7 +473,7 @@ Type Metadata object of the Java Runtime currently used for running Gradle. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -483,7 +483,7 @@ Type A custom `JavaLauncher` instance configured with the resolved [`runtimeDirectory`](#RuntimeAware-runtimeDirectory). -{style="narrow"} +{type="narrow"} Type : `Property` @@ -512,7 +512,7 @@ The path to the sandbox container is obtained using the [`intellijPlatform.sandb Represents the suffix used i.e., for test-related tasks. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -524,7 +524,7 @@ The directory containing content read and produced by the running IDE. The directory name depends on the platform type and version currently used for running a task. -{style="narrow"} +{type="narrow"} Type : `DirectoryProperty` @@ -534,7 +534,7 @@ Type A configuration directory located within the [`sandboxDirectory`](#SandboxAware-sandboxDirectory). -{style="narrow"} +{type="narrow"} Type : `DirectoryProperty` @@ -544,7 +544,7 @@ Type A plugins directory located within the [`sandboxDirectory`](#SandboxAware-sandboxDirectory). -{style="narrow"} +{type="narrow"} Type : `DirectoryProperty` @@ -554,7 +554,7 @@ Type A system directory located within the [`sandboxDirectory`](#SandboxAware-sandboxDirectory). -{style="narrow"} +{type="narrow"} Type : `DirectoryProperty` @@ -564,7 +564,7 @@ Type A log directory located within the [`sandboxDirectory`](#SandboxAware-sandboxDirectory). -{style="narrow"} +{type="narrow"} Type : `DirectoryProperty` @@ -597,7 +597,7 @@ It is required to have a dependency on the Marketplace ZIP Signer added to the p Path to the Marketplace ZIP Signer executable. -{style="narrow"} +{type="narrow"} Type : `RegularFileProperty` @@ -626,7 +626,7 @@ Split Mode requires the IntelliJ Platform in the version `241.14473` or later. Enables Split Mode when running the IDE. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -639,7 +639,7 @@ Default value Specifies in which part of the product the developed plugin should be installed. -{style="narrow"} +{type="narrow"} Type : [`Property`](tools_intellij_platform_gradle_plugin_types.md#SplitModeAware-SplitModeTarget) diff --git a/topics/appendix/tools/intellij_platform_gradle_plugin/tools_intellij_platform_gradle_plugin_tasks.md b/topics/appendix/tools/intellij_platform_gradle_plugin/tools_intellij_platform_gradle_plugin_tasks.md index 9c284d2a6..625fefbd2 100644 --- a/topics/appendix/tools/intellij_platform_gradle_plugin/tools_intellij_platform_gradle_plugin_tasks.md +++ b/topics/appendix/tools/intellij_platform_gradle_plugin/tools_intellij_platform_gradle_plugin_tasks.md @@ -52,7 +52,7 @@ By default, the `archiveBaseName` is set to the plugin name specified in the ` @@ -138,7 +138,7 @@ The final JAR is also combined with plugin modules marked using the [`pluginModu Specifies the archive file representing the output file produced by the task. -{style="narrow"} +{type="narrow"} Type : `RegularFileProperty` @@ -171,7 +171,7 @@ This file is bundled into the output JAR files produced by [`composedJar`](#comp The IntelliJ Platform Gradle Plugin version. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -181,7 +181,7 @@ Type The version of currently used Gradle. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -191,7 +191,7 @@ Type The [ProductInfo] instance of the current IntelliJ Platform. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -201,7 +201,7 @@ Type Plugin version. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -211,7 +211,7 @@ Type Location of the generated MANIFEST.MF file. -{style="narrow"} +{type="narrow"} Type : `RegularFileProperty` @@ -247,7 +247,7 @@ To make the Coroutines Java Agent available for the task, inherit from [`Corouti Determines if the operation is running in offline mode and depends on Gradle start parameters. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -264,7 +264,7 @@ See also: Represents the property for checking if self-update checks are enabled. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -278,7 +278,7 @@ Default value Represents a lock file used to limit the plugin version checks in time. If the file is missing and other conditions are met, the version check is performed. -{style="narrow"} +{type="narrow"} Type : `RegularFileProperty` @@ -288,7 +288,7 @@ Type Specifies the Java Agent file for the Coroutines library required to enable coroutines debugging. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -301,7 +301,7 @@ Default value Represents the current version of the plugin. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -311,7 +311,7 @@ Type Represents the latest version of the plugin. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -321,7 +321,7 @@ Type Defines that the current project has only the [](tools_intellij_platform_gradle_plugin_plugins.md#module) applied but no [](tools_intellij_platform_gradle_plugin_plugins.md#platform). -{style="narrow"} +{type="narrow"} Type : `Property` @@ -360,7 +360,7 @@ See also: Specifies the compile classpath of the project's source set. -{style="narrow"} +{type="narrow"} Type : `ConfigurableFileCollection` @@ -370,7 +370,7 @@ Type Specifies the list of directories with compiled classes. -{style="narrow"} +{type="narrow"} Type : `ConfigurableFileCollection` @@ -383,7 +383,7 @@ Default value Specifies the list of directories with GUI Designer form files. -{style="narrow"} +{type="narrow"} Type : `ConfigurableFileCollection` @@ -396,7 +396,7 @@ Default value: Specifies the location of the source code. -{style="narrow"} +{type="narrow"} Type : `ConfigurableFileCollection` @@ -406,7 +406,7 @@ Type Enables `INFO` logging when running Ant tasks. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -419,7 +419,7 @@ Default value: Specifies the output directory for instrumented classes. -{style="narrow"} +{type="narrow"} Type : `DirectoryProperty` @@ -469,7 +469,7 @@ Creates a JAR file with searchable options to be distributed with the plugin. Specifies the directory where the JAR file will be created. -{style="narrow"} +{type="narrow"} Type : `DirectoryProperty` @@ -483,7 +483,7 @@ Default value Specifies if a warning is emitted when no searchable options are found. Can be disabled with [`noSearchableOptionsWarning`](tools_intellij_platform_gradle_plugin_gradle_properties.md#noSearchableOptionsWarning) Gradle property. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -515,7 +515,7 @@ Patches plugin.xml file with values provided with the [`intelliJPla Specifies the input plugin.xml file, which by default is picked from the main resource location. -{style="narrow"} +{type="narrow"} Type : `RegularFileProperty` @@ -528,7 +528,7 @@ Default value Specifies the patched output plugin.xml file, which by default is written to a temporary task-specific directory within the build directory. -{style="narrow"} +{type="narrow"} Type : `RegularFileProperty` @@ -546,7 +546,7 @@ The provided value will be assigned to the [``](plugin_configuration_file.md Please use characters, numbers, and `.`/`-`/`_` symbols only and keep it reasonably short. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -561,7 +561,7 @@ Specifies the user-visible plugin name. It should use Title Case. The provided value will be assigned to the [``](plugin_configuration_file.md#idea-plugin__name) element. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -576,7 +576,7 @@ Specifies the plugin version displayed in the Plugins setting Plugins uploaded to [JetBrains Marketplace](https://plugins.jetbrains.com) must follow [semantic versioning](https://plugins.jetbrains.com/docs/marketplace/semver.htm). The provided value will be assigned to the [``](plugin_configuration_file.md#idea-plugin__version) element. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -592,7 +592,7 @@ Simple HTML elements, like text formatting, paragraphs, lists, etc., are allowed The description content is automatically wrapped in ``. The provided value will be assigned to the [``](plugin_configuration_file.md#idea-plugin__description) element. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -612,7 +612,7 @@ The provided value will be assigned to the [``](plugin_configurati To maintain and generate an up-to-date changelog, try using [Gradle Changelog Plugin](https://github.com/JetBrains/gradle-changelog-plugin). -{style="narrow"} +{type="narrow"} Type : `Property` @@ -627,7 +627,7 @@ The plugin product code used in the JetBrains Sales System. The code must be agreed with JetBrains in advance and follow [the requirements](https://plugins.jetbrains.com/docs/marketplace/obtain-a-product-code-from-jetbrains.html). The provided value will be assigned to the [``](plugin_configuration_file.md#idea-plugin__product-descriptor) element attribute. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -641,7 +641,7 @@ Default value Date of the major version release in the `YYYYMMDD` format. The provided value will be assigned to the [``](plugin_configuration_file.md#idea-plugin__product-descriptor) element attribute. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -655,7 +655,7 @@ Default value Specifies the major version of the plugin in a special number format used for paid plugins on [JetBrains Marketplace](https://plugins.jetbrains.com/docs/marketplace/add-required-parameters.html). The provided value will be assigned to the [``](plugin_configuration_file.md#idea-plugin__product-descriptor) element attribute. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -669,7 +669,7 @@ Default value Specifies the boolean value determining whether the plugin is a [Freemium](https://plugins.jetbrains.com/docs/marketplace/freemium.html) plugin. The provided value will be assigned to the [``](plugin_configuration_file.md#idea-plugin__product-descriptor) element attribute. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -683,7 +683,7 @@ Default value Specifies the boolean value determining whether the plugin is an EAP release. The provided value will be assigned to the [``](plugin_configuration_file.md#idea-plugin__product-descriptor) element attribute. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -697,7 +697,7 @@ Default value Specifies the lowest IDE version compatible with the plugin. The provided value will be assigned to the [``](plugin_configuration_file.md#idea-plugin__idea-version) element attribute. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -716,7 +716,7 @@ The provided value will be assigned to the [``] The `until-build` attribute can be unset by setting `provider { null }` as a value. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -730,7 +730,7 @@ Default value Specifies the vendor name or organization ID (if created) in the Plugins settings dialog and on the [JetBrains Marketplace](https://plugins.jetbrains.com) plugin page. The provided value will be assigned to the [``](plugin_configuration_file.md#idea-plugin__vendor) element. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -744,7 +744,7 @@ Default value Specifies the vendor's email address. The provided value will be assigned to the [``](plugin_configuration_file.md#idea-plugin__vendor) element attribute. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -758,7 +758,7 @@ Default value Specifies the link to the vendor's homepage. The provided value will be assigned to the [``](plugin_configuration_file.md#idea-plugin__vendor) element attribute. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -792,7 +792,7 @@ Collects the content produced with `buildSearchableOptions` for the `jarSearchab Specifies the directory where the prepared searchable options are read from. -{style="narrow"} +{type="narrow"} Type : `DirectoryProperty` @@ -805,7 +805,7 @@ Default value Specifies the directory where the filtered content is placed. -{style="narrow"} +{type="narrow"} Type : `DirectoryProperty` @@ -818,7 +818,7 @@ Default value Specifies the lib directory within the current sandbox. -{style="narrow"} +{type="narrow"} Type : `DirectoryProperty` @@ -831,7 +831,7 @@ Default value Specifies the final composed Jar archive with the plugin content. -{style="narrow"} +{type="narrow"} Type : `RegularFileProperty` @@ -872,7 +872,7 @@ Represents the suffix used i.e., for test-related or custom tasks. The default suffix is composed of the task name (`prepare[X]Sandbox[_Y]`) to the `-[X][Y]` format. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -885,7 +885,7 @@ Default value Specifies the default sandbox destination directory where plugin files will be copied. -{style="narrow"} +{type="narrow"} Type : `DirectoryProperty` @@ -898,7 +898,7 @@ Default value Specifies the name of the plugin directory in the sandbox. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -911,7 +911,7 @@ Default value Specifies the directory where the plugin artifacts are to be placed. -{style="narrow"} +{type="narrow"} Type : `DirectoryProperty` @@ -925,7 +925,7 @@ Default value An internal field to hold a list of plugins to be disabled within the current sandbox. This property is controlled with [`disablePlugin()`](tools_intellij_platform_gradle_plugin_testing_extension.md#plugins) method of [](tools_intellij_platform_gradle_plugin_testing_extension.md). -{style="narrow"} +{type="narrow"} Type : `SetProperty` @@ -936,7 +936,7 @@ Type Specifies the output of the [`Jar`][gradle-jar-task] task. The proper `Jar.archiveFile` picked depends on whether code instrumentation is enabled. -{style="narrow"} +{type="narrow"} Type : `RegularFileProperty` @@ -949,7 +949,7 @@ Default value Specifies a list of dependencies on external plugins resolved from the `intellijPlatformPluginsExtracted` configuration added with [Dependencies Extension](tools_intellij_platform_gradle_plugin_dependencies_extension.md#plugins) -{style="narrow"} +{type="narrow"} Type : `ConfigurableFileCollection` @@ -959,7 +959,7 @@ Type Dependencies defined with the `runtimeClasspath` configuration. -{style="narrow"} +{type="narrow"} Type : `ConfigurableFileCollection` @@ -1054,7 +1054,7 @@ The filter used for retrieving the release list can be customized by using prope Property that holds the list of product releases to print and which can be used to retrieve the result list. -{style="narrow"} +{type="narrow"} Type : `ListProperty` @@ -1097,7 +1097,7 @@ See also: Specifies the ZIP archive file to be published to the remote repository. By default, it uses the output [`signPlugin.archiveFile`](#signPlugin-archiveFile) if plugin signing is configured, otherwise the [`buildPlugin.archiveFile`](#buildPlugin-archiveFile). -{style="narrow"} +{type="narrow"} Type : `RegularFileProperty` @@ -1113,7 +1113,7 @@ See also: Specifies the URL host of a plugin repository. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -1126,7 +1126,7 @@ Default value Specifies the authorization token. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -1142,7 +1142,7 @@ Default value Specifies a list of [JetBrains Marketplace](https://plugins.jetbrains.com) channel names used as destination for the plugin upload. -{style="narrow"} +{type="narrow"} Type : `ListProperty` @@ -1155,7 +1155,7 @@ Default value Publishes the plugin update and marks it as [hidden](https://plugins.jetbrains.com/docs/marketplace/hidden-plugin.html) to prevent public visibility after approval. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -1168,7 +1168,7 @@ Default value Specifies if the IDE Services plugin repository service should be used. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -1325,7 +1325,7 @@ For more details, see [](plugin_signing.md). Specifies the unsigned ZIP archive input file. Corresponds to the `in` CLI option. -{style="narrow"} +{type="narrow"} Type : `RegularFileProperty` @@ -1342,7 +1342,7 @@ Corresponds to the `out` CLI option. Predefined with the name of the ZIP archive file with `-signed` name suffix attached. The output file is placed next to the input [`archiveFile`](#signPlugin-archiveFile). -{style="narrow"} +{type="narrow"} Type : `RegularFileProperty` @@ -1356,7 +1356,7 @@ Default value Specifies the KeyStore file path. Corresponds to the `ks` CLI option. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -1370,7 +1370,7 @@ Default value Specifies the KeyStore password. Corresponds to the `ks-pass` CLI option. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -1384,7 +1384,7 @@ Default value Specifies the KeyStore key alias. Corresponds to the `ks-key-alias` CLI option. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -1398,7 +1398,7 @@ Default value Specifies the KeyStore type. Corresponds to the `ks-type` CLI option. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -1412,7 +1412,7 @@ Default value Specifies the JCA KeyStore Provider name. Corresponds to the `ks-provider-name` CLI option. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -1428,7 +1428,7 @@ Corresponds to the `key` CLI option. Takes precedence over the [`privateKeyFile`](#signPlugin-privateKeyFile) property. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -1442,7 +1442,7 @@ Default value Specifies a file with an encoded private key in the PEM format. Corresponds to the `key-file` CLI option. -{style="narrow"} +{type="narrow"} Type : `RegularFileProperty` @@ -1456,7 +1456,7 @@ Default value Specifies the password required to decrypt the private key. Corresponds to the `key-pass` CLI option. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -1473,7 +1473,7 @@ This parameter corresponds to the `cert` CLI option. Takes precedence over the [`certificateChainFile`](#signPlugin-certificateChainFile) property. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -1488,7 +1488,7 @@ Specifies the path to the file containing X509 certificates. The first certificate in the chain will be used as a certificate authority (CA). Corresponds to the `cert-file` CLI option. -{style="narrow"} +{type="narrow"} Type : `RegularFileProperty` @@ -1602,7 +1602,7 @@ Runs the IDE instance with the developed plugin and Starter framework for UI tes Specifies the archive file representing the input file to be tested. -{style="narrow"} +{type="narrow"} Type : `RegularFileProperty` @@ -1650,7 +1650,7 @@ See also: Specifies IntelliJ Platform IDEs used by the IntelliJ Plugin Verifier CLI tool for binary plugin verification. The list of IDEs is managed through the [`intellijPlatform.pluginVerification.ides`](tools_intellij_platform_gradle_plugin_extension.md#intellijPlatform-pluginVerification-ides) extension. -{style="narrow"} +{type="narrow"} Type : `ConfigurableFileCollection` @@ -1661,7 +1661,7 @@ Type Specifies the input ZIP archive file of the plugin to verify. If this parameter is empty, the task will be skipped. -{style="narrow"} +{type="narrow"} Type : `RegularFileProperty` @@ -1675,7 +1675,7 @@ Default value Specifies a list of class prefixes from external libraries. The Plugin Verifier will not report `No such class` errors for classes in these packages. -{style="narrow"} +{type="narrow"} Type : `ListProperty` @@ -1688,7 +1688,7 @@ Default value Specifies the verification level at which the task fails if any reported issue matches. -{style="narrow"} +{type="narrow"} Type : [`ListProperty`](tools_intellij_platform_gradle_plugin_types.md#FailureLevel) @@ -1704,7 +1704,7 @@ These arguments are used in conjunction with those provided by dedicated options See [](tools_intellij_platform_gradle_plugin_faq.md#mutePluginVerifierProblems) for sample usage. -{style="narrow"} +{type="narrow"} Type : `ListProperty` @@ -1717,7 +1717,7 @@ Default value Specifies a file that contains a list of problems that will be ignored in a report. -{style="narrow"} +{type="narrow"} Type : `RegularFileProperty` @@ -1731,7 +1731,7 @@ Default value Indicates whether the operation is executed in offline mode. This depends on the start parameters specified in Gradle. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -1748,7 +1748,7 @@ See also: Specifies which subsystems of the IDE should be checked. -{style="narrow"} +{type="narrow"} Type : [`Subsystems`](tools_intellij_platform_gradle_plugin_types.md#Subsystems) @@ -1762,7 +1762,7 @@ Default value Specifies whether to use the TeamCity-compatible output format. If set to `true`, outputs in a format compatible with [TeamCity](https://www.jetbrains.com/teamcity/), directing the output to stdout. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -1775,7 +1775,7 @@ Default value Specifies the path to the directory where verification reports will be saved. -{style="narrow"} +{type="narrow"} Type : `DirectoryProperty` @@ -1788,7 +1788,7 @@ Default value Specifies the output formats of the verification reports. -{style="narrow"} +{type="narrow"} Type : [`ListProperty`](tools_intellij_platform_gradle_plugin_types.md#VerificationReportsFormats) @@ -1837,7 +1837,7 @@ See also: Specifies the report directory where the verification result will be stored. -{style="narrow"} +{type="narrow"} Type : `DirectoryProperty` @@ -1850,7 +1850,7 @@ Default value Specifies the root project path. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -1863,7 +1863,7 @@ Default value Specifies the IntelliJ Platform cache directory. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -1876,7 +1876,7 @@ Default value Specifies the `.gitignore` file located in the [rootDirectory], tracked for content changes. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -1889,7 +1889,7 @@ Default value Specifies the `JavaCompile.sourceCompatibility` property value defined in the build script. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -1902,7 +1902,7 @@ Default value Specifies the `JavaCompile.targetCompatibility` property value defined in the build script. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -1915,7 +1915,7 @@ Default value Indicates that the Kotlin Gradle Plugin is loaded and available. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -1928,7 +1928,7 @@ Default value Specifies the `apiVersion` property value of `compileKotlin.kotlinOptions` defined in the build script. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -1941,7 +1941,7 @@ Default value Specifies the `languageVersion` property value of `compileKotlin.kotlinOptions` defined in the build script. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -1954,7 +1954,7 @@ Default value Specifies the version of Kotlin used in the project. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -1967,7 +1967,7 @@ Default value Specifies the `jvmTarget` property value of `compileKotlin.kotlinOptions` defined in the build script. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -1980,7 +1980,7 @@ Default value Specifies the value of the `kotlin.stdlib.default.dependency` property as defined in the gradle.properties file. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -1993,7 +1993,7 @@ Default value Indicates whether the Kotlin Coroutines library is explicitly added to the project dependencies. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -2006,7 +2006,7 @@ Default value Defines if the current module is a main project or imported module, which uses [](tools_intellij_platform_gradle_plugin_plugins.md#module) plugin. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -2043,7 +2043,7 @@ See also: Specifies the input, unsigned ZIP archive file. This parameter corresponds to the `in` CLI option. -{style="narrow"} +{type="narrow"} Type : `RegularFileProperty` @@ -2060,7 +2060,7 @@ This parameter corresponds to the `cert` CLI option. Takes precedence over the [`certificateChainFile`](#verifyPluginSignature-certificateChainFile) property. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -2072,7 +2072,7 @@ Specifies the path to the file containing X509 certificates. The first certificate in the chain will be used as a certificate authority (CA). This parameter corresponds to the `cert-file` CLI option. -{style="narrow"} +{type="narrow"} Type : `RegularFileProperty` @@ -2109,7 +2109,7 @@ See also: Specifies whether the build should fail when the verifications performed by this task fail. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -2122,7 +2122,7 @@ Default value Specifies whether the build should fail when the verifications performed by this task emit unacceptable warnings. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -2135,7 +2135,7 @@ Default value Specifies whether the build should fail when the verifications performed by this task emit warnings. -{style="narrow"} +{type="narrow"} Type : `Property` @@ -2148,7 +2148,7 @@ Default value Specifies the location of the built plugin file used for verification. -{style="narrow"} +{type="narrow"} Type : `DirectoryProperty` diff --git a/topics/appendix/tools/intellij_platform_gradle_plugin/tools_intellij_platform_gradle_plugin_types.md b/topics/appendix/tools/intellij_platform_gradle_plugin/tools_intellij_platform_gradle_plugin_types.md index 764425c8a..9eee38976 100644 --- a/topics/appendix/tools/intellij_platform_gradle_plugin/tools_intellij_platform_gradle_plugin_types.md +++ b/topics/appendix/tools/intellij_platform_gradle_plugin/tools_intellij_platform_gradle_plugin_types.md @@ -113,7 +113,7 @@ Validates that the resolved IntelliJ Platform is supported by checking against t If the provided version is lower, an `IllegalArgumentException` is thrown with an appropriate message. -{style="narrow"} +{type="narrow"} Throws : `IllegalArgumentException` diff --git a/topics/appendix/tools/tools_gradle_grammar_kit_plugin.md b/topics/appendix/tools/tools_gradle_grammar_kit_plugin.md index 52449bcc1..0916dd22c 100644 --- a/topics/appendix/tools/tools_gradle_grammar_kit_plugin.md +++ b/topics/appendix/tools/tools_gradle_grammar_kit_plugin.md @@ -93,7 +93,7 @@ grammarKit { The release version of the [Grammar-Kit](https://github.com/JetBrains/Grammar-Kit) to use. -{style="narrow"} +{type="narrow"} Type : `String` @@ -106,7 +106,7 @@ Default value The version of the IntelliJ-patched JFlex, a [fork of JFlex](https://github.com/JetBrains/intellij-deps-jflex) lexer generator for IntelliJ Platform API. -{style="narrow"} +{type="narrow"} Type : `String` @@ -121,7 +121,7 @@ An optional IntelliJ IDEA version to build the classpath for [`GenerateParser`]( If provided, [`grammarKitRelease`](#grammar-kit-extension-grammarkitrelease) and [`jflexRelease`](#grammar-kit-extension-jflexrelease) properties are ignored as both dependencies will be provided from the given IntelliJ IDEA release. -{style="narrow"} +{type="narrow"} Type : `String` @@ -144,7 +144,7 @@ See also [](#grammar-kit-extension) for common configuration. The source .*flex file to generate the lexer from. -{style="narrow"} +{type="narrow"} Required : yes @@ -157,7 +157,7 @@ Type The path to the target directory for the generated lexer. -{style="narrow"} +{type="narrow"} Required : yes @@ -173,7 +173,7 @@ An optional path to the skeleton file to use for the generated lexer. The path will be provided as `--skel` option. By default, it uses the [idea-flex.skeleton](https://raw.github.com/JetBrains/intellij-community/master/tools/lexer/idea-flex.skeleton) skeleton file. -{style="narrow"} +{type="narrow"} Type : `String` @@ -186,7 +186,7 @@ Default Purge old files from the target directory before generating the lexer. -{style="narrow"} +{type="narrow"} Type : `Boolean` @@ -207,7 +207,7 @@ See also [](#grammar-kit-extension) for common configuration. The source .bnf file to generate the parser from. -{style="narrow"} +{type="narrow"} Required : yes @@ -220,7 +220,7 @@ Type The path to the target directory for the generated parser. -{style="narrow"} +{type="narrow"} Type : `String` @@ -233,7 +233,7 @@ Default The location of the generated parser class, relative to the [`targetRootOutputDir`](#tasks-generateparser-targetrootOutputDir). -{style="narrow"} +{type="narrow"} Required : yes @@ -246,7 +246,7 @@ Type The location of the generated PSI files, relative to the [`targetRootOutputDir`](#tasks-generateparser-targetrootOutputDir). -{style="narrow"} +{type="narrow"} Required : yes @@ -259,7 +259,7 @@ Type Purge old files from the target directory before generating the parser. -{style="narrow"} +{type="narrow"} Type : `Boolean` diff --git a/topics/basics/plugin_structure/plugin_configuration_file.md b/topics/basics/plugin_structure/plugin_configuration_file.md index 4b031dd53..9eb9074a4 100644 --- a/topics/basics/plugin_structure/plugin_configuration_file.md +++ b/topics/basics/plugin_structure/plugin_configuration_file.md @@ -90,7 +90,7 @@ Deprecated elements are omitted in the list below. The plugin.xml file root element. -{style="narrow"} +{type="narrow"} Required : **yes** @@ -140,7 +140,7 @@ Please use characters, numbers, and `'.'`/`'-'`/`'_'` symbols only and keep it r > {style="warning"} -{style="narrow"} +{type="narrow"} Required : no; ignored in an [additional config file](#additional-plugin-configuration-files)
**It is highly recommended to set in plugin.xml file.**
@@ -170,7 +170,7 @@ Example The user-visible plugin display name (Title Case). -{style="narrow"} +{type="narrow"} Required : **yes**; ignored in an [additional config file](#additional-plugin-configuration-files) @@ -194,7 +194,7 @@ The plugin version displayed in the Plugins settings dialog a [JetBrains Marketplace](https://plugins.jetbrains.com) plugin page. Plugins uploaded to the JetBrains Marketplace must follow semantic versioning. -{style="narrow"} +{type="narrow"} Required : **yes**; ignored in an [additional config file](#additional-plugin-configuration-files)
The element can be skipped in the source plugin.xml file if the Gradle plugin `patchPluginXml` task @@ -221,7 +221,7 @@ Example [Paid](https://plugins.jetbrains.com/build-and-market) or [Freemium](https://plugins.jetbrains.com/docs/marketplace/freemium.html) plugin descriptor. -{style="narrow"} +{type="narrow"} Required : only for paid or freemium plugins; ignored in an [additional config file](#additional-plugin-configuration-files)
**Do not add `` element in a free plugin.** @@ -258,7 +258,7 @@ Attributes The plugin's range of compatible IntelliJ-based IDE versions. -{style="narrow"} +{type="narrow"} Required : **yes**; ignored in an [additional config file](#additional-plugin-configuration-files)
The element can be skipped in the source plugin.xml file if the Gradle plugin `patchPluginXml` task @@ -302,7 +302,7 @@ Examples The vendor name or organization ID (if created) in the Plugins settings dialog and on the [JetBrains Marketplace](https://plugins.jetbrains.com) plugin page. -{style="narrow"} +{type="narrow"} Required : **yes**; ignored in an [additional config file](#additional-plugin-configuration-files) @@ -347,7 +347,7 @@ the Plugins settings dialog. Simple HTML elements, like text formatting, paragraphs, lists, etc., are allowed and must be wrapped into `` section. -{style="narrow"} +{type="narrow"} Required : **yes**; ignored in an [additional config file](#additional-plugin-configuration-files)
The element can be skipped in the source plugin.xml file if the Gradle plugin `patchPluginXml` task @@ -387,7 +387,7 @@ the Plugins settings dialog. Simple HTML elements, like text formatting, paragraphs, lists, etc., are allowed and must be wrapped into `` section. -{style="narrow"} +{type="narrow"} Required : no; ignored in an [additional config file](#additional-plugin-configuration-files)
The element can be skipped in the source plugin.xml file if the Gradle plugin `patchPluginXml` task @@ -426,7 +426,7 @@ Example Specifies a dependency on another plugin or a module of an IntelliJ Platform-based product. A single [``](#idea-plugin) element can contain multiple `` elements. -{style="narrow"} +{type="narrow"} Required : no; in most cases dependency on the [platform](plugin_compatibility.md#modules-available-in-all-products) @@ -492,7 +492,7 @@ Examples Declares incompatibility with a provided module. -{style="narrow"} +{type="narrow"} Required : no; ignored in an [additional config file](#additional-plugin-configuration-files) @@ -516,7 +516,7 @@ Example Defines the plugin extensions. -{style="narrow"} +{type="narrow"} Required : no @@ -565,7 +565,7 @@ Examples Extension points defined by the plugin. -{style="narrow"} +{type="narrow"} Required : no @@ -585,7 +585,7 @@ Children A single extension point entry of the [``](#idea-plugin__extensionPoints) defined by the plugin. A single [``](#idea-plugin__extensionPoints) element can contain multiple `` elements. -{style="narrow"} +{type="narrow"} Required : no @@ -640,7 +640,7 @@ Specifies the required parent type for class names provided in extension point t A single [``](#idea-plugin__extensionPoints__extensionPoint) element can contain multiple `` elements. -{style="narrow"} +{type="narrow"} Required : no @@ -701,7 +701,7 @@ A resource bundle to be used with message key attributes in extension declaratio [action and group localization](basic_action_system.md#localizing-actions-and-groups). A single [``](#idea-plugin) element can contain multiple `` elements. -{style="narrow"} +{type="narrow"} Required : no @@ -723,7 +723,7 @@ Example Defines the plugin actions. -{style="narrow"} +{type="narrow"} Required : no @@ -765,7 +765,7 @@ Example A single action entry of the [``](#idea-plugin__actions) implemented by the plugin. A single `` element can contain multiple `` elements. -{style="narrow"} +{type="narrow"} Required : no @@ -830,7 +830,7 @@ the [``](#idea-plugin__actions) element: Specifies that the action should be added to an existing [``](#idea-plugin__actions__group). A single action can be added to multiple groups. -{style="narrow"} +{type="narrow"} Required : no @@ -868,7 +868,7 @@ Example Specifies the keyboard shortcut for the action. A single action can have several keyboard shortcuts. -{style="narrow"} +{type="narrow"} Required : no @@ -924,7 +924,7 @@ Examples Specifies the mouse shortcut for the action. A single action can have several mouse shortcuts. -{style="narrow"} +{type="narrow"} Required : no @@ -979,13 +979,13 @@ Examples Defines an alternate menu action or group text depending on context: menu location, toolbar, and other. -{style="narrow"} +{type="narrow"} Supported : 2020.1+ for actions
2020.3+ for groups -{style="narrow"} +{type="narrow"} Required : no @@ -1037,7 +1037,7 @@ Defines an alternative text for searching the action in Help | Find Act Navigate | Search Everywhere popups. A single action can have multiple synonyms. -{style="narrow"} +{type="narrow"} Required : no @@ -1065,7 +1065,7 @@ Defines an abbreviation for searching the action in Help | Find Action. Navigate | Search Everywhere popups. A single action can have multiple abbreviations. -{style="narrow"} +{type="narrow"} Required : no @@ -1096,7 +1096,7 @@ Defines an action group. The [``](#idea-plugin__actions__action), `` and [``](#idea-plugin__actions__group__separator) elements defined inside the group are automatically included in it. The `` elements can be nested. -{style="narrow"} +{type="narrow"} Required : no @@ -1182,7 +1182,7 @@ Allows adding an existing action to the group. The element can be used directly under the [``](#idea-plugin__actions) element, or in the [``](#idea-plugin__actions__group) element. -{style="narrow"} +{type="narrow"} Required : no @@ -1225,7 +1225,7 @@ The element can be used directly under the [``](#idea-plugin__actions) [``](#idea-plugin__actions__action__add-to-group) element defining the target group, or in the [``](#idea-plugin__actions__group) element. -{style="narrow"} +{type="narrow"} Required : no @@ -1288,7 +1288,7 @@ Examples Defines the application-level listeners. -{style="narrow"} +{type="narrow"} Required : no @@ -1311,7 +1311,7 @@ Defines a single application or project-level listener. A single [``](#idea-plugin__applicationListeners) or [``](#idea-plugin__projectListeners) can contain multiple `` elements. -{style="narrow"} +{type="narrow"} Required : no @@ -1361,7 +1361,7 @@ Example Defines the project-level listeners. -{style="narrow"} +{type="narrow"} Required : no @@ -1381,12 +1381,12 @@ Children Defines a list of application [components](plugin_components.md). -{style="narrow"} +{type="narrow"} Deprecated : since 2020.1 -{style="narrow"} +{type="narrow"} Required : no @@ -1408,12 +1408,12 @@ A single [``](#idea-plugin__application-components), [``](#idea-plugin__project-components), or [``](#idea-plugin__module-components) element can contain multiple `` elements. -{style="narrow"} +{type="narrow"} Deprecated : since 2020.1 -{style="narrow"} +{type="narrow"} Required : no @@ -1435,12 +1435,12 @@ Children The fully qualified name of the component implementation class. -{style="narrow"} +{type="narrow"} Deprecated : since 2020.1 -{style="narrow"} +{type="narrow"} Required : **yes** @@ -1455,12 +1455,12 @@ Required The fully qualified name of the component interface class. If not specified, the interface will be the same as defined by [``](#idea-plugin__application-components__component__interface-class) element. -{style="narrow"} +{type="narrow"} Deprecated : since 2020.1 -{style="narrow"} +{type="narrow"} Required : no @@ -1474,12 +1474,12 @@ Required The fully qualified name of the component implementation class to be used when the IDE runs in headless mode. -{style="narrow"} +{type="narrow"} Deprecated : since 2020.1 -{style="narrow"} +{type="narrow"} Required : no @@ -1494,12 +1494,12 @@ Required Allows to provide additional component options. A single [``](#idea-plugin__application-components__component) element can contain multiple `