IntelliJPlatformGradlePlugin/org.jetbrains.intellij.platform.gradle.tasks/VerifyPluginTask

VerifyPluginTask

@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.

See also

IntelliJPlatformExtension.VerifyPlugin

Verifying Plugin Compatibility

TODO: Use Reporting for handling verification report output? See: https://docs.gradle.org/current/dsl/org.gradle.api.reporting.Reporting.html TODO: Parallel run? https://docs.gradle.org/current/userguide/worker_api.html#converting_to_worker_api

Constructors

VerifyPluginTask

constructor()

Types

object Companion : Registrable

enum FailureLevel : Enum<VerifyPluginTask.FailureLevel>

enum Subsystems : Enum<VerifyPluginTask.Subsystems>

VerificationReportsFormats

enum VerificationReportsFormats : Enum<VerifyPluginTask.VerificationReportsFormats>

Properties

@get:InputFile

@get:SkipWhenEmpty

@get:PathSensitive(value = PathSensitivity.RELATIVE)

abstract val archiveFile: RegularFileProperty

Input ZIP archive file of the plugin to verify. If empty, the task will be skipped.

conventionMapping

@get:Internal

val conventionMapping: ConventionMapping

@get:Internal

var enabled: Boolean

externalPrefixes

@get:Input

@get:Optional

abstract val externalPrefixes: ListProperty<String>

The list of class prefixes from the external libraries. The Plugin Verifier will not report No such class for classes of these packages.

@get:Input

abstract val failureLevel: ListProperty<VerifyPluginTask.FailureLevel>

Defines the verification level at which the task should fail if any reported issue matches.

@get:Input

@get:Optional

abstract val freeArgs: ListProperty<String>

The list of free arguments is passed directly to the IntelliJ Plugin Verifier CLI tool.

hasCustomActions

val hasCustomActions: Boolean

@get:Classpath

abstract val ides: ConfigurableFileCollection

Holds a reference to IntelliJ Platform IDEs which will be used by the IntelliJ Plugin Verifier CLI tool for verification.

ignoredProblemsFile

@get:InputFile

@get:PathSensitive(value = PathSensitivity.RELATIVE)

@get:Optional

abstract val ignoredProblemsFile: RegularFileProperty

A file that contains a list of problems that will be ignored in a report.

impliesSubProjects

var impliesSubProjects: Boolean

intelliJPlatformConfiguration

@get:InputFiles

@get:PathSensitive(value = PathSensitivity.RELATIVE)

abstract val intelliJPlatformConfiguration: ConfigurableFileCollection

Holds the Configurations.INTELLIJ_PLATFORM_DEPENDENCY configuration with the IntelliJ Platform dependency added. It should not be directly accessed.

intelliJPlatformPluginConfiguration

@get:InputFiles

@get:PathSensitive(value = PathSensitivity.RELATIVE)

abstract val intelliJPlatformPluginConfiguration: ConfigurableFileCollection

Holds the Configurations.INTELLIJ_PLATFORM_PLUGIN_DEPENDENCY configuration with the optional custom IntelliJ Platform plugins dependencies added. It should not be directly accessed.

val javaLauncher: Property<JavaLauncher>

val jvmArguments: ListProperty<String>

val mainClass: Property<String>

val mainModule: Property<String>

val modularity: ModularitySpec

@get:Internal

abstract val offline: Property<Boolean>

Determines if the operation is running in offline mode.

@get:Internal

open val platformPath: Path

Provides access to the IntelliJ Platform dependency artifact path.

pluginVerifierExecutable

@get:InputFile

@get:PathSensitive(value = PathSensitivity.RELATIVE)

@get:Optional

abstract val pluginVerifierExecutable: RegularFileProperty

Path to the IntelliJ Plugin Verifier executable.

@get:Internal

open val productInfo: ProductInfo

Provides information about the IntelliJ Platform product. The information is retrieved from the product-info.json file in the IntelliJ Platform directory.

runtimeArchitecture

@get:Internal

abstract val runtimeArchitecture: Property<String>

An architecture of the Java Runtime currently used for running Gradle.

runtimeDirectory

@get:InputDirectory

@get:PathSensitive(value = PathSensitivity.RELATIVE)

abstract val runtimeDirectory: DirectoryProperty

Java Runtime parent directory.

runtimeLauncher

@get:Internal

abstract val runtimeLauncher: Property<JavaLauncher>

A custom JavaLauncher instance configured with the resolved runtimeDirectory.

runtimeMetadata

@get:Internal

abstract val runtimeMetadata: MapProperty<String, String>

Metadata object of the Java Runtime currently used for running Gradle.

val state: TaskStateInternal

subsystemsToCheck

@get:Input

@get:Optional

abstract val subsystemsToCheck: Property<VerifyPluginTask.Subsystems>

Specifies which subsystems of IDE should be checked.

teamCityOutputFormat

@get:Input

@get:Optional

abstract val teamCityOutputFormat: Property<Boolean>

A flag that controls the output format - if set to true, the TeamCity compatible output will be returned to stdout.

val timeout: Property<Duration>

verificationReportsDirectory

@get:OutputDirectory

@get:Optional

abstract val verificationReportsDirectory: DirectoryProperty

The path to the directory where verification reports will be saved.

verificationReportsFormats

@get:Input

@get:Optional

abstract val verificationReportsFormats: ListProperty<VerifyPluginTask.VerificationReportsFormats>

The output formats of the verification reports.

Functions

acceptServiceReferences

open override fun acceptServiceReferences(serviceReferences: MutableSet<ServiceReferenceSpec>)

appendParallelSafeAction

open override fun appendParallelSafeAction(action: Action<in Task>)

open override fun args(vararg args: Any): JavaExec

open override fun args(args: MutableIterable<*>): JavaExecSpec

bootstrapClasspath

open override fun bootstrapClasspath(vararg classpath: Any): JavaExec

open override fun classpath(vararg paths: Any): JavaExec

open operator override fun compareTo(other: Task): Int

open override fun configure(closure: Closure<Any>): Task

conventionMapping

open fun conventionMapping(property: String, mapping: Closure<Any>): Task

open fun conventionMapping(property: String, mapping: Callable<*>): Task

open override fun copyTo(options: JavaForkOptions): JavaExec

open override fun copyTo(target: ProcessForkOptions): JavaExec

open override fun debugOptions(action: Action<JavaDebugOptions>)

open override fun dependsOn(vararg paths: Any): Task

open override fun doFirst(action: Closure<Any>): Task

open override fun doFirst(action: Action<in Task>): Task

open override fun doFirst(actionName: String, action: Action<in Task>): Task

open override fun doLast(action: Closure<Any>): Task

open override fun doLast(action: Action<in Task>): Task

open override fun doLast(actionName: String, action: Action<in Task>): Task

doNotTrackState

open override fun doNotTrackState(reasonNotToTrackState: String)

open override fun environment(environmentVariables: MutableMap<String, *>): JavaExec

open override fun environment(name: String, value: Any): JavaExec

open override fun exec()

Runs the IntelliJ Plugin Verifier against the plugin artifact.

open override fun executable(executable: Any): JavaExec

open override fun finalizedBy(vararg paths: Any): Task

open override fun getActions(): MutableList<Action<in Task>>

open override fun getAllJvmArgs(): MutableList<String>

open override fun getAnt(): AntBuilder

open override fun getArgs(): MutableList<String>?

getArgumentProviders

open override fun getArgumentProviders(): MutableList<CommandLineArgumentProvider>

getAsDynamicObject

@Internal

open override fun getAsDynamicObject(): DynamicObject

getBootstrapClasspath

open override fun getBootstrapClasspath(): FileCollection

open override fun getClasspath(): FileCollection

@Internal

open override fun getCommandLine(): MutableList<String>

@Internal

open override fun ~~getConvention~~(): Convention

open override fun getDebug(): Boolean

getDebugOptions

open override fun getDebugOptions(): JavaDebugOptions

getDefaultCharacterEncoding

open override fun getDefaultCharacterEncoding(): String?

open override fun getDependsOn(): MutableSet<Any>

open override fun getDescription(): String?

getDestroyables

open override fun getDestroyables(): TaskDestroyables

open override fun getDidWork(): Boolean

getEnableAssertions

open override fun getEnableAssertions(): Boolean

@Internal

open override fun getEnvironment(): MutableMap<String, Any>

@Internal

open override fun getErrorOutput(): OutputStream

@Internal(value = "covered by getJavaVersion")

open override fun getExecutable(): String?

getExecutionResult

@Internal

open fun getExecutionResult(): Provider<ExecResult>

open override fun getExtensions(): ExtensionContainer

open override fun getFinalizedBy(): TaskDependency

open override fun getGroup(): String?

getIdentityPath

open override fun getIdentityPath(): Path

open override fun getInputs(): TaskInputsInternal

@Input

open fun getJavaVersion(): JavaVersion

open override fun getJvmArgs(): MutableList<String>?

getJvmArgumentProviders

open override fun getJvmArgumentProviders(): MutableList<CommandLineArgumentProvider>

getLifecycleDependencies

@Internal

open override fun getLifecycleDependencies(): TaskDependencyInternal

open override fun getLocalState(): TaskLocalState

open override fun getLogger(): Logger

open override fun getLogging(): LoggingManager

open override fun getMaxHeapSize(): String?

open override fun getMinHeapSize(): String?

getMustRunAfter

open override fun getMustRunAfter(): TaskDependency

open override fun getName(): String

open override fun getOnlyIf(): Spec<in TaskInternal>

open override fun getOutputs(): TaskOutputsInternal

open override fun getPath(): String

open override fun getProject(): Project

getReasonNotToTrackState

open override fun getReasonNotToTrackState(): Optional<String>

getReasonTaskIsIncompatibleWithConfigurationCache

open override fun getReasonTaskIsIncompatibleWithConfigurationCache(): Optional<String>

getRequiredServices

open override fun getRequiredServices(): TaskRequiredServices

getSharedResources

open override fun getSharedResources(): MutableList<ResourceLock>

getShouldRunAfter

open override fun getShouldRunAfter(): TaskDependency

getStandardInput

@Internal

open override fun getStandardInput(): InputStream

getStandardOutput

@Internal

open override fun getStandardOutput(): OutputStream

getStandardOutputCapture

open override fun getStandardOutputCapture(): StandardOutputCapture

getSystemProperties

open override fun getSystemProperties(): MutableMap<String, Any>

open override fun getTaskActions(): MutableList<InputChangesAwareTaskAction>

getTaskDependencies

open override fun getTaskDependencies(): TaskDependencyInternal

getTaskIdentity

open override fun getTaskIdentity(): TaskIdentity<*>

getTemporaryDir

open override fun getTemporaryDir(): File

getTemporaryDirFactory

open override fun getTemporaryDirFactory(): Factory<File>

@Internal

open override fun getWorkingDir(): File

open override fun hasProperty(propertyName: String): Boolean

open override fun hasTaskActions(): Boolean

isCompatibleWithConfigurationCache

open override fun isCompatibleWithConfigurationCache(): Boolean

isIgnoreExitValue

@Input

open override fun isIgnoreExitValue(): Boolean

open override fun jvmArgs(vararg arguments: Any): JavaExec

open override fun jvmArgs(arguments: MutableIterable<*>): JavaExec

open override fun mustRunAfter(vararg paths: Any): Task

notCompatibleWithConfigurationCache

open override fun notCompatibleWithConfigurationCache(reason: String)

open override fun onlyIf(onlyIfClosure: Closure<Any>)

open override fun onlyIf(spec: Spec<in Task>)

open override fun onlyIf(onlyIfReason: String, spec: Spec<in Task>)

prependParallelSafeAction

open override fun prependParallelSafeAction(action: Action<in Task>)

open override fun property(propertyName: String): Any?

open override fun setActions(replacements: MutableList<Action<in Task>>)

open override fun setAllJvmArgs(arguments: MutableIterable<*>)

open override fun setAllJvmArgs(arguments: MutableList<String>)

open override fun setArgs(applicationArgs: MutableIterable<*>?): JavaExec

open override fun setArgs(applicationArgs: MutableList<String>?): JavaExec

open fun setArgsString(args: String): JavaExec

setBootstrapClasspath

open override fun setBootstrapClasspath(classpath: FileCollection)

open override fun setClasspath(classpath: FileCollection): JavaExec

open override fun setDebug(enabled: Boolean)

setDefaultCharacterEncoding

open override fun setDefaultCharacterEncoding(defaultCharacterEncoding: String?)

open override fun setDependsOn(dependsOn: MutableIterable<*>)

open override fun setDescription(description: String?)

open override fun setDidWork(didWork: Boolean)

setEnableAssertions

open override fun setEnableAssertions(enabled: Boolean)

open override fun setEnvironment(environmentVariables: MutableMap<String, *>)

open override fun setErrorOutput(outputStream: OutputStream): JavaExec

open override fun setExecutable(executable: Any)

open override fun setExecutable(executable: String)

open override fun setFinalizedBy(finalizedByTasks: MutableIterable<*>)

open override fun setGroup(group: String?)

setIgnoreExitValue

open override fun setIgnoreExitValue(ignoreExitValue: Boolean): JavaExecSpec

open override fun setJvmArgs(arguments: MutableIterable<*>?)

open override fun setJvmArgs(arguments: MutableList<String>?)

@ReplacedBy(value = "mainClass")

open fun ~~setMain~~(@Nullable main: String?): JavaExecSpec

open override fun setMaxHeapSize(heapSize: String?)

open override fun setMinHeapSize(heapSize: String?)

setMustRunAfter

open override fun setMustRunAfter(mustRunAfterTasks: MutableIterable<*>)

open override fun setOnlyIf(onlyIfClosure: Closure<Any>)

open override fun setOnlyIf(spec: Spec<in Task>)

open override fun setOnlyIf(onlyIfReason: String, spec: Spec<in Task>)

open override fun setProperty(name: String, value: Any)

setShouldRunAfter

open override fun setShouldRunAfter(shouldRunAfterTasks: MutableIterable<*>)

setStandardInput

open override fun setStandardInput(inputStream: InputStream): JavaExec

setStandardOutput

open override fun setStandardOutput(outputStream: OutputStream): JavaExec

setSystemProperties

open override fun setSystemProperties(properties: MutableMap<String, *>)

open override fun setWorkingDir(dir: File)

open override fun setWorkingDir(dir: Any)

open override fun shouldRunAfter(vararg paths: Any): TaskDependency

systemProperties

open override fun systemProperties(properties: MutableMap<String, *>): JavaExec

open override fun systemProperty(name: String, value: Any): JavaExec

open override fun usesService(service: Provider<out BuildService<*>>)

validateIntelliJPlatformVersion

open fun validateIntelliJPlatformVersion()

Validates that the resolved IntelliJ Platform is supported by checking against the minimal supported IntelliJ Platform version.

open override fun workingDir(dir: Any): JavaExec