Understanding Implementation Options for Plugins

The choice between script, precompiled script, or binary plugins depends on your specific requirements and preferences.

Script Plugins are simple and easy to write. They are written in Kotlin DSL or Groovy DSL. They are suitable for small, one-off tasks or for quick experimentation. However, they can become hard to maintain as the build script grows in size and complexity.

Precompiled Script Plugins are Kotlin or Groovy DSL scripts compiled into Java class files packaged in a library. They offer better performance and maintainability compared to script plugins, and they can be reused across different projects. You can also write them in Groovy DSL but that is not recommended.

Binary Plugins are full-fledged plugins written in Java, Groovy, or Kotlin, compiled into JAR files, and published to a repository. They offer the best performance, maintainability, and reusability. They are suitable for complex build logic that needs to be shared across projects, builds, and teams. You can also write them in Scala or Groovy but that is not recommended.

Here is a breakdown of all options for implementing Gradle plugins:

# Using: Type: The Plugin is: Recommended?

#	Using:	Type:	The Plugin is:	Recommended?
1	Kotlin DSL	Script plugin	in a `.gradle.kts` file as an abstract class that implements the `apply(Project project)` method of the `Plugin<Project>` interface.	No^[1]
2	Groovy DSL	Script plugin	in a `.gradle` file as an abstract class that implements the `apply(Project project)` method of the `Plugin<Project>` interface.	No^[1]
3	Kotlin DSL	Pre-compiled script plugin	a `.gradle.kts` file.	Yes
4	Groovy DSL	Pre-compiled script plugin	a `.gradle` file.	No^[2]
5	Java	Binary plugin	an abstract class that implements the `apply(Project project)` method of the `Plugin<Project>` interface in Java.	Yes
6	Kotlin	Binary plugin	an abstract class that implements the `apply(Project project)` method of the `Plugin<Project>` interface in Kotlin.	Yes
7	Groovy	Binary plugin	an abstract class that implements the `apply(Project project)` method of the `Plugin<Project>` interface in Groovy.	No^[2]
8	Scala	Binary plugin	an abstract class that implements the `apply(Project project)` method of the `Plugin<Project>` interface in Scala.	No^[2]

Kotlin DSL

Script plugin

in a .gradle.kts file as an abstract class that implements the apply(Project project) method of the Plugin<Project> interface.

No^[1]

Groovy DSL

Script plugin

in a .gradle file as an abstract class that implements the apply(Project project) method of the Plugin<Project> interface.

No^[1]

Kotlin DSL

Pre-compiled script plugin

a .gradle.kts file.

Yes

Groovy DSL

Pre-compiled script plugin

a .gradle file.

No^[2]

Java

Binary plugin

an abstract class that implements the apply(Project project) method of the Plugin<Project> interface in Java.

Yes

Kotlin

Binary plugin

an abstract class that implements the apply(Project project) method of the Plugin<Project> interface in Kotlin.

Yes

Groovy

Binary plugin

an abstract class that implements the apply(Project project) method of the Plugin<Project> interface in Groovy.

No^[2]

Scala

Binary plugin

an abstract class that implements the apply(Project project) method of the Plugin<Project> interface in Scala.

No^[2]

If you suspect issues with your plugin code, try creating a Build Scan to identify bottlenecks. The Gradle profiler can help automate Build Scan generation and gather more low-level information.

1. Script plugins are hard to maintain. Do not use script plugins apply from:, they are not recommended.

2. It is recommended to use a statically-typed language like Java or Kotlin for implementing plugins to reduce the likelihood of binary incompatibilities. If using Groovy, consider using statically compiled Groovy.