Update for 1.18

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -83,7 +83,7 @@ body:
     attributes:
       label: Fawe Version
       description: What version of Fawe are you running? (`/version FastAsyncWorldEdit`)
-      placeholder: "For example: FastAsyncWorldEdit version 1.17-89;8c01959"
+      placeholder: "For example: FastAsyncWorldEdit version 2.0.0-SNAPSHOT-1"
     validations:
       required: true
 

.github/stale.yml

@@ -1,4 +1,4 @@
-daysUntilStale: 60
+daysUntilStale: 30
 daysUntilClose: 7
 only: issues
 exemptLabels:

.github/workflows/build.yml

@@ -1,34 +1,47 @@
-name: "build"
+name: build
 
-on: ["pull_request", "push"]
+on: [pull_request, push]
 
 jobs:
   build:
-    runs-on: "ubuntu-latest"
+    runs-on: ubuntu-latest
     steps:
-      - name: "Checkout Repository"
-        uses: "actions/checkout@v2.3.4"
-      - name : "Validate Gradle Wrapper"
-        uses : "gradle/wrapper-validation-action@v1.0.4"
-      - name: "Grab SHA"
-        uses: "benjlevesque/short-sha@v1.2"
-        id: "short-sha"
+      - name: Checkout Repository
+        uses: actions/checkout@v2.4.0
+      - name : Validate Gradle Wrapper
+        uses : gradle/wrapper-validation-action@v1.0.4
+      - name: Setup Java
+        uses: actions/setup-java@v2.4.0
         with:
-          length: "7"
-      - name: "Echo SHA"    
-        run: "echo $SHA"
+          distribution: temurin
+          cache: gradle
+          java-version: 17
+      - name: Clean Build
+        run: ./gradlew clean build --no-daemon
+      - name: Determine release status
+        if: ${{ runner.os == 'Linux' }}
+        run: |
+          if [ "$(./gradlew properties | awk '/^version:/ { print $2; }' | grep '\-SNAPSHOT')" ]; then
+            echo "STATUS=snapshot" >> $GITHUB_ENV
+          else
+            echo "STATUS=release" >> $GITHUB_ENV
+          fi
+      - name: Publish Release
+        if: ${{ runner.os == 'Linux' && env.STATUS == 'release' && github.event_name == 'push' && github.ref == 'refs/heads/major/2.0.0/1.18'}}
+        run: ./gradlew publishToSonatype closeSonatypeStagingRepository
         env:
-          SHA: "${{ steps.short-sha.outputs.sha }}"
-      - name: "Setup Java"
-        uses: "actions/setup-java@v2.3.1"
-        with:
-          distribution: "temurin"
-          cache: 'gradle'
-          java-version: "17"
-      - name: "Clean Build"
-        run: "./gradlew clean build --no-daemon"
+          ORG_GRADLE_PROJECT_sonatypeUsername: ${{ secrets.SONATYPE_USERNAME }}
+          ORG_GRADLE_PROJECT_sonatypePassword: ${{ secrets.SONATYPE_PASSWORD }}
+          ORG_GRADLE_PROJECT_signingKey: ${{ secrets.SIGNING_KEY }}
+          ORG_GRADLE_PROJECT_signingPassword: ${{ secrets.SIGNING_PASSWORD }}
+      - name: Publish Snapshot
+        if: ${{ runner.os == 'Linux' && env.STATUS != 'release' && github.event_name == 'push' && github.ref == 'refs/heads/major/2.0.0/1.18' }}
+        run: ./gradlew publishToSonatype
+        env:
+          ORG_GRADLE_PROJECT_sonatypeUsername: ${{ secrets.SONATYPE_USERNAME }}
+          ORG_GRADLE_PROJECT_sonatypePassword: ${{ secrets.SONATYPE_PASSWORD }}
       - name: Archive Artifacts
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v2.3.1
         with:
-          name: FastAsyncWorldEdit-Bukkit-1.17-${{ env.SHA }}
-          path: worldedit-bukkit/build/libs/FastAsyncWorldEdit-Bukkit-1.17-${{ env.SHA }}.jar
+          name: FastAsyncWorldEdit-Bukkit-SNAPSHOT
+          path: worldedit-bukkit/build/libs/FastAsyncWorldEdit-Bukkit-*.jar

.github/workflows/rebase.yml

@@ -0,0 +1,20 @@
+name: Rebase Pull Request
+on:
+  issue_comment:
+    types: [created]
+
+jobs:
+  rebase:
+    name: Rebase
+    if: github.event.issue.pull_request != '' && contains(github.event.comment.body, '/rebase') && github.event.comment.author_association == 'MEMBER'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v2.4.0
+        with:
+          token: ${{ secrets.REBASE_TOKEN }}
+          fetch-depth: 0
+      - name: Automatic Rebase
+        uses: cirrus-actions/rebase@1.5
+        env:
+          GITHUB_TOKEN: ${{ secrets.REBASE_TOKEN }}

.github/workflows/release-drafter.yml

@@ -1,14 +1,14 @@
-name: "draft release"
+name: draft release
 
 on:
   push:
     branches:
-      - "2.0.0"
+      - main
 
 jobs:
   update_release_draft:
-    runs-on: "ubuntu-latest"
+    runs-on: ubuntu-latest
     steps:
-      - uses: "release-drafter/release-drafter@v5.15.0"
+      - uses: release-drafter/release-drafter@v5.15.0
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Annotation-Explanation.adoc

@@ -0,0 +1,54 @@
+:toc:
+:toclevels: 2
+
+= Fawe annotations explained
+
+If we have modified parts of the WorldEdit codebase, we considered annotating it with different styles of comments, which
+are explained in this document.
+
+== In-line annotations
+
+[source,java]
+-----------------
+public static Player adapt(com.sk89q.worldedit.entity.Player player) {
+        //FAWE start - Get player from PlayerProxy instead of BukkitPlayer if null
+        player = PlayerProxy.unwrap(player);
+        return player == null ? null : ((BukkitPlayer) player).getPlayer();
+        //FAWE end
+}
+-----------------
+The `-sources` jar retains comments, if you add the FAWE API to your maven or gradle project, you can view differences between the projects with ease.
+Behind the `//FAWE start - ` you can find a comment what has been changed and why it has been changed.
+
+== Block annotations
+
+[source,java]
+-----------------
+//FAWE start
+    @Override
+    public void setPermission(String permission, boolean value) {
+    }
+//FAWE end
+-----------------
+Annotations can cover whole methods or go beyond the method and wrap around several added methods.
+
+== Package annotations
+Class additions are added under the `com.fastasyncworldedit` namespace, but sometimes classes need to be added in package private.
+If that is done, you can find a `package-info.java` file within the package affected that outlines FAWE added classes:
+[source,java]
+-----------------
+/**
+* The following classes are FAWE additions:
+*
+* @see com.sk89q.worldedit.world.block.BlockTypesCache
+*/
+package com.sk89q.worldedit.world.block;
+-----------------
+
+== Undocumented annotations
+Specific changes are not annotated:
+
+* `com.fastasyncworldedit.core.configuration.Caption` in `com.sk89q.worldedit` packages have been changed from
+`com.sk89q.worldedit.util.formatting.text.Text` to allow the usage of color codes for messages.
+
+* Certain Log4J loggers have been adjusted to use the proper format of placeholders.

COMPILING.md

@@ -1,12 +1,12 @@
 Compiling
 =========
 
-You can compile FastAsyncWorldEdit as long as you have some version of Java greater than or equal to 16 installed. Gradle will download JDK 16 specifically if needed,
+You can compile FastAsyncWorldEdit as long as you have some version of Java greater than or equal to 17 installed. Gradle will download JDK 17 specifically if needed,
 but it needs some version of Java to bootstrap from.
 
 Note that if you have JRE 8 installed, Gradle will currently attempt to use that to compile, which will not work. It is easiest to uninstall JRE 8 and replace it with JDK 16.
 
-You can get the JDK 16 [here](https://adoptium.net/).
+You can get the JDK 17 [here](https://adoptium.net/).
 
 The build process uses Gradle, which you do *not* need to download. FastAsyncWorldEdit is a multi-module project with three active modules:
 
@@ -16,10 +16,6 @@ The build process uses Gradle, which you do *not* need to download. FastAsyncWor
 
 ## To compile...
 
-### NMS
-FastAsyncWorldEdit uses NMS (net.minecraft.server) code in a variety of spots. NMS is not distributed via maven and therefore FastAsyncWorldEdit may not build without errors if you didn't install it into your local repository beforehand.
-You can do that by either running Spigot's [BuildTools](https://www.spigotmc.org/wiki/buildtools/) targeting the versions needed or using Paper's [paperclip](https://papermc.io/downloads) with `java -Dpaperclip.install=true -jar paperclip.jar`.
-
 ### On Windows
 
 1. Shift + right-click the folder with FastAsyncWorldEdit's files and click "Open command prompt".
@@ -38,13 +34,13 @@ You will find:
 * FastAsyncWorldEdit for Bukkit in **worldedit-bukkit/build/libs**
 * the CLI version in **worldedit-cli/build/libs**
 
-If you want to use FastAsyncWorldEdit, use the `FastAsyncWorldEdit-1.17-<commitHash>` version obtained in **worldedit-bukkit/build/libs**.
+If you want to use FastAsyncWorldEdit, use the `FastAsyncWorldEdit-<identifier>` version obtained in **worldedit-bukkit/build/libs**.
 
 (The `-#` version includes FastAsyncWorldEdit + necessary libraries.)
 
 ## Other commands
 
-* `gradlew idea` will generate an [IntelliJ IDEA](http://www.jetbrains.com/idea/) module for each folder.
+* `gradlew idea` will generate an [IntelliJ IDEA](https://www.jetbrains.com/idea/) module for each folder.
 
 _Possibly broken_:
 * `gradlew eclipse` will generate an [Eclipse](https://www.eclipse.org/downloads/) project for each folder.

README.md

@@ -12,7 +12,7 @@ FastAsyncWorldEdit is a fork of WorldEdit that has huge speed and memory improve
 * Use it in creative, survival in single player or on your server.
 * Use it on your Minecraft server to fix grieving and mistakes.
 
-Java Edition required. FastAsyncWorldEdit is compatible with Bukkit, Spigot, Paper, and Tuinity.
+Java Edition required. FastAsyncWorldEdit is compatible with Bukkit, Spigot and Paper.
 
 ## Download FastAsyncWorldEdit
 * Spigot: https://www.spigotmc.org/resources/fast-async-worldedit.13932/
@@ -24,8 +24,8 @@ Java Edition required. FastAsyncWorldEdit is compatible with Bukkit, Spigot, Pap
 * [Wiki](https://github.com/IntellectualSites/FastAsyncWorldEdit-Documentation/wiki)
 * [Report Issue](https://github.com/IntellectualSites/FastAsyncWorldEdit/issues)
 * [Crowdin (Translations)](https://intellectualsites.crowdin.com/fastasyncworldedit)
-* [JavaDocs for the -bukkit module](https://ci.athion.net/job/FastAsyncWorldEdit-1.17-Bukkit-Javadocs/javadoc/)
-* [JavaDocs for the -core module](https://ci.athion.net/job/FastAsyncWorldEdit-1.17-Core-Javadocs/javadoc/)
+* [JavaDocs for the -bukkit module](https://javadoc.io/doc/com.fastasyncworldedit/FastAsyncWorldEdit-Bukkit/latest/index.html)
+* [JavaDocs for the -core module](https://javadoc.io/doc/com.fastasyncworldedit/FastAsyncWorldEdit-Core/latest/index.html)
 
 ## Edit The Code
 

build.gradle.kts

@@ -2,6 +2,11 @@ import org.ajoberstar.grgit.Grgit
 import java.time.format.DateTimeFormatter
 import org.gradle.api.tasks.testing.logging.TestExceptionFormat.FULL
 import org.gradle.api.tasks.testing.logging.TestLogEvent.FAILED
+import java.net.URI
+
+plugins {
+    id("io.github.gradle-nexus.publish-plugin") version "1.1.0"
+}
 
 logger.lifecycle("""
 *******************************************
@@ -17,7 +22,8 @@ logger.lifecycle("""
 *******************************************
 """)
 
-var rootVersion by extra("1.17")
+var rootVersion by extra("2.0.0")
+var snapshot by extra("SNAPSHOT")
 var revision: String by extra("")
 var buildNumber by extra("")
 var date: String by extra("")
@@ -27,11 +33,10 @@ ext {
     }
     date = git.head().dateTime.format(DateTimeFormatter.ofPattern("yy.MM.dd"))
     revision = "-${git.head().abbreviatedId}"
-    val commit: String? = git.head().abbreviatedId
     buildNumber = if (project.hasProperty("buildnumber")) {
-        project.properties["buildnumber"] as String
+        snapshot + "-" + project.properties["buildnumber"] as String
     } else {
-        commit.toString()
+        project.properties["snapshot"] as String
     }
 }
 
@@ -66,3 +71,12 @@ allprojects {
 }
 
 applyCommonConfiguration()
+
+nexusPublishing {
+    repositories {
+        sonatype {
+            nexusUrl.set(URI.create("https://s01.oss.sonatype.org/service/local/"))
+            snapshotRepositoryUrl.set(URI.create("https://s01.oss.sonatype.org/content/repositories/snapshots/"))
+        }
+    }
+}

buildSrc/build.gradle.kts

@@ -8,14 +8,17 @@ plugins {
 repositories {
     mavenCentral()
     gradlePluginPortal()
-    maven {
-        name = "PaperMC"
-        url = uri("https://papermc.io/repo/repository/maven-public/")
-    }
     maven {
         name = "EngineHub"
         url = uri("https://maven.enginehub.org/repo/")
     }
+    maven {
+        name = "PaperMC"
+        url = uri("https://papermc.io/repo/repository/maven-public/")
+        content {
+            includeGroupByRegex("io\\.papermc\\..*")
+        }
+    }
 }
 
 val properties = Properties().also { props ->
@@ -28,5 +31,11 @@ dependencies {
     implementation(gradleApi())
     implementation("org.ajoberstar.grgit:grgit-gradle:4.1.1")
     implementation("gradle.plugin.com.github.johnrengelman:shadow:7.1.1")
-    implementation("io.papermc.paperweight.userdev:io.papermc.paperweight.userdev.gradle.plugin:1.1.14")
+    implementation("io.papermc.paperweight.userdev:io.papermc.paperweight.userdev.gradle.plugin:1.3.3")
+}
+
+kotlin {
+    jvmToolchain {
+        (this as JavaToolchainSpec).languageVersion.set(JavaLanguageVersion.of(17))
+    }
 }

buildSrc/src/main/kotlin/AdapterConfig.kt

@@ -5,9 +5,7 @@ import org.gradle.kotlin.dsl.dependencies
 
 // For specific version pinning, see
 // https://papermc.io/repo/service/rest/repository/browse/maven-public/io/papermc/paper/dev-bundle/
-fun Project.applyPaperweightAdapterConfiguration(
-        paperVersion: String
-) {
+fun Project.applyPaperweightAdapterConfiguration() {
     applyCommonConfiguration()
     apply(plugin = "java-library")
     applyCommonJavaConfiguration(
@@ -17,7 +15,6 @@ fun Project.applyPaperweightAdapterConfiguration(
     apply(plugin = "io.papermc.paperweight.userdev")
 
     dependencies {
-        paperDevBundle(paperVersion)
         "implementation"(project(":worldedit-bukkit"))
     }