net.twisterrob.gradle.internal.deprecation.DeprecatedPlugin.kt Maven / Gradle / Ivy

Go to download
package net.twisterrob.gradle.internal.deprecation

import org.gradle.api.Plugin
import org.gradle.api.Project
import org.gradle.api.initialization.Settings
import org.gradle.api.logging.Logger
import org.gradle.api.logging.Logging
import org.gradle.internal.deprecation.DeprecationLogger
import org.gradle.internal.deprecation.DeprecationMessageBuilder
import org.gradle.util.GradleVersion

@Suppress("detekt.UnnecessaryAbstractClass") // Gradle convention.
abstract class DeprecatedProjectPlugin(
	private val oldName: String,
	private val newName: String,
) : Plugin {

	override fun apply(project: Project) {
		nagUserWithPluginDeprecation(project.project.logger, oldName, newName)
		project.plugins.apply(newName)
	}
}

@Suppress("detekt.UnnecessaryAbstractClass") // Gradle convention.
abstract class DeprecatedSettingsPlugin(
	private val oldName: String,
	private val newName: String,
) : Plugin {

	override fun apply(settings: Settings) {
		nagUserWithPluginDeprecation(Logging.getLogger(Settings::class.java), oldName, newName)
		settings.plugins.apply(newName)
	}
}

private fun nagUserWithPluginDeprecation(logger: Logger, oldName: String, newName: String) {
	if (canNagUser(GradleVersion.current())) {
		gradleInternalNagging(oldName, newName)
	} else {
		logger.warn("Plugin ${oldName} is deprecated, please use ${newName} instead.")
	}
}

private fun gradleInternalNagging(oldName: String, newName: String) {
	// Hook into the Gradle deprecation system so that org.gradle.warning.mode=fail catches it.
	// It will print "This is scheduled to be removed in Gradle X.0.",
	// but that's acceptable considering the benefits.
	val builder: DeprecationMessageBuilder<*> = DeprecationLogger
		.deprecatePlugin(oldName)
		.replaceWith(newName)
		.willBeRemovedInGradleNextMajor(GradleVersion.current())
	nagUserWith(builder, Class.forName("net.twisterrob.gradle.internal.deprecation.DeprecatedPluginKt"))
}