hxuanyu/intellij-sdk-code-samples
1
0
Fork 0
mirror of https://github.com/JetBrains/intellij-sdk-code-samples.git synced 2025-07-30 10:17:50 +08:00
Code Issues Packages Projects Releases Wiki Activity

IntelliJ Platform Gradle Plugin: Introduce intellijPlatform.projectName property, drop the PluginAware.plugin

Browse Source
This commit is contained in:
Jakub Chrzanowski 2024-02-22 11:35:57 +01:00
parent 23a02af182
commit 54d86f0ef7
No known key found for this signature in database
GPG Key ID: C39095BFD769862E
3 changed files with 23 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
topics/appendix/tools/intellij_platform_gradle_plugin/tools_intellij_platform_gradle_plugin_extension.md
View File

@ -21,6 +21,7 @@ After the IntelliJ Platform Gradle Plugin is [applied](tools_intellij_platform_g
intellijPlatform {
buildSearchableOptions = true
instrumentCode = true
projectName = project.name
sandboxContainer = "..."
pluginConfiguration {
@ -104,6 +105,19 @@ Default value
: [`ProductInfo`](tools_intellij_platform_gradle_plugin_types.md#ProductInfo) of the current IntelliJ Platform
### projectName
{#intellijPlatform-projectName}
Defines the project name, which is used for creating file structure and the build archive.
{style="narrow"}
Type
: `Property<String>`
Default value
: `project.name`
### sandboxContainer
{#intellijPlatform-sandboxContainer}

10
topics/appendix/tools/intellij_platform_gradle_plugin/tools_intellij_platform_gradle_plugin_task_awares.md
View File

@ -172,14 +172,10 @@ Default value
: [`patchPluginXml.outputFile`](tools_intellij_platform_gradle_plugin_tasks.md#patchPluginXml-outputFile)
### plugin
{#PluginAware-plugin}
### parse {}
{#PluginAware-parse}
Provides a parsed <path>plugin.xml</path> file as a [`PluginBean`](tools_intellij_platform_gradle_plugin_types.md#PluginBean) object.
{style="narrow"}
Type
: [`PluginBean`](tools_intellij_platform_gradle_plugin_types.md#PluginBean)
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

38
topics/appendix/tools/intellij_platform_gradle_plugin/tools_intellij_platform_gradle_plugin_tasks.md
View File

@ -67,8 +67,8 @@ flowchart LR
initializeIntelliJPlatformPlugin --> | runs before | ALL
buildPlugin --> jarSearchableOptions & prepareSandbox
jarSearchableOptions --> buildSearchableOptions & prepareSandbox
buildPlugin --> jarSearchableOptions & prepareSandbox & patchPluginXml
jarSearchableOptions --> buildSearchableOptions & prepareSandbox & patchPluginXml
buildSearchableOptions --> patchPluginXml & prepareSandbox
prepareSandbox --> jar & instrumentedJar
publishPlugin --> buildPlugin & signPlugin
@ -133,7 +133,7 @@ It takes the output of the [`prepareSandbox`](#prepareSandbox) task containing t
The produced archive is stored in the <path>[buildDirectory]/distributions/[`archiveFile`](#buildPlugin-archiveFile)</path> file.
The [`archiveFile`](#buildPlugin-archiveFile) name and location can be controlled with properties provided with the [`Zip`](https://docs.gradle.org/current/dsl/org.gradle.api.tasks.bundling.Zip.html) base task.
By default, the `archiveBaseName` is set to the value of [`prepareSandbox.pluginName`](#prepareSandbox-pluginName).
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
@ -318,9 +318,9 @@ See also:
<tldr>
**Depends on**: [`buildSearchableOptions`](#buildSearchableOptions)
**Depends on**: [`buildSearchableOptions`](#buildSearchableOptions), [`patchPluginXml`](#patchPluginXml)
**Extends**: [`Jar`][gradle-jar-task], [`SandboxAware`](tools_intellij_platform_gradle_plugin_task_awares.md#SandboxAware)
**Extends**: [`Jar`][gradle-jar-task], [`PluginAware`](tools_intellij_platform_gradle_plugin_task_awares.md#PluginAware), [`SandboxAware`](tools_intellij_platform_gradle_plugin_task_awares.md#SandboxAware)
**Sources**: [`JarSearchableOptionsTask`](%gh-ijpgp%/src/main/kotlin/org/jetbrains/intellij/platform/gradle/tasks/JarSearchableOptionsTask.kt)
@ -358,7 +358,7 @@ Default value
### noSearchableOptionsWarning
{#jarSearchableOptions-noSearchableOptionsWarning}
Emit warning if no searchable options are found.
Emit a warning if no searchable options are found.
Can be disabled with [`noSearchableOptionsWarning`](tools_intellij_platform_gradle_plugin_gradle_properties.md#noSearchableOptionsWarning) build feature.
{style="narrow"}
@ -369,19 +369,6 @@ Default value
: [`noSearchableOptionsWarning`](tools_intellij_platform_gradle_plugin_gradle_properties.md#noSearchableOptionsWarning)
### pluginName
{#jarSearchableOptions-pluginName}
The name of the plugin.
{style="narrow"}
Type
: `Property<String>`
Default value
: [`intellijPlatform.pluginConfiguration.name`](tools_intellij_platform_gradle_plugin_extension.md#intellijPlatform-pluginConfiguration-name)
## patchPluginXml
{#patchPluginXml}
@ -734,19 +721,6 @@ Default value
: [`SandboxAware.sandboxPluginsDirectory`](tools_intellij_platform_gradle_plugin_task_awares.md#SandboxAware-sandboxPluginsDirectory)
### pluginName
{#prepareSandbox-pluginName}
The name of the plugin.
{style="narrow"}
Type
: `Property<String>`
Default value
: [`intellijPlatform.pluginConfiguration.name`](tools_intellij_platform_gradle_plugin_extension.md#intellijPlatform-pluginConfiguration-name)
### pluginJar
{#prepareSandbox-pluginJar}