Add support for Versions Catalogs gradle/libs.versions.toml

plugins/buildSrcLibs/src/main/kotlin/de/fayard/buildSrcLibs/BuildSrcLibsPlugin.kt

@@ -1,5 +1,6 @@
 package de.fayard.buildSrcLibs
 
+import de.fayard.refreshVersions.core.internal.skipConfigurationCache
 import org.gradle.api.DefaultTask
 import org.gradle.api.Plugin
 import org.gradle.api.Project
@@ -14,6 +15,7 @@ class BuildSrcLibsPlugin : Plugin<Project> {
             group = "refreshVersions"
             description = "Update buildSrc/src/main/kotlin/Libs.kt"
             outputs.upToDateWhen { false }
+            skipConfigurationCache()
         }
         project.tasks.register<DefaultTask>(
             name = "buildSrcVersions"

plugins/buildSrcLibs/src/main/kotlin/de/fayard/buildSrcLibs/BuildSrcLibsTask.kt

@@ -3,7 +3,12 @@ package de.fayard.buildSrcLibs
 import com.squareup.kotlinpoet.FileSpec
 import de.fayard.buildSrcLibs.internal.*
 import de.fayard.refreshVersions.core.addMissingEntriesInVersionsProperties
+import de.fayard.refreshVersions.core.internal.Case
+import de.fayard.refreshVersions.core.internal.MEANING_LESS_NAMES
 import de.fayard.refreshVersions.core.internal.OutputFile
+import de.fayard.refreshVersions.core.internal.checkModeAndNames
+import de.fayard.refreshVersions.core.internal.computeAliases
+import de.fayard.refreshVersions.core.internal.findDependencies
 import org.gradle.api.DefaultTask
 import org.gradle.api.tasks.TaskAction
 
@@ -17,7 +22,7 @@ open class BuildSrcLibsTask : DefaultTask() {
 
     @TaskAction
     fun taskActionInitializeBuildSrc() {
-        OutputFile.checkWhichFilesExist(project.rootDir)
+        OutputFile.checkWhichFilesExist()
         project.file(OutputFile.OUTPUT_DIR.path).also {
             if (it.isDirectory.not()) it.mkdirs()
         }
@@ -42,11 +47,10 @@ open class BuildSrcLibsTask : DefaultTask() {
 
     @TaskAction
     fun taskUpdateLibsKt() {
-        val outputDir = project.file(OutputFile.OUTPUT_DIR.path)
+        val outputDir = OutputFile.OUTPUT_DIR.file
 
         val allDependencies = project.findDependencies()
-        val resolvedUseFqdn = computeUseFqdnFor(
-            libraries = allDependencies,
+        val resolvedUseFqdn = allDependencies.computeAliases(
             configured = emptyList(),
             byDefault = MEANING_LESS_NAMES
         )

plugins/buildSrcLibs/src/main/kotlin/de/fayard/buildSrcLibs/internal/KotlinPoetry.kt

@@ -1,9 +1,15 @@
 package de.fayard.buildSrcLibs.internal
 
-import com.squareup.kotlinpoet.*
+import com.squareup.kotlinpoet.CodeBlock
+import com.squareup.kotlinpoet.FileSpec
+import com.squareup.kotlinpoet.KModifier
+import com.squareup.kotlinpoet.PropertySpec
+import com.squareup.kotlinpoet.TypeSpec
+import de.fayard.refreshVersions.core.internal.Deps
+import de.fayard.refreshVersions.core.internal.Library
 
 internal fun kotlinpoet(
-    deps: Deps
+    deps: Deps,
 ): FileSpec {
     val libraries: List<Library> = deps.libraries
     val indent = "    "
@@ -36,11 +42,10 @@ internal fun kotlinpoet(
 }
 
 
-
 internal fun constStringProperty(
     name: String,
     initializer: CodeBlock,
-    kdoc: CodeBlock? = null
+    kdoc: CodeBlock? = null,
 ): PropertySpec = PropertySpec.builder(name, String::class)
     .addModifiers(KModifier.CONST)
     .initializer(initializer)

plugins/core/src/main/kotlin/de/fayard/refreshVersions/core/MissingVersionEntries.kt

@@ -9,8 +9,7 @@ import org.gradle.api.artifacts.ExternalDependency
 
 @InternalRefreshVersionsApi
 fun addMissingEntriesInVersionsProperties(project: Project) {
-    require(project == project.rootProject) { "Expected a rootProject but got $project" }
-    OutputFile.checkWhichFilesExist(project.rootDir)
+    OutputFile.checkWhichFilesExist()
     val configurationsWithHardcodedDependencies = project.findHardcodedDependencies()
 
     val versionsMap = RefreshVersionsConfigHolder.readVersionsMap()

plugins/core/src/main/kotlin/de/fayard/refreshVersions/core/RefreshVersionsCleanupTask.kt

@@ -1,18 +1,24 @@
 package de.fayard.refreshVersions.core
 
+import de.fayard.refreshVersions.core.internal.OutputFile
 import de.fayard.refreshVersions.core.internal.RefreshVersionsConfigHolder
 import de.fayard.refreshVersions.core.internal.SettingsPluginsUpdater.removeCommentsAddedByUs
+import de.fayard.refreshVersions.core.internal.TomlUpdater
+import de.fayard.refreshVersions.core.internal.VersionCatalogs
+import de.fayard.refreshVersions.core.internal.VersionCatalogs.LIBS_VERSIONS_TOML
 import de.fayard.refreshVersions.core.internal.versions.VersionsPropertiesModel
 import de.fayard.refreshVersions.core.internal.versions.VersionsPropertiesModel.Section
 import de.fayard.refreshVersions.core.internal.versions.readFromFile
 import de.fayard.refreshVersions.core.internal.versions.writeTo
 import org.gradle.api.DefaultTask
 import org.gradle.api.tasks.TaskAction
+import java.io.File
 
 open class RefreshVersionsCleanupTask : DefaultTask() {
 
     @TaskAction
     fun cleanUpVersionsProperties() {
+        OutputFile.checkWhichFilesExist()
         val model = VersionsPropertiesModel.readFromFile(RefreshVersionsConfigHolder.versionsPropertiesFile)
 
         val sectionsWithoutAvailableUpdates = model.sections.map { section ->
@@ -23,18 +29,13 @@ open class RefreshVersionsCleanupTask : DefaultTask() {
         }
         val newModel = model.copy(sections = sectionsWithoutAvailableUpdates)
         newModel.writeTo(RefreshVersionsConfigHolder.versionsPropertiesFile)
+        OutputFile.VERSIONS_PROPERTIES.logFileWasModified()
     }
 
     @TaskAction
     fun cleanUpSettings() {
-        val settingsFiles = listOf(
-            "settings.gradle",
-            "settings.gradle.kts",
-            "buildSrc/settings.gradle",
-            "buildSrc/settings.gradle.kts"
-        ).mapNotNull { path ->
-            project.file(path).takeIf { it.exists() }
-        }
+        val settingsFiles = OutputFile.settingsFiles
+            .filter { it.existed }
 
         settingsFiles.forEach { settingsFile ->
             val initialContent = settingsFile.readText()
@@ -46,5 +47,16 @@ open class RefreshVersionsCleanupTask : DefaultTask() {
                 settingsFile.writeText(newContent)
             }
         }
+
+        settingsFiles.forEach { it.logFileWasModified() }
+    }
+
+    @TaskAction
+    fun cleanUpVersionsCatalog() {
+        if (VersionCatalogs.isSupported()) {
+            val file = File(LIBS_VERSIONS_TOML)
+            TomlUpdater(file, emptyList()).cleanupComments(file)
+            OutputFile.GRADLE_VERSIONS_CATALOG.logFileWasModified()
+        }
     }
 }

plugins/core/src/main/kotlin/de/fayard/refreshVersions/core/RefreshVersionsCorePlugin.kt

@@ -3,7 +3,9 @@ package de.fayard.refreshVersions.core
 import de.fayard.refreshVersions.core.extensions.gradle.isBuildSrc
 import de.fayard.refreshVersions.core.extensions.gradle.isRootProject
 import de.fayard.refreshVersions.core.internal.InternalRefreshVersionsApi
+import de.fayard.refreshVersions.core.internal.OutputFile
 import de.fayard.refreshVersions.core.internal.RefreshVersionsConfigHolder
+import de.fayard.refreshVersions.core.internal.skipConfigurationCache
 import org.gradle.api.Plugin
 import org.gradle.api.Project
 import org.gradle.kotlin.dsl.register
@@ -14,6 +16,7 @@ open class RefreshVersionsCorePlugin : Plugin<Project> {
 
     override fun apply(project: Project) {
         check(project.isRootProject) { "ERROR: de.fayard.refreshVersions.core should not be applied manually" }
+        OutputFile.rootDir = project.rootDir
         if (project.isBuildSrc.not()) {
             // In the case where this runs in includedBuilds, the task configuration lambda may (will) run
             // after RefreshVersionsConfigHolder content is cleared (via its ClearStaticStateBuildService),
@@ -23,6 +26,7 @@ open class RefreshVersionsCorePlugin : Plugin<Project> {
             project.tasks.register<RefreshVersionsTask>(name = "refreshVersions") {
                 group = "refreshVersions"
                 description = "Search for new dependencies versions and update $versionsFileName"
+                skipConfigurationCache()
             }
 
             project.tasks.register<RefreshVersionsCleanupTask>(name = "refreshVersionsCleanup") {

plugins/core/src/main/kotlin/de/fayard/refreshVersions/core/RefreshVersionsTask.kt

@@ -1,7 +1,9 @@
 package de.fayard.refreshVersions.core
 
+import de.fayard.refreshVersions.core.extensions.gradle.getVersionsCatalog
 import de.fayard.refreshVersions.core.internal.*
 import de.fayard.refreshVersions.core.internal.RefreshVersionsConfigHolder.settings
+import de.fayard.refreshVersions.core.internal.VersionCatalogs.LIBS_VERSIONS_TOML
 import de.fayard.refreshVersions.core.internal.problems.log
 import de.fayard.refreshVersions.core.internal.versions.VersionsPropertiesModel
 import de.fayard.refreshVersions.core.internal.versions.writeWithNewVersions
@@ -46,14 +48,17 @@ open class RefreshVersionsTask : DefaultTask() {
 
     @TaskAction
     fun taskActionRefreshVersions() {
-        OutputFile.checkWhichFilesExist(project.rootDir)
+        OutputFile.checkWhichFilesExist()
 
         if (FeatureFlag.userSettings.isNotEmpty()) {
             logger.lifecycle("Feature flags: " + FeatureFlag.userSettings)
         }
         //TODO: Filter using known grouping strategies to only use the main artifact to resolve latest version, this
         // will reduce the number of repositories lookups, improving performance a little more.
 
+        val versionsCatalogMapping: Set<ModuleId.Maven> =
+            VersionCatalogs.dependencyAliases(project.getVersionsCatalog()).keys
+
         runBlocking {
             val lintUpdatingProblemsAsync = async {
                 configureLintIfRunningOnAnAndroidProject(settings, RefreshVersionsConfigHolder.readVersionsMap())
@@ -65,7 +70,8 @@ open class RefreshVersionsTask : DefaultTask() {
                     httpClient = httpClient,
                     project = project,
                     versionMap = RefreshVersionsConfigHolder.readVersionsMap(),
-                    versionKeyReader = RefreshVersionsConfigHolder.versionKeyReader
+                    versionKeyReader = RefreshVersionsConfigHolder.versionKeyReader,
+                    versionsCatalogMapping = versionsCatalogMapping,
                 )
             }
             VersionsPropertiesModel.writeWithNewVersions(result.dependenciesUpdates)
@@ -74,6 +80,10 @@ open class RefreshVersionsTask : DefaultTask() {
                 settingsPluginsUpdates = result.settingsPluginsUpdates,
                 buildSrcSettingsPluginsUpdates = result.buildSrcSettingsPluginsUpdates
             )
+            val libsToml = project.file(LIBS_VERSIONS_TOML)
+            if (VersionCatalogs.isSupported()) {
+                TomlUpdater(libsToml, result.dependenciesUpdates).updateNewVersions(libsToml)
+            }
 
             warnAboutRefreshVersionsIfSettingIfAny()
             warnAboutHardcodedVersionsIfAny(result.dependenciesWithHardcodedVersions)
@@ -83,6 +93,9 @@ open class RefreshVersionsTask : DefaultTask() {
                 logger.log(problem)
             }
             OutputFile.VERSIONS_PROPERTIES.logFileWasModified()
+            if (libsToml.canRead()) {
+                OutputFile.GRADLE_VERSIONS_CATALOG.logFileWasModified()
+            }
         }
     }
 

plugins/core/src/main/kotlin/de/fayard/refreshVersions/core/extensions/gradle/Project.kt

@@ -1,6 +1,18 @@
 package de.fayard.refreshVersions.core.extensions.gradle
 
+import de.fayard.refreshVersions.core.internal.InternalRefreshVersionsApi
 import org.gradle.api.Project
+import org.gradle.api.UnknownDomainObjectException
+import org.gradle.api.artifacts.VersionCatalogsExtension
+import org.gradle.kotlin.dsl.getByType
 
 internal val Project.isRootProject: Boolean get() = this == rootProject
+
 internal val Project.isBuildSrc: Boolean get() = isRootProject && name == "buildSrc"
+
+@InternalRefreshVersionsApi
+fun Project.getVersionsCatalog() = try {
+    project.extensions.getByType<VersionCatalogsExtension>().named("libs")
+} catch (e: UnknownDomainObjectException) {
+    null
+}