JarCastingAutoPlugin
A configuration/metadata generator for Gradle Plugins.
Gradle uses a special file inside the META-INF metadata to find declared plugins. Keeping these files up to date can be tedious and error prone. AutoPlugin simplifies this by generating these files at compile time.
Simply annotate your plugin with @AutoPlugin and provide the Plugin ID. AutoPlugin will do the rest.
Example
package com.example
import org.gradle.api.Plugin
import se.ansman.autoplugin.AutoPlugin
@AutoPlugin("my-plugin")
abstract class MyPlugin : Plugin<Project> {
override fun apply(target: Project) {
// …
}
}
AutoPlugin will generate the file META-INF/gradle-plugins/my-plugin.properties containing
implementation-class=com.example.MyPlugin
This will allow Gradle to find your plugin, letting users apply it using the ID:
plugins {
id("my-plugin")
// or
`my-plugin`
}
// or
apply(plugin = "my-plugin")
Setup
KSP
If using Kotlin it's preferred to use the Gradle plugin which will use KSP to generate the file:
plugins {
id("se.ansman.autoplugin") version "0.4.1"
}
// You can optionally configure it:
autoPlugin {
// This applies the KSP Gradle Plugin for you. This is optional, but you need to apply the KSP plugin manually if
// you don't call this.
applyKsp()
// You can later call enableVerification() to re-enable it
disableVerification()
// You can later call verboseLogging(enabled = false) to disable verbose logging
verboseLogging()
}
If you do not want to use the Gradle Plugin you need to set everything up yourself:
- Apply the KSP plugin.
- Add
build/generated/ksp/src/main/resourcesto yourmainsource set. - Optionally you can pass the KSP compiler options
autoPlugin.verifyand/orautoPlugin.verbose(both are booleans). - Make the
processResourcestask depend on thecompileKotlintask - Add the required dependencies:
dependencies {
implementation("se.ansman.autoplugin:api:0.4.1")
ksp("se.ansman.autoplugin:compiler:0.4.1")
}
Annotations Processing
If you aren't using Kotlin or does not want to use KSP you can add it as an annotation processor:
dependencies {
implementation("se.ansman.autoplugin:api:0.4.1")
annotationsProcessor("se.ansman.autoplugin:compile:0.4.1")
// For kotlin projects you'll use this instead
kapt("se.ansman.autoplugin:compile:0.4.1")
}
Options
Both the KSP compiler and the AnnotationsProcessor support options:
autoPlugin.verbose = true/false- Enables verbose logging. Default isfalse.autoPlugin.verify = true/false- Enables verification. Default istrue.
The the documentation for the respective tools for information on how to pass them. The Gradle Plugin has these options in the extension.
Snapshots
Snapshots are published to oss.jfrog.org.
To set it up you need to add the snapshot repository:
repositories {
jcenter()
// Add the OSS repo
maven {
setUrl("https://oss.jfrog.org/artifactory/libs-snapshot")
}
}
dependencies {
implementation("se.ansman.autoplugin:api:<snapshot-version>")
}
// If you are using the Gradle Plugin you can override the version used like this:
autoPlugin {
version.set("<snapshot-version>")
}
To use a snapshot version of the Gradle Plugin you need to add this in your settings.gradle.kts:
pluginManagement {
resolutionStrategy {
eachPlugin {
when (requested.id.id) {
"se.ansman.autoplugin" ->
useModule("se.ansman.autoplugin:gradle-plugin:${requested.version}")
}
}
}
repositories {
gradlePluginPortal()
maven {
setUrl("https://oss.jfrog.org/artifactory/libs-snapshot")
}
}
}
Building locally
To build locally just run ./gradlew publishLibraryPublicationToMavenLocal and it will install it to your local maven repo (~/.m2/repository). Add the mavenLocal() repo to your project to use it.
Attribution
This library is heavily influenced by Auto Service.
The KSP implementation is based on auto-service-ksp.
License
Copyright 2020 Nicklas Ansman Giertz
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.