create paper-checkstyle plugin

Author: Machine-Maker

paperweight-core/src/main/kotlin/io/papermc/paperweight/checkstyle/JavadocTag.kt

@@ -0,0 +1,13 @@
+package io.papermc.paperweight.checkstyle
+
+data class JavadocTag(val tag: String, val appliesTo: String, val prefix: String) {
+    fun toOptionString(): String {
+        return "$tag:$appliesTo:$prefix"
+    }
+}
+
+fun PaperCheckstyleTask.setCustomJavadocTags(tags: Iterable<JavadocTag>) {
+    configProperties = (configProperties ?: emptyMap()).toMutableMap().apply {
+        this["custom_javadoc_tags"] = tags.joinToString("|") { it.toOptionString() }
+    }
+}

paperweight-core/src/main/kotlin/io/papermc/paperweight/checkstyle/PaperCheckstyle.kt

@@ -0,0 +1,29 @@
+package io.papermc.paperweight.checkstyle
+
+import io.papermc.paperweight.core.extension.PaperCheckstyleExt
+import io.papermc.paperweight.util.constants.*
+import org.gradle.api.Plugin
+import org.gradle.api.Project
+import org.gradle.api.plugins.quality.CheckstyleExtension
+import org.gradle.kotlin.dsl.*
+
+abstract class PaperCheckstyle : Plugin<Project> {
+
+    override fun apply(target: Project) = with(target) {
+        val ext = extensions.create(PAPER_CHECKSTYLE_EXTENSION, PaperCheckstyleExt::class)
+        plugins.apply(PaperCheckstylePlugin::class.java)
+
+        extensions.configure(CheckstyleExtension::class.java) {
+            toolVersion = "10.21.0"
+            configDirectory.set(ext.projectLocalCheckstyleConfig)
+        }
+
+        tasks.withType(PaperCheckstyleTask::class.java) {
+            rootPath.set(project.rootDir.path)
+            directoriesToSkip.set(ext.directoriesToSkip)
+            typeUseAnnotations.set(ext.typeUseAnnotations)
+        }
+        Unit
+    }
+}
+

paperweight-core/src/main/kotlin/io/papermc/paperweight/checkstyle/PaperCheckstylePlugin.kt

@@ -0,0 +1,12 @@
+package io.papermc.paperweight.checkstyle
+
+import org.gradle.api.plugins.quality.Checkstyle
+import org.gradle.api.plugins.quality.CheckstylePlugin
+
+abstract class PaperCheckstylePlugin : CheckstylePlugin() {
+
+    override fun getTaskType(): Class<Checkstyle> {
+        @Suppress("UNCHECKED_CAST")
+        return PaperCheckstyleTask::class.java as Class<Checkstyle>
+    }
+}

paperweight-core/src/main/kotlin/io/papermc/paperweight/checkstyle/PaperCheckstyleTask.kt

@@ -0,0 +1,37 @@
+package io.papermc.paperweight.checkstyle
+
+import org.gradle.api.plugins.quality.Checkstyle
+import org.gradle.api.provider.Property
+import org.gradle.api.provider.SetProperty
+import org.gradle.api.tasks.Input
+import org.gradle.api.tasks.TaskAction
+import java.nio.file.Paths
+import kotlin.io.path.relativeTo
+
+abstract class PaperCheckstyleTask : Checkstyle() {
+
+    @get:Input
+    abstract val rootPath: Property<String>
+
+    @get:Input
+    abstract val directoriesToSkip: SetProperty<String>
+
+    @get:Input
+    abstract val typeUseAnnotations: SetProperty<String>
+
+    @TaskAction
+    override fun run() {
+        val existingProperties = configProperties?.toMutableMap() ?: mutableMapOf()
+        existingProperties["type_use_annotations"] = typeUseAnnotations.get().joinToString("|")
+        configProperties = existingProperties
+        exclude {
+            if (it.isDirectory) return@exclude false
+            val absPath = it.file.toPath().toAbsolutePath().relativeTo(Paths.get(rootPath.get()))
+            val parentPath = (absPath.parent?.toString() + "/")
+            directoriesToSkip.get().any { pkg -> parentPath == pkg }
+        }
+        if (!source.isEmpty) {
+            super.run()
+        }
+    }
+}

paperweight-core/src/main/kotlin/io/papermc/paperweight/core/extension/PaperCheckstyleExt.kt

@@ -0,0 +1,21 @@
+package io.papermc.paperweight.core.extension
+
+import javax.inject.Inject
+import org.gradle.api.file.DirectoryProperty
+import org.gradle.api.file.ProjectLayout
+import org.gradle.api.provider.SetProperty
+
+@Suppress("LeakingThis")
+abstract class PaperCheckstyleExt {
+
+    @get:Inject
+    abstract val layout: ProjectLayout
+
+    abstract val typeUseAnnotations: SetProperty<String>
+    abstract val directoriesToSkip: SetProperty<String>
+    abstract val projectLocalCheckstyleConfig: DirectoryProperty
+
+    init {
+        projectLocalCheckstyleConfig.convention(layout.projectDirectory.dir(".checkstyle"))
+    }
+}

paperweight-core/src/main/resources/META-INF/gradle-plugins/io.papermc.paperweight.paper-checkstyle.properties

@@ -0,0 +1 @@
+implementation-class=io.papermc.paperweight.checkstyle.PaperCheckstyle

paperweight-lib/src/main/kotlin/io/papermc/paperweight/util/constants/constants.kt

@@ -25,6 +25,7 @@ package io.papermc.paperweight.util.constants
 import org.gradle.api.Task
 
 const val PAPERWEIGHT_EXTENSION = "paperweight"
+const val PAPER_CHECKSTYLE_EXTENSION = "paperCheckstyle"
 const val PAPERWEIGHT_DEBUG = "paperweight.debug"
 fun paperweightDebug(): Boolean = System.getProperty(PAPERWEIGHT_DEBUG, "false") == "true"
 const val PAPERWEIGHT_VERBOSE_APPLY_PATCHES = "paperweight.verboseApplyPatches"