build.gradle

//file:noinspection SpellCheckingInspection
//file:noinspection GroovyAssignabilityCheck
import com.github.spotbugs.snom.SpotBugsTask
import org.gradle.crypto.checksum.Checksum
buildscript {
    repositories {
        mavenCentral()
    }
}

plugins {
    id 'com.github.johnrengelman.shadow' version '8.1.1'
    id 'net.minecrell.plugin-yml.bukkit' version '0.5.3'
    id "org.cadixdev.licenser" version "0.6.1"
//    id "com.github.sherter.google-java-format" version "0.9"
    id 'xyz.jpenilla.run-paper' version '2.0.1'
//    id "com.github.spotbugs" version "5.0.13"
    id 'com.gorylenko.gradle-git-properties' version '2.4.1'
//    id 'com.palantir.git-version' version '1.0.0'
    id "com.moonlitdoor.git-version" version "0.1.1"

    id 'name.remal.common-ci' version '1.5.0'
      id "com.github.spotbugs" version "5.0.14"
        id "com.diffplug.spotless" version "6.18.0"
    id "de.undercouch.download" version "5.4.0"




    id 'org.gradle.crypto.checksum' version '1.4.0'
    id 'java'
    id 'jacoco'
    id 'idea'
    id 'checkstyle'
    id 'signing'
}

// Thanks BanManager, but your log message is now my property
logger.lifecycle("""
*******************************************
 You are building ${rootProject.name}!
 If you encounter trouble:
 1) Try running 'build' in a separate Gradle run
 2) Use gradlew and not gradle
 3) If you still need help, ask on GitHub/Discord
 Output files will be in /build/libs
*******************************************
""")

apply from: "$rootDir/gradle/jacoco.gradle"
apply from: "$rootDir/gradle/publish.gradle"

if (project.hasProperty("local_script")) {
    apply from: file(local_script + "/build.local.gradle")
}

sourceCompatibility = JavaVersion.VERSION_17
targetCompatibility = JavaVersion.VERSION_17

ext {
    mcVersion = project.property("mcVersion")
}

group project.property("group")
//def details = versionDetails()

spotbugs {
    ignoreFailures = true
    showStackTraces = true
    showProgress = true
    effort = "max"
    reportLevel = 'default'
}


// CI channels will clash if you change the version within build.gradle, this is only for local builds
gitProperties {
    failOnNoGitDirectory = false
    customProperty 'git.mcVersion', { project.property("mcVersion") }
    customProperty 'git.build.time', { new Date().getTime() }
    extProperty = 'gitProps' // git properties will be put in a map at project.ext.gitProps
}
generateGitProperties.outputs.upToDateWhen { false } // make sure the generateGitProperties task always executes (even when git.properties is not changed)


task downloadMultiplePlugins(type: Download) {
    println "Downloading dependent plugins..."
    src([
            'https://github.com/MilkBowl/Vault/releases/download/1.7.3/Vault.jar',
            'https://github.com/Aust1n46/VentureChat/releases/download/v3.5.0/VentureChat-3.5.0.jar',
            'https://github.com/TownyAdvanced/Towny/releases/download/0.98.6.20/towny-0.98.6.20.jar',
            'https://github.com/TownyAdvanced/TownyChat/releases/download/0.103/TownyChat-0.103.jar',
            'https://github.com/TheNewEconomy/TNE-Bukkit/releases/download/TNE-0.1.1.17-PRE-2/TNE-0.1.1.17-PRE-2.jar',
            'https://ci.dmulloy2.net/job/ProtocolLib/lastSuccessfulBuild/artifact/target/ProtocolLib.jar',
            'https://github.com/DiscordSRV/DiscordSRV/releases/download/v1.26.1/DiscordSRV-Build-1.26.1.jar',
            'https://download.luckperms.net/1477/bukkit/loader/LuckPerms-Bukkit-5.4.66.jar',
            // its not a good idea to use lastSuccessfulBuild as it can break due to version numbers changing
            'https://ci.extendedclip.com/job/PlaceholderAPI/173/artifact/build/libs/PlaceholderAPI-2.11.3.jar',
            'https://github.com/ViaVersion/ViaVersion/releases/download/4.6.1/ViaVersion-4.6.1.jar',
            'https://ci.viaversion.com/view/ViaBackwards/job/ViaBackwards/308/artifact/build/libs/ViaBackwards-4.6.2-SNAPSHOT.jar',
    ])
    dest rootDir.relativePath(file('run/plugins'))
}
task downloadPlaceholderExtensions(type: Download) {
    println "Downloading Placeholder Extensions..."
    src([
            'https://api.extendedclip.com/media/PAPI-Expansion-Player_xY7OUz3.jar',
            'https://api.extendedclip.com/media/PAPI-Expansion-Vault_UL8mSu2.jar'
    ])
    dest rootDir.relativePath(file('run/plugins/PlaceholderAPI/expansions'))
}
tasks.downloadMultiplePlugins.dependsOn(tasks.downloadPlaceholderExtensions)
tasks.runServer.dependsOn(tasks.downloadMultiplePlugins)
tasks.runServer.doLast {
    println "(4) after  (run in execution phase as last statement)"
}

tasks.runServer.doFirst {
    println "(3) after  (run in execution phase as FORST statement - before doLast/<<)"
    println "As per the plugin license, agree to respect the license before using these plugins."
    println "What I mean by that is, don't redistribute them, don't claim them as your own, etc."
    println "If you don't agree, you can remove the plugins from the run/plugins folder."
}
ext {
    mcVersion = project.property("mcVersion")
}

// Automatically apply Java versioning conventions and have it comply with Semantic Versioning
// Our versioning scheme is: MAJOR.MINOR.PATCH-QUALIFIER
// MAJOR: Major changes to the plugin, such as a complete rewrite
// MINOR: Minor changes to the plugin, such as new features
// PATCH: Bug fixes
// QUALIFIER: A qualifier to the version, such as alpha, beta, or release candidate
// The version is governed from our CI server, and is automatically incremented.
// The CI should never run this.
if (System.getenv("CI") == null && project.property("DO_NOT_CHANGE_VERSION") != "true") {
    if (version == null || version == "") {
        version = "SNAPSHOT"
    } else if (gitBranchName.contains("alpha") || gitBranchName.contains("beta") || gitBranchName.contains("rc")) {
        version = version + "-SNAPSHOT"
    } else {
            version = version
    }
}
println("Version: " + version)
// The current version based on the most recent tag on the current git branch.
// Doesn't mean anything, just a nice to have.
println("Git Version: " + gitVersion)
println("Branch: " + gitBranchName)
println("Is CI detected? " + System.getenv("CI"))

task generateFiles {
  // Generates some files.
}

task createChecksums(type: Checksum, dependsOn: 'build') {
  inputFiles.setFrom(build)
  checksumAlgorithm.set(Checksum.Algorithm.SHA512)
  appendFileNameToChecksum.set(true)
}

checkstyle {
    // toolVersion '10.6.0'
    // maxWarnings = 0
}


tasks.withType(Checkstyle) {
    reports {
        xml.required = true
        html.required = true
    }
}

tasks.withType(SpotBugsTask) {
   reports {
       xml {
           required.set(true)
       }
       html {
           required.set(true)
       }
   }
}

def gitHubRepo = "https://github.com/BrycensRanch/TownyPlus"

bukkit {

    // Plugin main class (required)
    main = project.property("packageName") + ".TownyPlusMain"

    // API version (should be set for 1.13+)
    apiVersion = project.property("apiVersion")

    // Other possible properties from plugin.yml (optional)
    load = 'POSTWORLD' // or 'POSTWORLD'
    name = project.property("pluginName")
    description = project.property("description")
    depend = ['Towny']
    softDepend = ['DiscordSRV', 'TownyChat', 'VentureChat', 'ProtocolLib', 'PlaceholderAPI']
    defaultPermission = 'NOT_OP' // 'TRUE', 'FALSE', 'OP' or 'NOT_OP'
    website = gitHubRepo
//    commands {
//        test {
//            description = 'This is a test command!'
//            aliases = ['t']
//            permission = 'testplugin.test'
//            usage = 'Just run the command!'
//            // permissionMessage = 'You may not test this command!'
//        }
//        // ...
//    }

//    permissions {
//        'testplugin.*' {
//            children = ['testplugin.test'] // Defaults permissions to true
//            // You can also specify the values of the permissions
//            childrenMap = ['testplugin.test': false]
//        }
//        'testplugin.test' {
//            description = 'Allows you to run the test command'
//            setDefault('OP') // 'TRUE', 'FALSE', 'OP' or 'NOT_OP'
//        }
//    }
}

compileJava {
    options.fork = true
}
publish {
    dependsOn 'clean'
    dependsOn 'build'
    tasks.findByName('build').mustRunAfter 'clean'

}
assemble {
        dependsOn(shadowJar)
}
archivesBaseName = project.property("pluginName")

repositories {
    mavenLocal()
    mavenCentral()
    maven { url = 'https://jitpack.io' }
    maven {
        name = 'm2-dv8tion'
        url = 'https://m2.dv8tion.net/releases'
    }
    maven { url = 'https://hub.spigotmc.org/nexus/content/repositories/snapshots/' }
    maven { url 'https://repo.papermc.io/repository/maven-public/' }
    maven { url = 'https://hub.jeff-media.com/nexus/repository/jeff-media-public/' }
    maven { url = 'https://libraries.minecraft.net/' }
    // This repo is a problem child
//    maven { url = 'https://repo.dmulloy2.net/repository/public/' }
    maven { url = 'https://oss.sonatype.org/content/repositories/snapshots/' }
    maven { url = 'https://repo.spongepowered.org/maven/' }
    maven { url = 'https://nexus.scarsz.me/content/groups/public/' }
    maven { url = 'https://repo.glaremasters.me/repository/towny/'}
    maven { url = 'https://repo.alessiodp.com/releases/' }
    maven { url 'https://repo.extendedclip.com/content/repositories/placeholderapi/' }
}

dependencies {

    // Keep in mind: you can never have too many dependencies!
    // If you're using a dependency that isn't listed here, add it!

    // using spigot-api
    // notice how we arent using bukkit-api. i honestly think the plugin won't work with bukkit-api due to the shitload of opinionated dependencies we use
    compileOnly "org.spigotmc:spigot-api:${mcVersion}-R0.1-SNAPSHOT" // The Spigot API with no shadowing. Requires the OSS repo.
    // or using paper-api
//    compileOnly "io.papermc.paper:paper-api:${mcVersion}-R0.1-SNAPSHOT"

    // Library dependencies mean they're loaded on server boot instead of being in the jar
    //

    // Spigot has inspired me to convert every dependency I use to dynamically load them from Maven Central.
    // I'm sorry.
    // Any dependencies that don't complain about being loaded dynamically shaded into the jar instead.
    // We went from 5MB to 1.4MB, so it's a win-win.

    // Command Handling! https://commandframework.cloud
    library 'cloud.commandframework:cloud-core:1.8.3'
    library 'cloud.commandframework:cloud-annotations:1.8.3'
    annotationProcessor('cloud.commandframework:cloud-annotations:1.8.3')
    library 'cloud.commandframework:cloud-paper:1.8.3'
    library 'cloud.commandframework:cloud-minecraft-extras:1.8.3'
    // Dependency for our way of command handling
    library 'me.lucko:commodore:2.2'

    library 'org.projectlombok:lombok:1.18.26'
    library 'com.fasterxml.jackson.core:jackson-annotations:2.14.2'
    library 'com.fasterxml.jackson.core:jackson-databind:2.14.2'
    // The following is required for the @Command annotation to work, probably...
    // I just got errors without it.
    library 'io.leangen.geantyref:geantyref:1.3.14'
    annotationProcessor('org.projectlombok:lombok:1.18.26')
    annotationProcessor('com.fasterxml.jackson.core:jackson-annotations:2.14.2')
    library 'com.fasterxml.jackson.dataformat:jackson-dataformat-properties:2.14.2'
    library 'com.fasterxml.jackson.dataformat:jackson-dataformat-yaml:2.14.2'
    // For handling multi platform configuration, simply amazing
    // library "org.spongepowered:configurate-yaml:4.1.2"
    // Spigot/GitHub Releases Update checker. Am I that lazy? Yes.
    implementation 'com.jeff_media:SpigotUpdateChecker:3.0.2'
    implementation 'net.byteflux:libby-bukkit:1.1.5'

    // Just a reminder: compileOnly means that we're not shading this dependency into our jar. This is usually when we're using a dependency that is already provided by the server. Aka, when it's already in the server's classpath.
    // implementation means that we're shading this dependency into our jar. This is usually when we're using a dependency that is not provided by the server. Aka, when it's not in the server's classpath.
    // Towny
    compileOnly 'com.palmergames.bukkit.towny:towny:0.99.0.0'
    compileOnly 'com.palmergames.bukkit:TownyChat:0.45'

    // PlaceholderAPI
    compileOnly 'me.clip:placeholderapi:2.11.3'

    // Towny's implementation of CommentedConfiguration, which we use for our config.yml and lang_en.yml
    implementation 'io.github.townyadvanced.commentedconfiguration:CommentedConfiguration:1.0.1'

    // Inventory Framework we use for our GUIs /tplus chest
    compileOnly 'com.github.stefvanschie.inventoryframework:IF:0.10.9'

    // Telemetry
    implementation 'org.bstats:bstats-bukkit:3.0.2'
    // better http server than spark
    library "io.javalin:javalin-bundle:5.4.2"
    // DiscordSRV, optional dependency
    compileOnly 'com.discordsrv:discordsrv:1.24.0'

    // Semver version parsing for auto updating
    library 'com.vdurmont:semver4j:3.1.0'

//    // JDA for DiscordSRV
// Apparently, this is already included in DiscordSRV.
    compileOnly("net.dv8tion:JDA:4.4.0_352.fix-3") {
        exclude module: 'opus-java'
    }
    // VentureChat support for chat listening
    compileOnly("mineverse.aust1n46:venturechat:3.5.0")
    // ProtocolLib (required by venturechat)
    compileOnly "com.comphenix.protocol:ProtocolLib:4.8.0"
   compileOnly 'com.github.spotbugs:spotbugs-annotations:4.7.3'
//    library 'org.hibernate:hibernate-core:5.6.5.Final'

    library 'dev.vankka:mcdiscordreserializer:4.3.0'


    // Database stuff
    library 'com.zaxxer:HikariCP:5.0.1'
    library 'com.h2database:h2:2.1.214'
    library 'org.xerial:sqlite-jdbc:3.41.2.1'
    library 'org.postgresql:postgresql:42.6.0'
//    compileOnly 'org.h2.Driver:Driver:1.4.200'
//    compileOnly 'com.mysql.jdbc.Driver:Driver:8.0.26'

    // Adventure
    library "net.kyori:adventure-api:4.13.0"
    library "net.kyori:adventure-platform-bukkit:4.3.0"
    library "net.kyori:adventure-text-minimessage:4.13.0"
    // Adventure logger that takes advantage of Adventure's text components
    library "net.kyori:adventure-text-logger-slf4j:4.13.0"

    // Test dependencies
   spotbugsPlugins 'com.h3xstream.findsecbugs:findsecbugs-plugin:1.12.0'
//    testCompileOnly 'com.github.spotbugs:spotbugs-annotations:4.7.3'
//    testImplementation("org.projectlombok:lombok:1.18.26")
//    testImplementation("com.fasterxml.jackson.core:jackson-annotations:2.14.2")
//    testImplementation("com.fasterxml.jackson.core:jackson-databind:2.14.2")
//    testImplementation("io.javalin:javalin-bundle:5.3.2")
//    testImplementation 'org.junit.jupiter:junit-jupiter:5.9.2'
//    testImplementation 'org.mockito:mockito-core:5.1.1'
//    testImplementation 'com.github.seeseemelk:MockBukkit-v1.19:2.145.0'
//    testImplementation 'org.assertj:assertj-core:3.24.2'
}
shadowJar {
        archiveClassifier.set("")
        dependencies {
        // These are sorted by internal dependencies to ones for compatability/functionatlity related to other plugins
        // include(dependency('net.kyori::'))
        include(dependency('org.bstats::'))
            include(dependency('net.byteflux::'))
            include(dependency('io.github.townyadvanced.commentedconfiguration::'))
            // include(dependency('com.zaxxer::'))
            // include(dependency('com.h2database::'))
        include(dependency('com.jeff_media::'))
//        include(dependency('me.lucko::'))
//        include(dependency('cloud.commandframework::'))
        // include(dependency('com.palmergames.bukkit::'))
        // include(dependency('com.discordsrv::'))
//        include(dependency('github.scarsz.discordsrv::'))
        // include(dependency('mineverse.aust1n46::'))
        // include(dependency('com.comphenix.protocol::'))
    }
    relocate 'com.jeff_media', "${packageName}.libs.jeff_media"
    relocate 'org.bstats', "${packageName}.libs.bstats"
    relocate 'io.github.townyadvanced.commentedconfiguration', "${packageName}.libs.commentedconfiguration"
    relocate 'com.github.stefvanschie.inventoryframework', "${packageName}.libs.inventoryframework"
    relocate 'net.byteflux', "${packageName}.libs.byteflux"
    // Exclude signatures, maven/ and proguard/ from META-INF
    exclude("META-INF/*.SF")
    exclude("META-INF/*.DSA")
    exclude("META-INF/*.RSA")
    exclude("META-INF/maven/**")
    exclude("META-INF/proguard/**")
}
license {
    include '**/*.java'

    matching('**/*.java') {
        header = file('HEADER.txt')
    }
}

sourcesJar.enabled = true;
tasks.build.dependsOn(shadowJar)
// tasks.test.dependsOn(shadowJar)

runServer {
    // Configure the Minecraft version for our task.
    // This is the only required configuration besides applying the plugin.
    // Your plugin's jar (or shadowJar if present) will be used automatically.
    minecraftVersion(project.property("testServerMCVersion"))
}
processResources {
    project.properties.put("version", version)
    expand project.properties
}

defaultTasks 'build'