Warn in Sponge plugins that use java.util.Logger

Closes #361

Author: DenWav

src/main/kotlin/com/demonwav/mcdev/platform/AbstractModule.kt

@@ -59,9 +59,7 @@ abstract class AbstractModule(protected val facet: MinecraftFacet) {
     open fun generateEventListenerMethod(containingClass: PsiClass,
                                          chosenClass: PsiClass,
                                          chosenName: String,
-                                         data: GenerationData?): PsiMethod? {
-        return null
-    }
+                                         data: GenerationData?): PsiMethod? = null
 
     @Contract(value = "null -> false", pure = true)
     open fun shouldShowPluginIcon(element: PsiElement?) = false

src/main/kotlin/com/demonwav/mcdev/platform/mixin/inspection/MixinInspection.kt

@@ -35,7 +35,7 @@ abstract class MixinInspection : AbstractBaseJavaLocalInspectionTool() {
         return if (MixinModuleType.isInModule(file)) {
             super.processFile(file, manager)
         } else {
-            listOf()
+            emptyList()
         }
     }
 }

src/main/kotlin/com/demonwav/mcdev/platform/mixin/inspection/implements/SoftImplementOverridesInspection.kt

@@ -17,7 +17,7 @@ import com.intellij.psi.JavaElementVisitor
 import com.intellij.psi.PsiElementVisitor
 import com.intellij.psi.PsiMethod
 
-class SoftImplementOverridesInspection : MixinInspection() {
+class SuSoftImplementOverridesInspection : MixinInspection() {
 
     override fun getStaticDescription() = "Reports soft-implemented methods in Mixins that do not override a method in the target classes."
 

src/main/kotlin/com/demonwav/mcdev/platform/sponge/inspection/SpongeLoggingInspection.kt

@@ -0,0 +1,66 @@
+/*
+ * Minecraft Dev for IntelliJ
+ *
+ * https://minecraftdev.org
+ *
+ * Copyright (c) 2017 minecraft-dev
+ *
+ * MIT License
+ */
+
+package com.demonwav.mcdev.platform.sponge.inspection
+
+import com.demonwav.mcdev.platform.sponge.SpongeModuleType
+import com.demonwav.mcdev.util.Constants
+import com.demonwav.mcdev.util.fullQualifiedName
+import com.intellij.codeInspection.AbstractBaseJavaLocalInspectionTool
+import com.intellij.codeInspection.InspectionManager
+import com.intellij.codeInspection.ProblemDescriptor
+import com.intellij.codeInspection.ProblemHighlightType
+import com.intellij.codeInspection.ProblemsHolder
+import com.intellij.psi.JavaElementVisitor
+import com.intellij.psi.PsiClassType
+import com.intellij.psi.PsiElementVisitor
+import com.intellij.psi.PsiField
+import com.intellij.psi.PsiFile
+
+class SpongeLoggingInspection : AbstractBaseJavaLocalInspectionTool() {
+
+    override fun getStaticDescription() =
+        "Sponge provides a ${Constants.SLF4J_LOGGER} logger implementation using @Inject in your plugin class. " +
+            "You should not use ${Constants.JAVA_UTIL_LOGGER} in your plugin."
+
+    override fun buildVisitor(holder: ProblemsHolder, isOnTheFly: Boolean): PsiElementVisitor {
+        return if (SpongeModuleType.isInModule(holder.file)) {
+            Visitor(holder)
+        } else {
+            PsiElementVisitor.EMPTY_VISITOR
+        }
+    }
+
+    override fun processFile(file: PsiFile, manager: InspectionManager): List<ProblemDescriptor> {
+        return if (SpongeModuleType.isInModule(file)) {
+            super.processFile(file, manager)
+        } else {
+            emptyList()
+        }
+    }
+
+    private class Visitor(private val holder: ProblemsHolder) : JavaElementVisitor() {
+
+        override fun visitField(field: PsiField) {
+            val element = field.typeElement ?: return
+            val name = (field.type as? PsiClassType)?.fullQualifiedName ?: return
+
+            if (name != Constants.JAVA_UTIL_LOGGER) {
+                return
+            }
+
+            holder.registerProblem(
+                element,
+                "Sponge plugins should use ${Constants.SLF4J_LOGGER} rather than ${Constants.JAVA_UTIL_LOGGER}.",
+                ProblemHighlightType.GENERIC_ERROR_OR_WARNING
+            )
+        }
+    }
+}

src/main/kotlin/com/demonwav/mcdev/util/Constants.kt

@@ -0,0 +1,17 @@
+/*
+ * Minecraft Dev for IntelliJ
+ *
+ * https://minecraftdev.org
+ *
+ * Copyright (c) 2017 minecraft-dev
+ *
+ * MIT License
+ */
+
+package com.demonwav.mcdev.util
+
+object Constants {
+
+    const val JAVA_UTIL_LOGGER = "java.util.logging.Logger"
+    const val SLF4J_LOGGER = "org.slf4j.Logger"
+}

src/main/kotlin/com/demonwav/mcdev/util/class-utils.kt

@@ -33,7 +33,7 @@ val PsiClass.packageName
 
 @get:Contract(pure = true)
 val PsiClassType.fullQualifiedName
-    get() = resolve()!!.fullQualifiedName
+    get() = resolve()?.fullQualifiedName // this can be null if the type import is missing
 
 // Class
 

src/main/resources/META-INF/plugin.xml

@@ -159,6 +159,14 @@
         <annotator language="JAVA" implementationClass="com.demonwav.mcdev.platform.sponge.color.SpongeColorAnnotator"/>
 
         <library.presentationProvider implementation="com.demonwav.mcdev.platform.sponge.framework.SpongePresentationProvider" />
+
+        <localInspection displayName="Wrong Sponge logger implementation"
+                         groupName="Minecraft"
+                         language="JAVA"
+                         enabledByDefault="true"
+                         level="WARNING"
+                         hasStaticDescription="true"
+                         implementationClass="com.demonwav.mcdev.platform.sponge.inspection.SpongeLoggingInspection"/>
         <!--endregion-->
 
         <!--region FORGE-->