Enable -Werror for the core module

me4502 · me4502 · commit ac8f8665ee6a · 2026-01-01T21:51:41.000+10:00
diff --git a/build-logic/build.gradle.kts b/build-logic/build.gradle.kts
@@ -15,7 +15,6 @@ dependencies {
     implementation(libs.levelHeadered)
     implementation(libs.shadow)
     implementation(libs.jfrog.buildinfo)
-    implementation(libs.paperweight)
     implementation(libs.gson)
 
     constraints {
diff --git a/build-logic/src/main/kotlin/buildlogic.common-java.gradle.kts b/build-logic/src/main/kotlin/buildlogic.common-java.gradle.kts
@@ -13,14 +13,16 @@ tasks
     .matching { it.name == "compileJava" || it.name == "compileTestJava" }
     .configureEach {
         val disabledLint = listOf(
-            "processing", "path", "fallthrough", "serial", "overloads",
+            "processing", "path", "fallthrough", "serial", "overloads", "this-escape"
         )
         options.release.set(21)
         options.compilerArgs.addAll(listOf("-Xlint:all") + disabledLint.map { "-Xlint:-$it" })
         options.isDeprecation = true
         options.encoding = "UTF-8"
         options.compilerArgs.add("-parameters")
-//        options.compilerArgs.add("-Werror")
+        if (project.name.contains("-core")) {
+            options.compilerArgs.add("-Werror")
+        }
     }
 
 configure<CheckstyleExtension> {
@@ -50,7 +52,9 @@ dependencies {
 tasks.withType<Javadoc>().configureEach {
     options.encoding = "UTF-8"
     (options as StandardJavadocDocletOptions).apply {
-//        addBooleanOption("Werror", true)
+        if (project.name.contains("-core")) {
+            addBooleanOption("Werror", true)
+        }
         addBooleanOption("Xdoclint:all", true)
         addBooleanOption("Xdoclint:-missing", true)
         tags(
diff --git a/craftbook-bukkit/src/main/java/org/enginehub/craftbook/bukkit/BukkitCraftBookPlatform.java b/craftbook-bukkit/src/main/java/org/enginehub/craftbook/bukkit/BukkitCraftBookPlatform.java
@@ -48,6 +48,7 @@
 import org.enginehub.craftbook.util.profile.resolver.ProfileService;
 import org.enginehub.craftbook.util.report.ReportFlag;
 import org.enginehub.piston.CommandManager;
+import org.jspecify.annotations.Nullable;
 
 import java.nio.file.Path;
 import java.util.ArrayList;
@@ -61,7 +62,7 @@ public class BukkitCraftBookPlatform implements CraftBookPlatform {
 
     private final MechanicManager mechanicManager = new BukkitMechanicManager();
     private YamlConfiguration config;
-    private String version;
+    private @Nullable String version;
 
     /**
      * The manager for SelfTriggering components.
diff --git a/craftbook-bukkit/src/main/java/org/enginehub/craftbook/bukkit/mechanics/piston/BukkitBetterPistons.java b/craftbook-bukkit/src/main/java/org/enginehub/craftbook/bukkit/mechanics/piston/BukkitBetterPistons.java
@@ -189,7 +189,7 @@ public void onPistonExtend(BlockPistonExtendEvent event) {
                 continue;
             }
 
-            BlockFace facing = SignUtil.getFacing(event.getBlock().getRelative(face));
+            BlockFace facing = SignUtil.getBack(event.getBlock().getRelative(face));
 
             // Only care if it faces the piston
             if (face != BlockFace.UP
@@ -216,7 +216,7 @@ public void onPistonExtend(BlockPistonExtendEvent event) {
                         }
                     }
                 }
-            } while (SignUtil.isSign(sign.getRelative(face)) && SignUtil.getFacing(sign) == facing);
+            } while (SignUtil.isSign(sign.getRelative(face)) && SignUtil.getBack(sign) == facing);
         }
     }
 
@@ -242,7 +242,7 @@ public void onPistonRetract(BlockPistonRetractEvent event) {
                 continue;
             }
 
-            BlockFace facing = SignUtil.getFacing(event.getBlock().getRelative(face));
+            BlockFace facing = SignUtil.getBack(event.getBlock().getRelative(face));
 
             // Only care if it faces the piston
             if (face != BlockFace.UP
@@ -267,7 +267,7 @@ public void onPistonRetract(BlockPistonRetractEvent event) {
                 }
 
 
-            } while (SignUtil.isSign(sign.getRelative(face)) && SignUtil.getFacing(sign) == facing);
+            } while (SignUtil.isSign(sign.getRelative(face)) && SignUtil.getBack(sign) == facing);
         }
     }
 
diff --git a/craftbook-bukkit/src/main/java/org/enginehub/craftbook/mechanics/ic/gates/world/blocks/SetBridge.java b/craftbook-bukkit/src/main/java/org/enginehub/craftbook/mechanics/ic/gates/world/blocks/SetBridge.java
@@ -59,7 +59,7 @@ public SetBridge(Server server, ChangedSign block, ICFactory factory) {
     @Override
     public void load() {
         center = getBackBlock();
-        faceing = SignUtil.getFacing(getSign().getBlock());
+        faceing = SignUtil.getBack(getSign().getBlock());
         String line = getLine(2);
         if (!line.isEmpty()) {
             String[] split = RegexUtil.MINUS_PATTERN.split(line);
diff --git a/craftbook-bukkit/src/main/java/org/enginehub/craftbook/mechanics/ic/gates/world/blocks/SetDoor.java b/craftbook-bukkit/src/main/java/org/enginehub/craftbook/mechanics/ic/gates/world/blocks/SetDoor.java
@@ -59,7 +59,7 @@ public SetDoor(Server server, ChangedSign block, ICFactory factory) {
     @Override
     public void load() {
 
-        faceing = SignUtil.getFacing(getSign().getBlock());
+        faceing = SignUtil.getBack(getSign().getBlock());
         String line = getLine(2);
         if (!line.isEmpty()) {
             String[] split = RegexUtil.MINUS_PATTERN.split(line);
diff --git a/craftbook-bukkit/src/main/java/org/enginehub/craftbook/mechanics/minecart/blocks/CartReverser.java b/craftbook-bukkit/src/main/java/org/enginehub/craftbook/mechanics/minecart/blocks/CartReverser.java
@@ -51,7 +51,7 @@ public void onVehicleImpact(CartBlockImpactEvent event) {
             return;
         }
 
-        BlockFace dir = SignUtil.getFacing(event.getBlocks().sign());
+        BlockFace dir = SignUtil.getBack(event.getBlocks().sign());
 
         Vector normalVelocity = event.getMinecart().getVelocity().normalize();
 
diff --git a/craftbook-bukkit/src/main/java/org/enginehub/craftbook/util/LocationUtil.java b/craftbook-bukkit/src/main/java/org/enginehub/craftbook/util/LocationUtil.java
@@ -86,7 +86,7 @@ public static boolean isWithinRadius(Location l1, Location l2, Vector3 radius) {
     public static Block getRelativeOffset(Block sign, int offsetX, int offsetY, int offsetZ) {
 
         return getRelativeOffset(SignUtil.getBackBlock(sign),
-            SignUtil.getFacing(sign),
+            SignUtil.getBack(sign),
             offsetX, offsetY, offsetZ);
     }
 
diff --git a/craftbook-bukkit/src/main/java/org/enginehub/craftbook/util/SignUtil.java b/craftbook-bukkit/src/main/java/org/enginehub/craftbook/util/SignUtil.java
@@ -63,31 +63,14 @@ public static boolean isWallSign(Material type) {
         return Tag.WALL_SIGNS.isTagged(type);
     }
 
-    /**
-     * Get the back of the sign, the block that it is attached to.
-     *
-     * @param sign treated as sign post if it is such, or else assumed to be a wall sign (i.e.,
-     *     if you ask about a stone block, it's considered a wall
-     *     sign).
-     * @return the direction a player would be facing when reading the sign; i.e. the face that is
-     *     actually the back
-     *     side of the sign.
-     * @deprecated confusing, should use getBack or getFront explicitly
-     */
-    @Deprecated
-    public static BlockFace getFacing(Block sign) {
-        return getBack(sign);
-    }
-
     /**
      * Get the front face of the sign.
      *
      * @param sign treated as sign post if it is such, or else assumed to be a wall sign (i.e.,
      *     if you ask about a stone block, it's considered a wall
      *     sign).
      * @return the side of the sign containing the text (in other words, when a player places a new
-     *     sign,
-     *     while facing north, this will return south).
+     *     sign, while facing north, this will return south).
      */
     public static BlockFace getFront(Block sign) {
         BlockData blockData = sign.getBlockData();
@@ -112,9 +95,7 @@ public static Block getFrontBlock(Block sign) {
      *     sign).
      * @return the blank side of the sign opposite the text. In the case of a wall sign,
      *     the block in this direction is the block to which the sign is
-     *     attached. This is also the direction a player would be facing when reading the sign; see
-     *     {@link
-     *     #getFacing(Block)}.
+     *     attached. This is also the direction a player would be facing when reading the sign.
      */
     public static BlockFace getBack(Block sign) {
         return getFront(sign).getOppositeFace();
diff --git a/craftbook-core/src/main/java/org/enginehub/craftbook/AbstractCraftBookMechanic.java b/craftbook-core/src/main/java/org/enginehub/craftbook/AbstractCraftBookMechanic.java
@@ -20,9 +20,9 @@
 import org.enginehub.craftbook.mechanic.CraftBookMechanic;
 import org.enginehub.craftbook.mechanic.MechanicType;
 
-import java.io.File;
 import java.io.FileNotFoundException;
 import java.io.IOException;
+import java.nio.file.Path;
 
 public abstract class AbstractCraftBookMechanic implements CraftBookMechanic {
 
@@ -37,7 +37,7 @@ public MechanicType<? extends CraftBookMechanic> getMechanicType() {
     }
 
     @Override
-    public void loadConfiguration(File configFile) {
+    public void loadConfiguration(Path configFile) {
         YAMLProcessor mechanicConfig = new YAMLProcessor(configFile, true, YAMLFormat.EXTENDED);
 
         try {
diff --git a/craftbook-core/src/main/java/org/enginehub/craftbook/CraftBookManifest.java b/craftbook-core/src/main/java/org/enginehub/craftbook/CraftBookManifest.java
@@ -20,6 +20,7 @@
 import java.io.IOException;
 import java.io.UncheckedIOException;
 import java.net.JarURLConnection;
+import java.net.URI;
 import java.net.URL;
 import java.util.function.Supplier;
 import java.util.jar.Attributes;
@@ -48,7 +49,7 @@ public static CraftBookManifest load() {
         }
 
         try {
-            URL url = new URL(classPath);
+            URL url = URI.create(classPath).toURL();
             JarURLConnection jarConnection = (JarURLConnection) url.openConnection();
             Manifest manifest = jarConnection.getManifest();
             return manifest.getMainAttributes();
diff --git a/craftbook-core/src/main/java/org/enginehub/craftbook/mechanic/CraftBookMechanic.java b/craftbook-core/src/main/java/org/enginehub/craftbook/mechanic/CraftBookMechanic.java
@@ -19,7 +19,7 @@
 import org.enginehub.craftbook.CraftBook;
 import org.enginehub.craftbook.mechanic.exception.MechanicInitializationException;
 
-import java.io.File;
+import java.nio.file.Path;
 
 /**
  * Represents a CraftBook Mechanic.
@@ -62,7 +62,7 @@ default void reload() throws MechanicInitializationException {
      *
      * @param configFile The configuration file
      */
-    void loadConfiguration(File configFile);
+    void loadConfiguration(Path configFile);
 
     /**
      * Load config values from the given YAMLProcessor.
diff --git a/craftbook-core/src/main/java/org/enginehub/craftbook/mechanic/MechanicManager.java b/craftbook-core/src/main/java/org/enginehub/craftbook/mechanic/MechanicManager.java
@@ -27,7 +27,6 @@
 import org.enginehub.craftbook.mechanic.load.UnsatisfiedLoadDependencyException;
 import org.jspecify.annotations.Nullable;
 
-import java.io.File;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Optional;
@@ -141,7 +140,7 @@ public void enableMechanic(MechanicType<?> mechanicType) throws MechanicInitiali
                 mech = mechanicType.getMechanicClass().getDeclaredConstructor().newInstance();
             }
 
-            mech.loadConfiguration(new File(CraftBook.getInstance().getPlatform().getWorkingDirectory().resolve("mechanics").toFile(), mechanicType.getName() + ".yml"));
+            mech.loadConfiguration(CraftBook.getInstance().getPlatform().getWorkingDirectory().resolve("mechanics").resolve(mechanicType.getName() + ".yml"));
             mech.enable();
 
             loadedMechanics.add(mech);
@@ -208,7 +207,7 @@ public boolean disableMechanic(@Nullable CraftBookMechanic mechanic) {
     public void reloadMechanic(CraftBookMechanic mechanic) throws MechanicInitializationException {
         MechanicType<?> mechanicType = mechanic.getMechanicType();
         try {
-            mechanic.loadConfiguration(new File(CraftBook.getInstance().getPlatform().getWorkingDirectory().resolve("mechanics").toFile(), mechanicType.getName() + ".yml"));
+            mechanic.loadConfiguration(CraftBook.getInstance().getPlatform().getWorkingDirectory().resolve("mechanics").resolve(mechanicType.getName() + ".yml"));
             mechanic.reload();
         } catch (MechanicInitializationException e) {
             // Re-throw
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -15,18 +15,14 @@ lang-version = "1604"
 [libraries]
 
 levelHeadered = "net.octyl.level-headered:plugin:0.1.2"
-grgit = "org.ajoberstar.grgit:grgit-gradle:5.2.2"
 shadow = "com.gradleup.shadow:com.gradleup.shadow.gradle.plugin:8.3.9"
 jfrog-buildinfo = "org.jfrog.buildinfo:build-info-extractor-gradle:5.2.0"
 
-paperweight = "io.papermc.paperweight.userdev:io.papermc.paperweight.userdev.gradle.plugin:1.7.1"
-
 squirrelid = "org.enginehub:squirrelid:0.3.2"
 
 autoService = "com.google.auto.service:auto-service:1.1.1"
 
-jspecify = "org.jspecify:jspecify:0.3.0"
-jetbrains-annotations = "org.jetbrains:annotations:24.1.0"
+jspecify = "org.jspecify:jspecify:1.0.0"
 
 junit-bom = "org.junit:junit-bom:6.0.1"
 junit-jupiter-api.module = "org.junit.jupiter:junit-jupiter-api"

Original file line number	Diff line number	Diff line change
`@@ -189,7 +189,7 @@ public void onPistonExtend(BlockPistonExtendEvent event) {`
`189`	`189`	`continue;`
`190`	`190`	`}`
`191`	`191`
`192`		`- BlockFace facing = SignUtil.getFacing(event.getBlock().getRelative(face));`
	`192`	`+ BlockFace facing = SignUtil.getBack(event.getBlock().getRelative(face));`
`193`	`193`
`194`	`194`	`// Only care if it faces the piston`
`195`	`195`	`if (face != BlockFace.UP`
`@@ -216,7 +216,7 @@ public void onPistonExtend(BlockPistonExtendEvent event) {`
`216`	`216`	`}`
`217`	`217`	`}`
`218`	`218`	`}`
`219`		`- } while (SignUtil.isSign(sign.getRelative(face)) && SignUtil.getFacing(sign) == facing);`
	`219`	`+ } while (SignUtil.isSign(sign.getRelative(face)) && SignUtil.getBack(sign) == facing);`
`220`	`220`	`}`
`221`	`221`	`}`
`222`	`222`
`@@ -242,7 +242,7 @@ public void onPistonRetract(BlockPistonRetractEvent event) {`
`242`	`242`	`continue;`
`243`	`243`	`}`
`244`	`244`
`245`		`- BlockFace facing = SignUtil.getFacing(event.getBlock().getRelative(face));`
	`245`	`+ BlockFace facing = SignUtil.getBack(event.getBlock().getRelative(face));`
`246`	`246`
`247`	`247`	`// Only care if it faces the piston`
`248`	`248`	`if (face != BlockFace.UP`
`@@ -267,7 +267,7 @@ public void onPistonRetract(BlockPistonRetractEvent event) {`
`267`	`267`	`}`
`268`	`268`
`269`	`269`
`270`		`- } while (SignUtil.isSign(sign.getRelative(face)) && SignUtil.getFacing(sign) == facing);`
	`270`	`+ } while (SignUtil.isSign(sign.getRelative(face)) && SignUtil.getBack(sign) == facing);`
`271`	`271`	`}`
`272`	`272`	`}`
`273`	`273`
Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ public void onVehicleImpact(CartBlockImpactEvent event) {`
`51`	`51`	`return;`
`52`	`52`	`}`
`53`	`53`
`54`		`- BlockFace dir = SignUtil.getFacing(event.getBlocks().sign());`
	`54`	`+ BlockFace dir = SignUtil.getBack(event.getBlocks().sign());`
`55`	`55`
`56`	`56`	`Vector normalVelocity = event.getMinecart().getVelocity().normalize();`
`57`	`57`
Original file line number	Diff line number	Diff line change
`@@ -86,7 +86,7 @@ public static boolean isWithinRadius(Location l1, Location l2, Vector3 radius) {`
`86`	`86`	`public static Block getRelativeOffset(Block sign, int offsetX, int offsetY, int offsetZ) {`
`87`	`87`
`88`	`88`	`return getRelativeOffset(SignUtil.getBackBlock(sign),`
`89`		`- SignUtil.getFacing(sign),`
	`89`	`+ SignUtil.getBack(sign),`
`90`	`90`	`offsetX, offsetY, offsetZ);`
`91`	`91`	`}`
`92`	`92`