Add library containing detekt rules for apollo plugins

game/plugin-detekt-rules/build.gradle

@@ -0,0 +1,15 @@
+apply plugin: 'java-library'
+apply plugin: 'org.jetbrains.kotlin.jvm'
+apply from: "$rootDir/gradle/kotlin.gradle"
+
+dependencies {
+    api group: 'io.gitlab.arturbosch.detekt', name: 'detekt-api', version: detektVersion
+
+    test.useJUnitPlatform()
+    testImplementation("org.junit.jupiter:junit-jupiter-api:${junitJupiterVersion}")
+    testImplementation("org.junit.jupiter:junit-jupiter-params:${junitJupiterVersion}")
+    testImplementation("org.junit.jupiter:junit-jupiter-engine:${junitJupiterVersion}")
+    testImplementation("org.junit.platform:junit-platform-launcher:${junitPlatformVersion}")
+
+    testImplementation group: 'io.gitlab.arturbosch.detekt', name: 'detekt-test', version: detektVersion
+}

game/plugin-detekt-rules/src/main/kotlin/org/apollo/game/plugin/detekt/ApolloPluginRuleSetProvider.kt

@@ -0,0 +1,16 @@
+package org.apollo.game.plugin.detekt
+
+import io.gitlab.arturbosch.detekt.api.Config
+import io.gitlab.arturbosch.detekt.api.RuleSet
+import io.gitlab.arturbosch.detekt.api.RuleSetProvider
+import org.apollo.game.plugin.detekt.rules.DeclarationInScriptRule
+
+class ApolloPluginRuleSetProvider : RuleSetProvider {
+    override val ruleSetId = "apollo-plugin"
+
+    override fun instance(config: Config): RuleSet {
+        return RuleSet(ruleSetId, listOf(
+            DeclarationInScriptRule()
+        ))
+    }
+}

game/plugin-detekt-rules/src/main/kotlin/org/apollo/game/plugin/detekt/rules/DeclarationInScriptRule.kt

@@ -0,0 +1,31 @@
+package org.apollo.game.plugin.detekt.rules
+
+import io.gitlab.arturbosch.detekt.api.*
+import org.jetbrains.kotlin.psi.KtClass
+import org.jetbrains.kotlin.psi.KtFile
+import org.jetbrains.kotlin.psi.KtObjectDeclaration
+
+class DeclarationInScriptRule : Rule() {
+    override val issue = Issue(
+        "DeclarationInScript",
+        Severity.CodeSmell,
+        "This rule reports a plugin file containing class or object declarations.",
+        Debt.FIVE_MINS
+    )
+
+    override fun visit(root: KtFile) {
+        super.visit(root)
+
+        val script = root.script ?: return
+        val declarations = script.declarations.filter { it is KtClass || it is KtObjectDeclaration }
+
+        declarations
+            .forEach {
+                report(CodeSmell(
+                    issue,
+                    Entity.from(it),
+                    message = "Declaration of ${it.name} should live in a top-level file, not a script"
+                ))
+            }
+    }
+}

game/plugin-detekt-rules/src/main/resources/META-INF/services/io.gitlab.arturbosch.detekt.api.RuleSetProvider

@@ -0,0 +1 @@
+org.apollo.game.plugin.detekt.ApolloPluginRuleSetProvider

game/plugin-detekt-rules/src/test/kotlin/org/apollo/game/plugin/detekt/rules/DeclarationInScriptRuleTest.kt

@@ -0,0 +1,19 @@
+package org.apollo.game.plugin.detekt.rules
+
+import io.gitlab.arturbosch.detekt.test.lint
+import java.nio.file.Paths
+import org.junit.jupiter.api.Assertions.*
+import org.junit.jupiter.api.Test
+
+internal class DeclarationInScriptRuleTest {
+    val rule = DeclarationInScriptRule()
+
+    @Test
+    fun `Finds warning in script file`() {
+        val srcPath = Paths.get(this.javaClass.getResource("/testData/example.kts").toURI())
+        val findings = rule.lint(srcPath)
+
+        assertEquals(1, findings.size)
+        assertEquals("Declaration of ExampleDeclaration should live in a top-level file, not a script", findings[0].message)
+    }
+}

game/plugin-detekt-rules/src/test/resources/testData/example.kts

@@ -0,0 +1,3 @@
+class ExampleDeclaration {
+
+}

gradle/code-quality.gradle

@@ -15,6 +15,7 @@ detekt {
 
 dependencies {
     detekt group: 'io.gitlab.arturbosch.detekt', name: 'detekt-formatting', version: detektVersion
+    detekt project(':game:plugin-detekt-rules')
 }
 
 sonarqube {

gradle/config/detekt.yml

@@ -473,3 +473,7 @@ style:
   WildcardImport:
     active: false
     excludeImports: 'java.util.*,kotlinx.android.synthetic.*'
+
+apollo-plugin:
+  DeclarationInScript:
+    active: true

settings.gradle

@@ -5,6 +5,7 @@ rootProject.name = 'org.apollo'
 include ':cache'
 include ':game'
 include ':game:plugin'
+include ':game:plugin-detekt-rules'
 include ':game:plugin-testing'
 include ':net'
 include ':util'