Package-level declarations

Types

Link copied to clipboard
@DisableCachingByDefault(because = "Zip based tasks do not benefit from caching")
abstract class BuildPluginTask : Zip

Builds the plugin and prepares the ZIP archive for testing and deployment.

Link copied to clipboard
@CacheableTask
abstract class BuildSearchableOptionsTask : JavaExec, RunnableIdeAware

Builds the index of UI components (searchable options) for the plugin. This task runs a headless IDE instance to collect all the available options provided by the plugin's Settings.

Link copied to clipboard
@CacheableTask
abstract class ComposedJarTask : Jar

Composes a final Jar archive by combining the output of base Tasks.External.JAR or Tasks.INSTRUMENTED_JAR tasks, depending on if code instrumentation is enabled with IntelliJPlatformExtension.instrumentCode.

Link copied to clipboard
@CacheableTask
abstract class GenerateManifestTask : DefaultTask, KotlinMetadataAware

Generates the MANIFEST.MF file with all relevant information about the project configuration.

Link copied to clipboard
@UntrackedTask(because = "Should always run")
abstract class InitializeIntelliJPlatformPluginTask : DefaultTask, IntelliJPlatformVersionAware

Executes before every other task introduced by IntelliJ Platform Gradle Plugin to prepare it to run. It is responsible for:

Link copied to clipboard
@CacheableTask
abstract class InstrumentCodeTask : DefaultTask, JavaCompilerAware

Executes the code instrumentation using the Ant tasks provided by the used IntelliJ Platform dependency.

Link copied to clipboard
@CacheableTask
abstract class InstrumentedJarTask : Jar

Creates a copy of the current module's jar task output with instrumented classes added.

Link copied to clipboard
@CacheableTask
abstract class JarSearchableOptionsTask : Jar

Creates a JAR file with searchable options to be distributed with the plugin.

Link copied to clipboard
@CacheableTask
abstract class PatchPluginXmlTask : DefaultTask, IntelliJPlatformVersionAware

Patches plugin.xml files with values provided with the IntelliJPlatformExtension.PluginConfiguration extension.

Link copied to clipboard
@CacheableTask
abstract class PrepareJarSearchableOptionsTask @Inject constructor(fileSystemOperations: FileSystemOperations) : DefaultTask
Link copied to clipboard

Prepares a sandbox environment with the plugin and its dependencies installed. The sandbox directory is required by tasks that run IDE and tests in isolation from other instances, like when multiple IntelliJ Platforms are used for testing with RunIdeTask, TestIdeTask, TestIdeUiTask, or TestIdePerformanceTask tasks. The sandbox directory is created within the container configurable with IntelliJPlatformExtension.sandboxContainer.

Link copied to clipboard
@CacheableTask
abstract class PrepareTestTask : DefaultTask, TestableAware

Prepares an immutable test task and provides all necessary dependencies and configurations for a proper testing configuration.

Link copied to clipboard
@UntrackedTask(because = "Prints output")
abstract class PrintBundledPluginsTask : DefaultTask, IntelliJPlatformVersionAware

Prints the list of bundled plugins available within the currently targeted IntelliJ Platform.

Link copied to clipboard
@UntrackedTask(because = "Prints output")
abstract class PrintProductsReleasesTask : DefaultTask, ProductReleasesValueSource.FilterParameters

Prints the list of binary product releases that, by default, match the currently selected IntelliJ Platform along with IntelliJPlatformExtension.PluginConfiguration.IdeaVersion.sinceBuild and IntelliJPlatformExtension.PluginConfiguration.IdeaVersion.untilBuild properties.

Link copied to clipboard
@UntrackedTask(because = "Output stored remotely")
abstract class PublishPluginTask : DefaultTask

Publishes the plugin to the remote plugins repository, such as JetBrains Marketplace.

Link copied to clipboard
@UntrackedTask(because = "Should always run")
abstract class RunIdeTask : JavaExec, RunnableIdeAware, SplitModeAware, IntelliJPlatformVersionAware

Runs the IDE instance using the currently selected IntelliJ Platform with the built plugin loaded. It directly extends the JavaExec Gradle task, which allows for an extensive configuration (system properties, memory management, etc.).

Link copied to clipboard
@DisableCachingByDefault(because = "No output state to track")
abstract class SetupDependenciesTask : DefaultTask

A deprecated method for setting up IntelliJ Platform dependencies.

Link copied to clipboard
@CacheableTask
abstract class SignPluginTask : JavaExec, SigningAware

Signs the ZIP archive with the provided key using the Marketplace ZIP Signer library.

Link copied to clipboard
@Incubating
@UntrackedTask(because = "Should always run")
abstract class TestIdePerformanceTask : JavaExec, RunnableIdeAware, TestableAware, IntelliJPlatformVersionAware

Runs performance tests on the IDE with the developed plugin installed.

Link copied to clipboard
@UntrackedTask(because = "Should always run")
abstract class TestIdeTask : Test, TestableAware, IntelliJPlatformVersionAware

Runs plugin tests against the currently selected IntelliJ Platform with the built plugin loaded. It directly extends the Test Gradle task, which allows for an extensive configuration (system properties, memory management, etc.).

Link copied to clipboard
@Incubating
@UntrackedTask(because = "Should always run")
abstract class TestIdeUiTask : Test, TestableAware

Runs the IDE instance with the developed plugin and Starter framework for UI testing.

Link copied to clipboard

Validates the plugin project configuration:

Link copied to clipboard
@CacheableTask
abstract class VerifyPluginSignatureTask : JavaExec, SigningAware

Validates the signature of the plugin archive file using the Marketplace ZIP Signer library.

Link copied to clipboard
@CacheableTask
abstract class VerifyPluginStructureTask : DefaultTask

Validates completeness and contents of plugin.xml descriptors as well as plugin archive structure.

Link copied to clipboard
@UntrackedTask(because = "Should always run")
abstract class VerifyPluginTask : JavaExec, RuntimeAware, PluginVerifierAware

Runs the IntelliJ Plugin Verifier CLI tool to check compatibility with specified IDE builds.