com.squareup.sort.SortDependenciesPlugin.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sort-dependencies-gradle-plugin Show documentation

Sorts Gradle dependencies

The newest version!

package com.squareup.sort

import org.gradle.api.Plugin
import org.gradle.api.Project
import org.gradle.api.artifacts.Configuration
import org.gradle.language.base.plugins.LifecycleBasePlugin

@Suppress("unused")
class SortDependenciesPlugin : Plugin {

  private companion object {
    const val VERSION_FILENAME = "com-squareup-sort-version.txt"
  }

  private lateinit var extension: SortDependenciesExtension

  override fun apply(target: Project): Unit = target.run {
    extension = SortDependenciesExtension.create(this)

    // nb: Can't use a detached configuration because that needs a Dependency, not a dependency notation. The latter can
    // be lazily evaluated (as below) while the former needs to (e.g.) know its version eagerly: it is more constrained.
    val sortApp = configurations.maybeCreate("sortDependencies").apply {
      target.dependencies.add(
        name,
        extension.version.map { v -> "com.squareup:sort-gradle-dependencies-app:$v" }
      )
    }

    tasks.register("sortDependencies", SortDependenciesTask::class.java) { t ->
      t.configure("sort", target, sortApp, extension)
    }
    val checkTask = tasks.register("checkSortDependencies", SortDependenciesTask::class.java) { t ->
      t.configure("check", target, sortApp, extension)
    }

    afterEvaluate {
      val shouldCheck = extension.check.get()
      if (shouldCheck) {
        pluginManager.withPlugin("lifecycle-base") {
          tasks.named(LifecycleBasePlugin.CHECK_TASK_NAME).configure {
            it.dependsOn(checkTask)
          }
        }
      }
    }
  }

  private fun SortDependenciesTask.configure(
    mode: String,
    project: Project,
    sortApp: Configuration,
    extension: SortDependenciesExtension,
  ) {
    buildScript.set(project.buildFile)
    sortProgram.setFrom(sortApp)
    version.set(extension.version)
    this.mode.set(mode)
    insertBlankLines.set(extension.insertBlankLines)
  }
}