replace autoCorrect with -Auto suffixes (#249)

* rewrite shouldFailWithMessage()

* update test matrix

* WIP apply

* rewrite shouldFailWithMessage()

* rewrite shouldFailWithMessage()

* debugging windows test paths...

* debugging windows test paths...

* it's functional

* start updating docs

* start updating docs

* apply -> auto

* apply -> auto

Author: RBusarow

modulecheck-api/src/main/kotlin/modulecheck/api/settings/ModuleCheckSettings.kt

@@ -19,16 +19,6 @@ import modulecheck.api.KaptMatcher
 
 interface ModuleCheckSettings {
 
-  /**
-   * ModuleCheck will attempt to fix its findings automatically. This means removing unused
-   * dependencies, changing the configuration to `api` if necessary, and adding inherited
-   * dependencies which should be declared explicitly.
-   *
-   * By default, ModuleCheck will "remove" declarations of unused dependencies by simply commenting
-   * them out. See the [deleteUnused] for the option to delete them entirely.
-   */
-  var autoCorrect: Boolean
-
   /**
    * If true, ModuleCheck will delete declarations of unused dependencies entirely.
    *

modulecheck-core/src/main/kotlin/modulecheck/core/ModuleCheckRunner.kt

@@ -32,7 +32,9 @@ import kotlin.system.measureTimeMillis
  *   [FindingResult][modulecheck.api.Finding.FindingResult]
  * @param reportFactory handles console output of the results
  */
+@Suppress("LongParameterList")
 class ModuleCheckRunner(
+  val autoCorrect: Boolean,
   val settings: ModuleCheckSettings,
   val findingFactory: FindingFactory<out Finding>,
   val logger: Logger,
@@ -110,7 +112,7 @@ class ModuleCheckRunner(
 
         findingResultFactory.create(
           findings = list,
-          autoCorrect = settings.autoCorrect,
+          autoCorrect = autoCorrect,
           deleteUnused = settings.deleteUnused
         )
       }

modulecheck-core/src/test/kotlin/modulecheck/core/CheckstyleReportingTest.kt

@@ -41,6 +41,7 @@ internal class CheckstyleReportingTest : BaseTest() {
     val outputFile = File(baseSettings.reports.checkstyle.outputPath)
 
     val runner = ModuleCheckRunner(
+      autoCorrect = false,
       settings = baseSettings,
       findingFactory = {
         listOf(
@@ -84,6 +85,7 @@ internal class CheckstyleReportingTest : BaseTest() {
     val outputFile = File(baseSettings.reports.checkstyle.outputPath)
 
     val runner = ModuleCheckRunner(
+      autoCorrect = false,
       settings = baseSettings,
       findingFactory = {
         listOf(

modulecheck-core/src/test/kotlin/modulecheck/core/TestSettings.kt

@@ -20,7 +20,6 @@ import modulecheck.api.settings.*
 
 @Suppress("UNUSED_PARAMETER")
 data class TestSettings(
-  override var autoCorrect: Boolean = false,
   override var deleteUnused: Boolean = false,
   override var ignoreUnusedFinding: Set<String> = emptySet(),
   override var doNotCheck: Set<String> = emptySet(),

modulecheck-core/src/test/kotlin/modulecheck/core/TextReportingTest.kt

@@ -40,6 +40,7 @@ internal class TextReportingTest : BaseTest() {
     val outputFile = File(baseSettings.reports.text.outputPath)
 
     val runner = ModuleCheckRunner(
+      autoCorrect = false,
       settings = baseSettings,
       findingFactory = {
         listOf(
@@ -83,6 +84,7 @@ internal class TextReportingTest : BaseTest() {
     val outputFile = File(baseSettings.reports.text.outputPath)
 
     val runner = ModuleCheckRunner(
+      autoCorrect = false,
       settings = baseSettings,
       findingFactory = {
         listOf(

modulecheck-plugin/src/main/kotlin/modulecheck/gradle/ModuleCheckExtension.kt

@@ -49,16 +49,6 @@ open class ModuleCheckExtension @Inject constructor(
   projectLayout: ProjectLayout
 ) : ModuleCheckSettings {
 
-  /**
-   * ModuleCheck will attempt to fix its findings automatically. This means removing unused
-   * dependencies, changing the configuration to `api` if necessary, and adding inherited
-   * dependencies which should be declared explicitly.
-   *
-   * By default, ModuleCheck will "remove" declarations of unused dependencies by simply commenting
-   * them out. See the [deleteUnused] for the option to delete them entirely.
-   */
-  override var autoCorrect: Boolean by objects.property(true)
-
   /**
    * If true, ModuleCheck will delete declarations of unused dependencies entirely.
    *

modulecheck-plugin/src/main/kotlin/modulecheck/gradle/ModuleCheckPlugin.kt

@@ -18,13 +18,12 @@ package modulecheck.gradle
 import com.android.build.gradle.tasks.GenerateBuildConfig
 import com.android.build.gradle.tasks.ManifestProcessorTask
 import modulecheck.api.FindingFactory
-import modulecheck.core.rule.ModuleCheckRuleFactory
-import modulecheck.core.rule.MultiRuleFindingFactory
-import modulecheck.core.rule.SingleRuleFindingFactory
+import modulecheck.core.rule.*
 import modulecheck.gradle.internal.isMissingManifestFile
 import modulecheck.gradle.task.ModuleCheckTask
 import org.gradle.api.Plugin
 import org.gradle.api.Project
+import org.gradle.api.tasks.TaskProvider
 import org.gradle.kotlin.dsl.configure
 
 fun Project.moduleCheck(config: ModuleCheckExtension.() -> Unit) {
@@ -43,25 +42,27 @@ class ModuleCheckPlugin : Plugin<Project> {
 
     val rules = factory.create(settings)
 
-    rules.map { rule ->
-      target.registerTask(
-        name = "moduleCheck${rule.id}",
-        findingFactory = SingleRuleFindingFactory(rule)
-      )
-    }
-
-    target.registerTask(
+    target.registerTasks(
+      name = "moduleCheckSortDependencies",
+      findingFactory = SingleRuleFindingFactory(SortDependenciesRule(settings))
+    )
+    target.registerTasks(
+      name = "moduleCheckSortPlugins",
+      findingFactory = SingleRuleFindingFactory(SortPluginsRule(settings))
+    )
+    target.registerTasks(
       name = "moduleCheck",
       findingFactory = MultiRuleFindingFactory(settings, rules)
     )
   }
 
-  private fun Project.registerTask(
+  private fun Project.registerTasks(
     name: String,
     findingFactory: FindingFactory<*>
   ) {
-    tasks.register(name, ModuleCheckTask::class.java, findingFactory)
-      .configure {
+
+    fun TaskProvider<*>.addDependencies() {
+      configure {
 
         allprojects
           .filter { it.isMissingManifestFile() }
@@ -72,5 +73,11 @@ class ModuleCheckPlugin : Plugin<Project> {
           .flatMap { it.tasks.withType(GenerateBuildConfig::class.java) }
           .forEach { dependsOn(it) }
       }
+    }
+
+    tasks.register(name, ModuleCheckTask::class.java, findingFactory, false)
+      .addDependencies()
+    tasks.register("${name}Auto", ModuleCheckTask::class.java, findingFactory, true)
+      .addDependencies()
   }
 }

modulecheck-plugin/src/main/kotlin/modulecheck/gradle/task/ModuleCheckTask.kt

@@ -34,7 +34,8 @@ import java.util.concurrent.ConcurrentHashMap
 import javax.inject.Inject
 
 abstract class ModuleCheckTask<T : Finding> @Inject constructor(
-  private val findingFactory: FindingFactory<T>
+  private val findingFactory: FindingFactory<T>,
+  private val autoCorrect: Boolean
 ) : DefaultTask(),
   ProjectsAware {
 
@@ -50,12 +51,6 @@ abstract class ModuleCheckTask<T : Finding> @Inject constructor(
   @get:Input
   val settings: ModuleCheckExtension = project.extensions.getByType()
 
-  @get:Input
-  val autoCorrect: Boolean = settings.autoCorrect
-
-  @get:Input
-  val deleteUnused: Boolean = settings.deleteUnused
-
   @get:Input
   final override val projectCache = ConcurrentHashMap<String, McProject>()
 
@@ -69,6 +64,7 @@ abstract class ModuleCheckTask<T : Finding> @Inject constructor(
   fun run() {
 
     val runner = ModuleCheckRunner(
+      autoCorrect = autoCorrect,
       settings = settings,
       findingFactory = findingFactory,
       logger = logger,

modulecheck-plugin/src/test/kotlin/modulecheck/gradle/AnvilScopesTest.kt

@@ -50,7 +50,7 @@ class AnvilScopesTest : BasePluginTest() {
       projectBuildSpec?.edit {
         addPlugin("id(\"com.squareup.anvil\")")
         addExternalDependency("implementation", "com.google.dagger:dagger:2.38.1")
-        addProjectDependency("implementation", jvmSub1)
+        addProjectDependency("api", jvmSub1)
       }
       addSrcSpec(
         ProjectSrcSpec(Path.of("src/main/kotlin/com/example/lib2")) {
@@ -77,8 +77,8 @@ class AnvilScopesTest : BasePluginTest() {
           addPlugin("kotlin(\"jvm\")")
           addPlugin("id(\"com.squareup.anvil\")")
           addExternalDependency("implementation", "com.google.dagger:dagger:2.38.1")
-          addProjectDependency("implementation", jvmSub1)
-          addProjectDependency("implementation", jvmSub2)
+          addProjectDependency("api", jvmSub1)
+          addProjectDependency("api", jvmSub2)
         }
       )
       addSrcSpec(
@@ -104,19 +104,11 @@ class AnvilScopesTest : BasePluginTest() {
       addSubproject(appProject)
       addSubprojects(jvmSub1, jvmSub2)
       addSettingsSpec(projectSettings.build())
-      addBuildSpec(
-        projectBuild
-          .addBlock(
-            """moduleCheck {
-            |  autoCorrect = false
-            |}
-          """.trimMargin()
-          ).build()
-      )
+      addBuildSpec(projectBuild.build())
     }
       .writeIn(testProjectDir.toPath())
 
-    shouldSucceed("moduleCheckUnusedDependency")
+    shouldSucceed("moduleCheck")
   }
 
   @Test
@@ -149,8 +141,8 @@ class AnvilScopesTest : BasePluginTest() {
         ProjectBuildSpec {
           addPlugin("kotlin(\"jvm\")")
           addPlugin("id(\"com.squareup.anvil\")")
-          addProjectDependency("implementation", jvmSub1)
-          addProjectDependency("implementation", jvmSub2)
+          addProjectDependency("api", jvmSub1)
+          addProjectDependency("api", jvmSub2)
         }
       )
       addSrcSpec(
@@ -176,19 +168,11 @@ class AnvilScopesTest : BasePluginTest() {
       addSubproject(appProject)
       addSubprojects(jvmSub1, jvmSub2)
       addSettingsSpec(projectSettings.build())
-      addBuildSpec(
-        projectBuild
-          .addBlock(
-            """moduleCheck {
-            |  autoCorrect = false
-            |}
-          """.trimMargin()
-          ).build()
-      )
+      addBuildSpec(projectBuild.build())
     }
       .writeIn(testProjectDir.toPath())
 
-    shouldSucceed("moduleCheckUnusedDependency")
+    shouldSucceed("moduleCheck")
   }
 
   @Test
@@ -241,8 +225,8 @@ class AnvilScopesTest : BasePluginTest() {
         ProjectBuildSpec {
           addPlugin("kotlin(\"jvm\")")
           addPlugin("id(\"com.squareup.anvil\")")
-          addProjectDependency("implementation", jvmSub1)
-          addProjectDependency("implementation", jvmSub2)
+          addProjectDependency("api", jvmSub1)
+          addProjectDependency("api", jvmSub2)
         }
       )
       addSrcSpec(
@@ -258,19 +242,11 @@ class AnvilScopesTest : BasePluginTest() {
       addSubproject(appProject)
       addSubprojects(jvmSub1, jvmSub2)
       addSettingsSpec(projectSettings.build())
-      addBuildSpec(
-        projectBuild
-          .addBlock(
-            """moduleCheck {
-            |  autoCorrect = false
-            |}
-          """.trimMargin()
-          ).build()
-      )
+      addBuildSpec(projectBuild.build())
     }
       .writeIn(testProjectDir.toPath())
 
-    shouldSucceed("moduleCheckUnusedDependency")
+    shouldSucceed("moduleCheck")
   }
 
   @Test
@@ -322,8 +298,8 @@ class AnvilScopesTest : BasePluginTest() {
         ProjectBuildSpec {
           addPlugin("kotlin(\"jvm\")")
           addPlugin("id(\"com.squareup.anvil\")")
-          addProjectDependency("implementation", jvmSub1)
-          addProjectDependency("implementation", jvmSub2)
+          addProjectDependency("api", jvmSub1)
+          addProjectDependency("api", jvmSub2)
         }
       )
       addSrcSpec(
@@ -339,19 +315,11 @@ class AnvilScopesTest : BasePluginTest() {
       addSubproject(appProject)
       addSubprojects(jvmSub1, jvmSub2)
       addSettingsSpec(projectSettings.build())
-      addBuildSpec(
-        projectBuild
-          .addBlock(
-            """moduleCheck {
-            |  autoCorrect = false
-            |}
-          """.trimMargin()
-          ).build()
-      )
+      addBuildSpec(projectBuild.build())
     }
       .writeIn(testProjectDir.toPath())
 
-    shouldSucceed("moduleCheckUnusedDependency")
+    shouldSucceed("moduleCheck")
   }
 
   @Test
@@ -400,8 +368,8 @@ class AnvilScopesTest : BasePluginTest() {
         ProjectBuildSpec {
           addPlugin("kotlin(\"jvm\")")
           addPlugin("id(\"com.squareup.anvil\")")
-          addProjectDependency("implementation", jvmSub1)
-          addProjectDependency("implementation", jvmSub2)
+          addProjectDependency("api", jvmSub1)
+          addProjectDependency("api", jvmSub2)
         }
       )
       addSrcSpec(
@@ -417,19 +385,11 @@ class AnvilScopesTest : BasePluginTest() {
       addSubproject(appProject)
       addSubprojects(jvmSub1, jvmSub2)
       addSettingsSpec(projectSettings.build())
-      addBuildSpec(
-        projectBuild
-          .addBlock(
-            """moduleCheck {
-            |  autoCorrect = false
-            |}
-          """.trimMargin()
-          ).build()
-      )
+      addBuildSpec(projectBuild.build())
     }
       .writeIn(testProjectDir.toPath())
 
-    shouldFail("moduleCheckUnusedDependency") withTrimmedMessage """:app
+    shouldFail("moduleCheck") withTrimmedMessage """:app
            dependency    name                source    build file
         X  :lib-2        unusedDependency              /app/build.gradle.kts: (8, 3):