Merge branch 'hannibal002:beta' into feature/tentacles

.github/scripts/process_detekt_sarif.sh

@@ -29,7 +29,7 @@ read -r -d '' jq_command <<'EOF'
     ",title=" + (.ruleId) +
     ",col=" + (.l.region.startColumn|tostring) +
     ",endColumn=" + (.l.region.endColumn|tostring) +
-    "::" + (.message.text)
+    "::" + (.message)
 )
 EOF
 

.github/workflows/build.yml

@@ -36,28 +36,30 @@ jobs:
                 with:
                     name: "Test Results"
                     path: versions/1.8.9/build/reports/tests/test/
-    #detekt:
-    #    name: Run detekt
-    #    runs-on: ubuntu-latest
+    detekt:
+        name: Run detekt
+        runs-on: ubuntu-latest
 
-    #    steps:
-    #        -   name: Checkout code
-    #            uses: actions/checkout@v4
-    #        -   uses: ./.github/actions/setup-normal-workspace
-    #        # detektMain is a LOT slower than detekt, but it does type analysis
-    #        -   name: Run detekt main (w/typing analysis)
-    #            run: |
-    #                ./gradlew detektMain --stacktrace
-    #        -   name: Annotate detekt failures
-    #            if: ${{ !cancelled() }}
-    #            run: |
-    #                chmod +x .github/scripts/process_detekt_sarif.sh
-    #                ./.github/scripts/process_detekt_sarif.sh versions/1.8.9/build/reports/detekt/main.sarif
+        steps:
+            -   name: Checkout code
+                uses: actions/checkout@v4
+            -   uses: ./.github/actions/setup-normal-workspace
+            # detektMain is a LOT slower than detekt, but it does type analysis
+            -   name: Run detekt main (w/typing analysis)
+                run: |
+                    ./gradlew detektMain --stacktrace
+            -   name: Annotate detekt failures
+                if: ${{ !cancelled() }}
+                run: |
+                    chmod +x .github/scripts/process_detekt_sarif.sh
+                    ./.github/scripts/process_detekt_sarif.sh versions/1.8.9/build/reports/detekt/main.sarif
     
 
     preprocess:
         runs-on: ubuntu-latest
         name: "Build multi version"
+        env:
+            SKIP_DETEKT: "true"
         steps:
             -   name: Checkout code
                 uses: actions/checkout@v4

.github/workflows/pr-check.yml

@@ -2,11 +2,11 @@ name: "PR Changelog Verification"
 
 on:
     pull_request_target:
-        types: [ opened, edited ]
+        types: [ opened, edited, ready_for_review ]
 
 jobs:
     verify-changelog:
-        if: github.event.pull_request.state == 'open' && '511310721' == github.repository_id
+        if: github.event.pull_request.state == 'open' && '511310721' == github.repository_id && github.event.pull_request.draft == false
         runs-on: ubuntu-latest
 
         steps:

.live-plugins/module/plugin.kts

@@ -18,6 +18,7 @@ val forgeEvent = "SubscribeEvent"
 val handleEvent = "HandleEvent"
 val skyHanniModule = "SkyHanniModule"
 
+val skyhanniPath = "at.hannibal2.skyhanni"
 val patternGroup = "at.hannibal2.skyhanni.utils.repopatterns.RepoPatternGroup"
 val pattern = "java.util.regex.Pattern"
 
@@ -36,12 +37,17 @@ fun isRepoPattern(property: KtProperty): Boolean {
     return false
 }
 
+fun isFromSkyhanni(declaration: KtNamedDeclaration): Boolean {
+    return declaration.fqName?.asString()?.startsWith(skyhanniPath) ?: false
+}
+
 class ModuleInspectionKotlin : AbstractKotlinInspection() {
     override fun buildVisitor(holder: ProblemsHolder, isOnTheFly: Boolean): PsiElementVisitor {
 
         val visitor = object : KtVisitorVoid() {
 
             override fun visitClass(klass: KtClass) {
+                if (!isFromSkyhanni(klass)) return
                 val hasAnnotation = klass.annotationEntries.any { it.shortName?.asString() == skyHanniModule }
 
                 if (hasAnnotation) {
@@ -54,6 +60,7 @@ class ModuleInspectionKotlin : AbstractKotlinInspection() {
             }
 
             override fun visitObjectDeclaration(declaration: KtObjectDeclaration) {
+                if (!isFromSkyhanni(declaration)) return
                 val hasAnnotation = declaration.annotationEntries.any { it.shortName?.asString() == skyHanniModule }
                 if (hasAnnotation) return
 

CONTRIBUTING.md

@@ -85,7 +85,12 @@ out [their guide](https://github.com/NotEnoughUpdates/NotEnoughUpdates/blob/mast
 
 If you are not very familiar with git, you might want to try this out: https://learngitbranching.js.org/.
 
-_An explanation how to use intellij and branches will follow here soon._
+Proposed changes are better off being in their own branch, you can do this by doing the following from within IntelliJ with the SkyHanni project already open.
+- Click the beta dropdown at the top of IntelliJ
+- Click new branch
+- Give the branch a name relating to the changes you plan to make
+
+_A more in depth explanation how to use intellij and branches will follow here soon._
 
 Please use a prefix for the name of the PR (E.g. Feature, Improvement, Fix, Backend, ...).
 

build.gradle.kts

@@ -9,6 +9,7 @@ import net.fabricmc.loom.task.RunGameTask
 import org.jetbrains.kotlin.gradle.dsl.JvmTarget
 import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 import skyhannibuildsystem.ChangelogVerification
+import skyhannibuildsystem.DownloadBackupRepo
 
 plugins {
     idea
@@ -96,6 +97,12 @@ val headlessLwjgl by configurations.creating {
     isTransitive = false
     isVisible = false
 }
+
+val includeBackupRepo by tasks.registering(DownloadBackupRepo::class) {
+    this.outputDirectory.set(layout.buildDirectory.dir("downloadedRepo"))
+    this.branch = "main"
+}
+
 tasks.runClient {
     this.javaLauncher.set(
         javaToolchains.launcherFor {
@@ -213,6 +220,7 @@ kotlin {
 
 // Tasks:
 tasks.processResources {
+    from(includeBackupRepo)
     inputs.property("version", version)
     filesMatching(listOf("mcmod.info", "fabric.mod.json")) {
         expand("version" to version)
@@ -367,7 +375,7 @@ detekt {
 
 tasks.withType<Detekt>().configureEach {
     onlyIf {
-        false // TODO: Remove onlyIf when we're ready to enforce
+        System.getenv("SKIP_DETEKT") != "true"
     }
 
     reports {

buildSrc/src/main/kotlin/skyhannibuildsystem/DownloadBackupRepo.kt

@@ -0,0 +1,34 @@
+package skyhannibuildsystem
+
+import org.gradle.api.DefaultTask
+import org.gradle.api.file.DirectoryProperty
+import org.gradle.api.tasks.Input
+import org.gradle.api.tasks.Internal
+import org.gradle.api.tasks.OutputDirectory
+import org.gradle.api.tasks.TaskAction
+import java.net.URL
+
+// Code taken from NotEnoughUpdates
+abstract class DownloadBackupRepo : DefaultTask() {
+
+    @get:OutputDirectory
+    abstract val outputDirectory: DirectoryProperty
+
+    @get:Input
+    abstract var branch: String
+
+    @get:Internal
+    val repoFile get() = outputDirectory.get().asFile.resolve("assets/skyhanni/repo.zip")
+
+    @TaskAction
+    fun downloadRepo() {
+        val downloadUrl = URL("https://github.com/hannibal002/SkyHanni-Repo/archive/refs/heads/$branch.zip")
+        val file = repoFile
+        file.parentFile.mkdirs()
+        file.outputStream().use { out ->
+            downloadUrl.openStream().use { inp ->
+                inp.copyTo(out)
+            }
+        }
+    }
+}