diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 02681dd9..bae4e27b 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -1,6 +1,7 @@ -name: build +name: Build on: pull_request: + workflow_dispatch: push: branches: - dev @@ -17,13 +18,18 @@ jobs: with: java-version: 21 distribution: temurin - cache: maven - - name: build - run: mvn install + # Configures gradle with caching + - name: Setup Gradle + uses: gradle/actions/setup-gradle@v4 + # Run "gradlew publish" for origin/dev and "gradlew build" for PRs or elsewhere + - name: Execute Gradle ${{ (github.repository == 'PGMDev/Community' && github.ref == 'refs/heads/dev') && 'Publish' || 'Build' }} + run: ./gradlew ${{ (github.repository == 'PGMDev/Community' && github.ref == 'refs/heads/dev') && 'publish' || 'build' }} + env: + GITHUB_TOKEN: ${{ (github.repository == 'PGMDev/Community' && github.ref == 'refs/heads/dev') && secrets.GITHUB_TOKEN || '' }} - name: artifact uses: actions/upload-artifact@v4 with: name: Community.jar - path: target/Community.jar + path: build/libs/Community.jar if-no-files-found: error diff --git a/.gitignore b/.gitignore index e7064ab4..23f5f830 100644 --- a/.gitignore +++ b/.gitignore @@ -13,7 +13,6 @@ bin/ *.class *.log *.ctxt -*.jar *.war *.nar *.ear @@ -29,3 +28,6 @@ hs_err_pid* .classpath .project .settings +build +.gradle +.DS_Store diff --git a/buildSrc/build.gradle.kts b/buildSrc/build.gradle.kts new file mode 100644 index 00000000..c3f7477d --- /dev/null +++ b/buildSrc/build.gradle.kts @@ -0,0 +1,15 @@ +plugins { + // Support convention plugins written in Kotlin. Convention plugins are build scripts in 'src/main' that automatically become available as plugins in the main build. + `kotlin-dsl` +} + +repositories { + // Use the plugin portal to apply community plugins in convention plugins. + gradlePluginPortal() +} + +dependencies { + implementation("com.gradleup.shadow:shadow-gradle-plugin:8.3.0") + implementation("com.diffplug.spotless:spotless-plugin-gradle:7.0.0.BETA4") + implementation("de.skuzzle.restrictimports:restrict-imports-gradle-plugin:2.6.0") +} diff --git a/buildSrc/src/main/kotlin/buildlogic.java-conventions.gradle.kts b/buildSrc/src/main/kotlin/buildlogic.java-conventions.gradle.kts new file mode 100644 index 00000000..8f7b86a2 --- /dev/null +++ b/buildSrc/src/main/kotlin/buildlogic.java-conventions.gradle.kts @@ -0,0 +1,71 @@ +plugins { + `java-library` + id("com.diffplug.spotless") + id("de.skuzzle.restrictimports") +} + +java { + toolchain { + languageVersion = JavaLanguageVersion.of(21) + } +} + +repositories { + mavenLocal() + mavenCentral() + maven("https://repo.pgm.fyi/snapshots") // Sportpaper & other pgm-specific stuff + maven("https://hub.spigotmc.org/nexus/content/repositories/snapshots/") // Spigot repo + maven("https://repo.aikar.co/content/groups/aikar/") // aikar repo +} + +dependencies { + implementation("tc.oc.pgm:util:0.16-SNAPSHOT") { isTransitive = false } + implementation("com.zaxxer:HikariCP:2.4.1") { isTransitive = false } + implementation("fr.minuskube.inv:smart-invs:1.2.7") { isTransitive = false } + + implementation("redis.clients:jedis:3.5.1") + implementation("co.aikar:idb-core:1.0.0-SNAPSHOT") + implementation("co.aikar:idb-bukkit:1.0.0-SNAPSHOT") + implementation("net.kyori:adventure-api:4.17.0") + implementation("net.kyori:adventure-text-serializer-plain:4.17.0") + implementation("net.kyori:adventure-platform-bukkit:4.3.4") + + compileOnly("app.ashcon:sportpaper:1.8.8-R0.1-SNAPSHOT") + compileOnly("tc.oc.pgm:core:0.16-SNAPSHOT") + compileOnly("tc.oc.occ:AFK:1.0.0-SNAPSHOT") + compileOnly("tc.oc.occ:Environment:1.0.0-SNAPSHOT") + compileOnly("org.incendo:cloud-annotations:2.0.0") + compileOnly("org.jetbrains:annotations:22.0.0") +} + +group = "dev.pgm.community" +version = "0.2-SNAPSHOT" +description = "A plugin for managing a Minecraft community" + +tasks { + withType() { + options.encoding = "UTF-8" + } + withType() { + options.encoding = "UTF-8" + } +} + +spotless { + ratchetFrom = "origin/dev" + java { + removeUnusedImports() + palantirJavaFormat("2.47.0").style("GOOGLE").formatJavadoc(true) + } +} + +restrictImports { + group { + reason = "Use org.jetbrains.annotations to add annotations" + bannedImports = listOf("javax.annotation.**") + } + group { + reason = "Use tc.oc.pgm.util.Assert to add assertions" + bannedImports = listOf("com.google.common.base.Preconditions.**", "java.util.Objects.requireNonNull") + } +} \ No newline at end of file diff --git a/buildSrc/src/main/kotlin/extensions.kt b/buildSrc/src/main/kotlin/extensions.kt new file mode 100644 index 00000000..a173b541 --- /dev/null +++ b/buildSrc/src/main/kotlin/extensions.kt @@ -0,0 +1,16 @@ +import org.gradle.api.Project +import java.io.ByteArrayOutputStream + + +fun Project.latestCommitHash(): String { + return runGitCommand(listOf("rev-parse", "--short", "HEAD")) +} + +fun Project.runGitCommand(args: List): String { + val byteOut = ByteArrayOutputStream() + exec { + commandLine = listOf("git") + args + standardOutput = byteOut + } + return byteOut.toString(Charsets.UTF_8.name()).trim() +} \ No newline at end of file diff --git a/core/build.gradle.kts b/core/build.gradle.kts new file mode 100644 index 00000000..75eeec83 --- /dev/null +++ b/core/build.gradle.kts @@ -0,0 +1,60 @@ +import com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar + +plugins { + id("buildlogic.java-conventions") + `maven-publish` + id("com.gradleup.shadow") +} + +tasks.named("shadowJar") { + archiveFileName = "Community.jar" + archiveClassifier.set("") + destinationDirectory = rootProject.projectDir.resolve("build/libs") + + minimize() + + dependencies { + exclude(dependency("org.jetbrains:annotations")) + } + + exclude("META-INF/**") +} + +publishing { + publications.create("community") { + groupId = project.group as String + artifactId = project.name + version = project.version as String + + artifact(tasks["shadowJar"]) + } + repositories { + maven { + name = "ghPackages" + url = uri("https://maven.pkg.github.com/PGMDev/Community") + credentials { + username = System.getenv("GITHUB_ACTOR") + password = System.getenv("GITHUB_TOKEN") + } + } + } +} + +tasks { + processResources { + filesMatching(listOf("plugin.yml")) { + expand( + "name" to project.name, + "description" to project.description, + "mainClass" to "dev.pgm.community.Community", + "version" to project.version, + "commitHash" to project.latestCommitHash(), + "author" to "applenick", + "url" to "https://pgm.dev/") + } + } + + named("build") { + dependsOn(shadowJar) + } +} \ No newline at end of file diff --git a/core/pom.xml b/core/pom.xml deleted file mode 100644 index 13c5bcb9..00000000 --- a/core/pom.xml +++ /dev/null @@ -1,185 +0,0 @@ - - 4.0.0 - - - ../pom.xml - 0.2-SNAPSHOT - dev.pgm - Community - - - Core - core - jar - - - - - app.ashcon - sportpaper - 1.8.8-R0.1-SNAPSHOT - provided - - - - - tc.oc.pgm - util - 0.16-SNAPSHOT - - - - tc.oc.pgm - core - 0.16-SNAPSHOT - provided - - - - - co.aikar - idb-core - 1.0.0-SNAPSHOT - - - com.zaxxer - HikariCP - 2.4.1 - - - co.aikar - idb-bukkit - 1.0.0-SNAPSHOT - - - - - redis.clients - jedis - 3.5.1 - jar - compile - - - - - fr.minuskube.inv - smart-invs - 1.2.7 - - - - - tc.oc.occ - Environment - 1.0.0-SNAPSHOT - - - - - tc.oc.occ - AFK - 1.0.0-SNAPSHOT - provided - - - - org.jetbrains - annotations - 22.0.0 - provided - - - - org.incendo - cloud-annotations - 2.0.0 - provided - - - - - - Community - - - - ${basedir}/src/main/resources - true - - - - - - org.apache.maven.plugins - maven-compiler-plugin - 3.13.0 - - - - org.incendo - cloud-annotations - 2.0.0-rc.2 - - - - - - org.apache.maven.plugins - maven-shade-plugin - 3.6.0 - - false - true - - - net.kyori:*:* - co.aikar:* - tc.oc.pgm:util - redis.clients:jedis - org.apache.commons:commons-pool2 - fr.minuskube.inv:smart-invs - com.zaxxer:HikariCP - org.slf4j:* - - - - - *:* - - META-INF/** - - - - - - - package - - shade - - - - - - maven-antrun-plugin - 3.1.0 - - - jar - package - - - - - - - run - - - - - - - diff --git a/core/src/main/resources/plugin.yml b/core/src/main/resources/plugin.yml index 72cdcb94..88a00dd5 100644 --- a/core/src/main/resources/plugin.yml +++ b/core/src/main/resources/plugin.yml @@ -1,7 +1,7 @@ name: Community -description: ${project.description} -main: ${project.mainClass} -version: ${project.version} (git-${git.commit.id.abbrev}) -website: ${project.url} -author: ${project.author} +description: ${description} +main: ${mainClass} +version: ${version} (git-${commitHash}) +website: ${url} +author: ${author} softdepend: [PGM, Environment, AFK] diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 00000000..a4b76b95 Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 00000000..9355b415 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,7 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.10-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 00000000..f5feea6d --- /dev/null +++ b/gradlew @@ -0,0 +1,252 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# SPDX-License-Identifier: Apache-2.0 +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s +' "$PWD" ) || exit + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/pom.xml b/pom.xml deleted file mode 100644 index bb2d2c8b..00000000 --- a/pom.xml +++ /dev/null @@ -1,253 +0,0 @@ - - 4.0.0 - dev.pgm - Community - 0.2-SNAPSHOT - Community - A plugin for managing a Minecraft community - https://pgm.dev - pom - - - 21 - 21 - UTF-8 - dev.pgm.community.Community - applenick - - - - core - - - - - pgm.fyi - https://repo.pgm.fyi/snapshots - - - spigot-repo - https://hub.spigotmc.org/nexus/content/repositories/snapshots/ - - - aikar - https://repo.aikar.co/content/groups/aikar/ - - - - - - pgm-repo-snapshots - https://repo.pgm.fyi/snapshots - - - - - - - app.ashcon - sportpaper - 1.8.8-R0.1-SNAPSHOT - provided - - - - - tc.oc.pgm - util - 0.16-SNAPSHOT - - - - tc.oc.pgm - core - 0.16-SNAPSHOT - provided - - - - - co.aikar - idb-core - 1.0.0-SNAPSHOT - - - com.zaxxer - HikariCP - 2.4.1 - - - co.aikar - idb-bukkit - 1.0.0-SNAPSHOT - - - - - redis.clients - jedis - 3.5.1 - jar - compile - - - - - fr.minuskube.inv - smart-invs - 1.2.7 - - - - - tc.oc.occ - Environment - 1.0.0-SNAPSHOT - - - - - tc.oc.occ - AFK - 1.0.0-SNAPSHOT - provided - - - - org.jetbrains - annotations - 22.0.0 - provided - - - - org.incendo - cloud-annotations - 2.0.0 - provided - - - - - - - - org.apache.maven.plugins - maven-compiler-plugin - 3.11.0 - - - - - pl.project13.maven - git-commit-id-plugin - 4.9.10 - - - - revision - - - - - false - false - - - - - - com.diffplug.spotless - spotless-maven-plugin - 2.43.0 - - origin/dev - - - - 2.47.0 - - true - - - - - - - check - - - - - - - org.apache.maven.plugins - maven-enforcer-plugin - 3.2.1 - - - de.skuzzle.enforcer - restrict-imports-enforcer-rule - 2.1.0 - - - - - - enforce-jdk - - enforce - - - - - - [${maven.compiler.target},) - - - - - - - enforce-imports - process-sources - - enforce - - - - - Use org.jetbrains.annotations to add annotations - javax.annotation.** - - - Use tc.oc.pgm.util.Assert to add assertions - - com.google.common.base.Preconditions.** - java.util.Objects.requireNonNull - - - - - - - - - - - org.apache.maven.plugins - maven-javadoc-plugin - 3.5.0 - - false - true - - - - org.apache.maven.plugins - maven-surefire-plugin - 3.1.2 - - - - diff --git a/settings.gradle.kts b/settings.gradle.kts new file mode 100644 index 00000000..f8c25375 --- /dev/null +++ b/settings.gradle.kts @@ -0,0 +1,3 @@ +rootProject.name = "community" + +include(":core")