mirror of
https://github.com/JetBrains/intellij-sdk-code-samples.git
synced 2025-07-28 01:07:49 +08:00
Correct JAR spelling
This commit is contained in:
Karol Lewandowski
parent
906b74a601
commit
a05f4829e1
@ -168,15 +168,15 @@ To apply required repositories, use [](tools_intellij_platform_gradle_plugin_rep
|
||||
>
|
||||
{title="Bundled vs. Non-Bundled Plugins"}
|
||||
|
||||
| Function | Description |
|
||||
|------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `pluginModule(dependency)` | Adds a dependency on a plugin module to be bundled within the main plugin Jar archive, when working on a multi-module project. Requires passing an existing dependency, like: `pluginModule(implementation(project(":submodule")))` |
|
||||
| `bundledPlugin(id)` | Adds a dependency on a bundled IntelliJ Platform plugin. |
|
||||
| `bundledPlugins(ids)` | Adds dependencies on bundled IntelliJ Platform plugins. |
|
||||
| `plugin(id, version, group)` | Adds a dependency on a plugin for IntelliJ Platform. The `group` parameter can define a plugin release channel, like `@eap` or a full Maven coordinates group. |
|
||||
| `plugin(notation)` | Adds a dependency on a plugin for IntelliJ Platform using a string notation:<p>`pluginId:version` or `pluginId:version@channel`</p> |
|
||||
| `plugins(notations)` | Adds dependencies on plugins for IntelliJ Platform using a string notation:<p>`pluginId:version` or `pluginId:version@channel`</p> |
|
||||
| `localPlugin(localPath)` | Adds a dependency on a local IntelliJ Platform plugin. Accepts path or a dependency on another module. |
|
||||
| Function | Description |
|
||||
|------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `pluginModule(dependency)` | Adds a dependency on a plugin module to be bundled within the main plugin JAR, when working on a multi-module project. Requires passing an existing dependency, like: `pluginModule(implementation(project(":submodule")))` |
|
||||
| `bundledPlugin(id)` | Adds a dependency on a bundled IntelliJ Platform plugin. |
|
||||
| `bundledPlugins(ids)` | Adds dependencies on bundled IntelliJ Platform plugins. |
|
||||
| `plugin(id, version, group)` | Adds a dependency on a plugin for IntelliJ Platform. The `group` parameter can define a plugin release channel, like `@eap` or a full Maven coordinates group. |
|
||||
| `plugin(notation)` | Adds a dependency on a plugin for IntelliJ Platform using a string notation:<p>`pluginId:version` or `pluginId:version@channel`</p> |
|
||||
| `plugins(notations)` | Adds dependencies on plugins for IntelliJ Platform using a string notation:<p>`pluginId:version` or `pluginId:version@channel`</p> |
|
||||
| `localPlugin(localPath)` | Adds a dependency on a local IntelliJ Platform plugin. Accepts path or a dependency on another module. |
|
||||
|
||||
The `plugin(id, version, group)` helpers accepts `group` as a third parameter, set by default to the common [JetBrains Marketplace](https://plugins.jetbrains.com) plugin artifacts group: `com.jetbrains.plugins`.
|
||||
|
||||
|
||||
@ -156,7 +156,7 @@ dependencies {
|
||||
```
|
||||
|
||||
Note that the `:submodule` is added both to the `implementation` configuration and `intellijPlatformPluginModule` using the [](tools_intellij_platform_gradle_plugin_dependencies_extension.md#plugins) helper method.
|
||||
This guarantees that the submodule content will be merged into the main plugin Jar file.
|
||||
This guarantees that the submodule content will be merged into the main plugin JAR file.
|
||||
|
||||
### Available tasks
|
||||
{#module-available-tasks}
|
||||
|
||||
@ -115,7 +115,7 @@ Default value
|
||||
## `composedJar`
|
||||
{#composedJar}
|
||||
|
||||
<link-summary>Composes a final Jar archive by combining the base jar, and instrumented classes, and declared submodules.</link-summary>
|
||||
<link-summary>Composes a final JAR by combining the base JAR, and instrumented classes, and declared submodules.</link-summary>
|
||||
|
||||
<tldr>
|
||||
|
||||
@ -129,10 +129,10 @@ Default value
|
||||
|
||||
</tldr>
|
||||
|
||||
Composes a final Jar archive by combining the output of base `jar` or [`instrumentedJar`](#instrumentedJar) tasks,
|
||||
Composes a final JAR by combining the output of base `jar` or [`instrumentedJar`](#instrumentedJar) tasks,
|
||||
depending on if code instrumentation is enabled with [`intellijPlatform.instrumentCode`](tools_intellij_platform_gradle_plugin_extension.md#intellijPlatform-instrumentCode).
|
||||
|
||||
The final Jar is also combined with plugin modules marked using the [`pluginModule`](tools_intellij_platform_gradle_plugin_dependencies_extension.md#plugins) dependencies helper.
|
||||
The final JAR is also combined with plugin modules marked using the [`pluginModule`](tools_intellij_platform_gradle_plugin_dependencies_extension.md#plugins) dependencies helper.
|
||||
|
||||
|
||||
### `archiveFile`
|
||||
@ -165,7 +165,7 @@ Generates the <path>MANIFEST.MF</path> file with all relevant information about
|
||||
|
||||
To apply the produced manifest file, `JarCompanion.applyPluginManifest` method should be called on a task extending [`Jar`][gradle-jar-task].
|
||||
|
||||
This file is bundled into the output jar files produced by [`composedJar`](#composedJar), [`instrumentedJar`](#instrumentedJar), and [`Jar`][gradle-jar-task] tasks.
|
||||
This file is bundled into the output JAR files produced by [`composedJar`](#composedJar), [`instrumentedJar`](#instrumentedJar), and [`Jar`][gradle-jar-task] tasks.
|
||||
|
||||
|
||||
### `pluginVersion`
|
||||
@ -430,7 +430,7 @@ Type
|
||||
## `instrumentedJar`
|
||||
{#instrumentedJar}
|
||||
|
||||
<link-summary>Creates a Jar file with instrumented classes.</link-summary>
|
||||
<link-summary>Creates a JAR file with instrumented classes.</link-summary>
|
||||
|
||||
<tldr>
|
||||
|
||||
@ -449,7 +449,7 @@ Creates a copy of the current module's `jar` task output with instrumented class
|
||||
## `jarSearchableOptions`
|
||||
{#jarSearchableOptions}
|
||||
|
||||
<link-summary>Creates a Jar file with searchable options to be distributed with the plugin.</link-summary>
|
||||
<link-summary>Creates a JAR file with searchable options to be distributed with the plugin.</link-summary>
|
||||
|
||||
<tldr>
|
||||
|
||||
@ -463,7 +463,7 @@ Creates a copy of the current module's `jar` task output with instrumented class
|
||||
|
||||
</tldr>
|
||||
|
||||
Creates a Jar file with searchable options to be distributed with the plugin.
|
||||
Creates a JAR file with searchable options to be distributed with the plugin.
|
||||
|
||||
|
||||
### `destinationDirectory`
|
||||
|
||||
@ -49,7 +49,7 @@ end title
|
||||
|
||||
The plugin <path>.jar</path> file is placed in the <path>/lib</path> folder under the plugin's "root" folder, together with all required bundled libraries.
|
||||
|
||||
All jars from the <path>/lib</path> folder are automatically added to the classpath (see also [Plugin Class Loaders](plugin_class_loaders.md)).
|
||||
All JARs from the <path>/lib</path> folder are automatically added to the classpath (see also [Plugin Class Loaders](plugin_class_loaders.md)).
|
||||
|
||||
> Do not repackage libraries into the main plugin archive (<path>sample.jar</path> in the sample below).
|
||||
> Otherwise, [Plugin Verifier](verifying_plugin_compatibility.md) will yield false positives for unresolved classes and methods.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user