Add linter rules in Android Studio

Closes #339

Automatically add the right lint rules if AGP is detected to avoid warnings/errors on version placeholder

Author: jmfayard

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.internal.RefreshVersionsConfigHolder
+import de.fayard.refreshVersions.core.internal.RefreshVersionsConfigHolder.settings
 import de.fayard.refreshVersions.core.internal.SettingsPluginsUpdater
+import de.fayard.refreshVersions.core.internal.configureLintOnAndroidProjects
 import de.fayard.refreshVersions.core.internal.legacy.LegacyBootstrapUpdater
 import de.fayard.refreshVersions.core.internal.lookupVersionCandidates
 import de.fayard.refreshVersions.core.internal.versions.VersionsPropertiesModel
@@ -77,6 +79,7 @@ open class RefreshVersionsTask : DefaultTask() {
             warnAboutHardcodedVersionsIfAny(result.dependenciesWithHardcodedVersions)
             warnAboutDynamicVersionsIfAny(result.dependenciesWithDynamicVersions)
             warnAboutGradleUpdateAvailableIfAny(result.gradleUpdates)
+            configureLintOnAndroidProjects(settings, RefreshVersionsConfigHolder.readVersionsMap())
         }
     }
 

plugins/core/src/main/kotlin/de/fayard/refreshVersions/core/internal/LintUpdater.kt

@@ -0,0 +1,40 @@
+package de.fayard.refreshVersions.core.internal
+
+import org.gradle.api.initialization.Settings
+
+// Disable a warning in Android Studio that AGP has version "_"
+fun configureLintOnAndroidProjects(settings: Settings, versionsMap: Map<String, String>) {
+    if ("plugin.android" !in versionsMap) return
+    val file = settings.rootDir.resolve("lint.xml")
+    val currentLintXml = when {
+        file.canRead() -> file.readText()
+        else -> ""
+    }
+    val newLintXml = updateLintXml(currentLintXml)
+    if (newLintXml !== currentLintXml) {
+        file.writeText(newLintXml)
+    }
+}
+
+fun updateLintXml(input: String): String {
+    val alreadyAdded = input.contains("GradleDependency") && input.contains("GradlePluginVersion")
+    if (alreadyAdded) return input
+    val ignoreRules = """
+        |    <issue id="GradleDependency" severity="ignore" />
+        |    <issue id="GradlePluginVersion" severity="ignore" />
+    """.trimMargin()
+
+    val prefix = when {
+        input.isBlank() -> """
+            <?xml version="1.0" encoding="UTF-8"?>
+            <lint>
+        """.trimIndent()
+        else -> input.substringBefore("</lint>").trimEnd()
+    }
+    val postfix = "</lint>"
+    return """
+        |$prefix
+        |$ignoreRules
+        |$postfix
+    """.trimMargin()
+}

plugins/core/src/test/kotlin/de/fayard/refreshVersions/core/LintUpdaterTest.kt

@@ -0,0 +1,29 @@
+package de.fayard.refreshVersions.core
+
+import de.fayard.refreshVersions.core.internal.updateLintXml
+import io.kotest.matchers.shouldBe
+import org.junit.jupiter.api.TestFactory
+import testutils.junit.mapDynamicTest
+import java.io.File
+
+class LintUpdaterTest {
+
+    private val testDataDir = testResources.resolve("lint-updater")
+
+    private val dirs = testDataDir.listFiles { file ->
+        file.isDirectory
+    }!!.asList()
+
+    @TestFactory
+    fun `lint updater`() = dirs.mapDynamicTest { dirOfSample ->
+        `test lint updater`(dirOfSample)
+    }
+
+    private fun `test lint updater`(directory: File) {
+        require(directory.isDirectory)
+        val input = directory.resolve("input.xml").readText()
+        val expected = directory.resolve("expected.xml").readText()
+        updateLintXml(input).trim() shouldBe expected.trim()
+    }
+}
+

plugins/core/src/test/resources/lint-updater/already-added/expected.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<lint>
+    <issue id="MissingPermission" severity="informational" />
+    <issue id="GradleDependency" severity="ignore" />
+    <issue id="GradlePluginVersion" severity="ignore" />
+</lint>

plugins/core/src/test/resources/lint-updater/already-added/input.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<lint>
+    <issue id="MissingPermission" severity="informational" />
+    <issue id="GradleDependency" severity="ignore" />
+    <issue id="GradlePluginVersion" severity="ignore" />
+</lint>

plugins/core/src/test/resources/lint-updater/blank/expected.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<lint>
+    <issue id="GradleDependency" severity="ignore" />
+    <issue id="GradlePluginVersion" severity="ignore" />
+</lint>

plugins/core/src/test/resources/lint-updater/blank/input.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<lint>
+    <issue id="GradleDependency" severity="ignore" />
+    <issue id="GradlePluginVersion" severity="ignore" />
+</lint>

plugins/core/src/test/resources/lint-updater/empty/expected.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<lint>
+
+</lint>

plugins/core/src/test/resources/lint-updater/empty/input.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<lint>
+    <issue id="MissingPermission" severity="informational" />
+    <issue id="GradleDependency" severity="ignore" />
+    <issue id="GradlePluginVersion" severity="ignore" />
+</lint>