feat: add module-info.java to all modules

Strokkur424 · kezz · commit 6087c88b5046 · 2025-10-10T14:44:25.000+01:00
diff --git a/api/build.gradle.kts b/api/build.gradle.kts
@@ -14,6 +14,7 @@ dependencies {
   api(libs.examination.api)
   api(libs.examination.string)
   compileOnlyApi(libs.jetbrainsAnnotations)
+  compileOnlyApi(libs.jspecify)
   testImplementation(libs.guava)
   annotationProcessor(projects.adventureAnnotationProcessors)
   testCompileOnly(libs.autoService.annotations)
diff --git a/api/src/main/java/module-info.java b/api/src/main/java/module-info.java
@@ -0,0 +1,38 @@
+import org.jspecify.annotations.NullMarked;
+
+/**
+ * Adventure: a serverside user interface library for Minecraft: Java Edition.
+ *
+ * <p>See the <a href="https://docs.papermc.io/adventure/">documentation</a>
+ * for usage and dependency information for this project and associated libraries.</p>
+ */
+@NullMarked
+module net.kyori.adventure.api {
+  requires transitive net.kyori.adventure.key;
+  requires transitive static org.jspecify;
+
+  exports net.kyori.adventure;
+  exports net.kyori.adventure.audience;
+  exports net.kyori.adventure.bossbar;
+  exports net.kyori.adventure.builder;
+  exports net.kyori.adventure.chat;
+  exports net.kyori.adventure.dialog;
+  exports net.kyori.adventure.identity;
+  exports net.kyori.adventure.internal;
+  exports net.kyori.adventure.inventory;
+  exports net.kyori.adventure.nbt.api;
+  exports net.kyori.adventure.permission;
+  exports net.kyori.adventure.pointer;
+  exports net.kyori.adventure.resource;
+  exports net.kyori.adventure.sound;
+  exports net.kyori.adventure.text;
+  exports net.kyori.adventure.text.event;
+  exports net.kyori.adventure.text.flattener;
+  exports net.kyori.adventure.text.format;
+  exports net.kyori.adventure.text.object;
+  exports net.kyori.adventure.text.renderer;
+  exports net.kyori.adventure.text.serializer;
+  exports net.kyori.adventure.title;
+  exports net.kyori.adventure.translation;
+  exports net.kyori.adventure.util;
+}
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -24,6 +24,7 @@ option = { module = "net.kyori:option", version = "1.1.0" }
 guava = { module = "com.google.guava:guava", version.ref = "guava" }
 guava-testlib = { module = "com.google.guava:guava-testlib", version.ref = "guava" }
 jetbrainsAnnotations = "org.jetbrains:annotations:26.0.2-1"
+jspecify = "org.jspecify:jspecify:1.0.0"
 
 # extra-kotlin
 kotlin-stdlib = { module = "org.jetbrains.kotlin:kotlin-stdlib-jdk8" }
diff --git a/key/build.gradle.kts b/key/build.gradle.kts
@@ -12,6 +12,7 @@ dependencies {
   api(libs.examination.api)
   api(libs.examination.string)
   compileOnlyApi(libs.jetbrainsAnnotations)
+  compileOnlyApi(libs.jspecify)
   testImplementation(libs.guava)
 }
 
diff --git a/key/src/main/java/module-info.java b/key/src/main/java/module-info.java
@@ -0,0 +1,12 @@
+import org.jspecify.annotations.NullMarked;
+
+/**
+ * A reference composed of a namespace and a path.
+ */
+@NullMarked
+module net.kyori.adventure.key {
+  requires transitive net.kyori.examination.string;
+  requires static org.jspecify;
+
+  exports net.kyori.adventure.key;
+}
diff --git a/nbt/build.gradle.kts b/nbt/build.gradle.kts
@@ -6,6 +6,7 @@ dependencies {
   api(libs.examination.api)
   api(libs.examination.string)
   compileOnlyApi(libs.jetbrainsAnnotations)
+  compileOnlyApi(libs.jspecify)
 }
 
 applyJarMetadata("net.kyori.adventure.nbt")
diff --git a/nbt/src/main/java/module-info.java b/nbt/src/main/java/module-info.java
@@ -0,0 +1,15 @@
+import org.jspecify.annotations.NullMarked;
+
+/**
+ * An implementation of the <a href="https://wiki.vg/NBT">NBT</a> format.
+ *
+ * <p>Adventure supports serializing to both binary and string representations
+ * of the tags, both through {@link net.kyori.adventure.nbt.BinaryTagIO}</p>
+ */
+@NullMarked
+module net.kyori.adventure.nbt {
+  requires transitive net.kyori.examination.string;
+  requires static org.jspecify;
+
+  exports net.kyori.adventure.nbt;
+}
diff --git a/serializer-configurate4/src/main/java/module-info.java b/serializer-configurate4/src/main/java/module-info.java
@@ -0,0 +1,15 @@
+import org.jspecify.annotations.NullMarked;
+
+/**
+ * Serializers for Configurate 4.
+ */
+@NullMarked
+module net.kyori.adventure.serializer.configurate4 {
+  requires transitive net.kyori.adventure.api;
+  requires net.kyori.adventure.text.serializer.commons;
+  requires io.leangen.geantyref;
+  requires org.spongepowered.configurate;
+  requires static org.checkerframework.checker.qual;
+
+  exports net.kyori.adventure.serializer.configurate4;
+}
diff --git a/text-logger-slf4j/src/main/java/module-info.java b/text-logger-slf4j/src/main/java/module-info.java
@@ -0,0 +1,14 @@
+import org.jspecify.annotations.NullMarked;
+
+/**
+ * A wrapper around <a href="https://slf4j.org">SLF4J</a> providing methods for formatted logging of Components.
+ *
+ * <p>This wrapper supports the API provided in 1.7/1.8, but does not yet implement the fluent API present in the 2.0 betas.</p>
+ */
+@NullMarked
+module net.kyori.adventure.text.logger.slf4j {
+  requires transitive net.kyori.adventure.api;
+  requires transitive org.slf4j;
+
+  exports net.kyori.adventure.text.logger.slf4j;
+}
diff --git a/text-minimessage/src/main/java/module-info.java b/text-minimessage/src/main/java/module-info.java
@@ -0,0 +1,16 @@
+import org.jspecify.annotations.NullMarked;
+
+/**
+ * MiniMessage, a friendly text format for representing chat components.
+ *
+ * @see <a href="https://docs.papermc.io/adventure/minimessage/format">Format Documentation</a>
+ */
+@NullMarked
+module net.kyori.adventure.text.minimessage {
+  requires transitive net.kyori.adventure.api;
+
+  exports net.kyori.adventure.text.minimessage;
+  exports net.kyori.adventure.text.minimessage.tag;
+  exports net.kyori.adventure.text.minimessage.translation;
+  exports net.kyori.adventure.text.minimessage.tree;
+}
diff --git a/text-minimessage/src/main/java/net/kyori/adventure/text/minimessage/ParsingException.java b/text-minimessage/src/main/java/net/kyori/adventure/text/minimessage/ParsingException.java
@@ -23,12 +23,11 @@
  */
 package net.kyori.adventure.text.minimessage;
 
+import java.io.Serial;
 import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
-import java.io.Serial;
-
 /**
  * An exception thrown when an error occurs while parsing a MiniMessage string.
  *
diff --git a/text-minimessage/src/main/java/net/kyori/adventure/text/minimessage/tag/ResetParserDirective.java b/text-minimessage/src/main/java/net/kyori/adventure/text/minimessage/tag/ResetParserDirective.java
@@ -1,3 +1,26 @@
+/*
+ * This file is part of adventure, licensed under the MIT License.
+ *
+ * Copyright (c) 2017-2025 KyoriPowered
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
 package net.kyori.adventure.text.minimessage.tag;
 
 final class ResetParserDirective implements ParserDirective {
diff --git a/text-minimessage/src/main/java/net/kyori/adventure/text/minimessage/tag/resolver/ArgumentQueue.java b/text-minimessage/src/main/java/net/kyori/adventure/text/minimessage/tag/resolver/ArgumentQueue.java
@@ -24,7 +24,6 @@
 package net.kyori.adventure.text.minimessage.tag.resolver;
 
 import java.util.function.Supplier;
-
 import net.kyori.adventure.text.minimessage.ArgumentQueueImpl;
 import net.kyori.adventure.text.minimessage.tag.Tag;
 import org.jetbrains.annotations.ApiStatus;
diff --git a/text-minimessage/src/main/java/net/kyori/adventure/text/minimessage/tree/Node.java b/text-minimessage/src/main/java/net/kyori/adventure/text/minimessage/tree/Node.java
@@ -24,7 +24,6 @@
 package net.kyori.adventure.text.minimessage.tree;
 
 import java.util.List;
-
 import net.kyori.adventure.text.minimessage.internal.parser.node.ElementNode;
 import net.kyori.adventure.text.minimessage.internal.parser.node.RootNode;
 import org.jetbrains.annotations.ApiStatus;
diff --git a/text-serializer-ansi/src/main/java/module-info.java b/text-serializer-ansi/src/main/java/module-info.java
@@ -0,0 +1,12 @@
+import org.jspecify.annotations.NullMarked;
+
+/**
+ * Serialization to ANSI escape sequences. Does not support deserialization.
+ */
+@NullMarked
+module net.kyori.adventure.text.serializer.ansi {
+  requires transitive net.kyori.adventure.api;
+  requires transitive net.kyori.ansi;
+
+  exports net.kyori.adventure.text.serializer.ansi;
+}
diff --git a/text-serializer-commons/src/main/java/module-info.java b/text-serializer-commons/src/main/java/module-info.java
@@ -0,0 +1,8 @@
+/**
+ * Constants useful for creating any component serializer following the vanilla tree structure.
+ */
+module net.kyori.adventure.text.serializer.commons {
+  requires transitive static org.jetbrains.annotations;
+
+  exports net.kyori.adventure.text.serializer.commons;
+}
diff --git a/text-serializer-gson/src/main/java/module-info.java b/text-serializer-gson/src/main/java/module-info.java
@@ -0,0 +1,14 @@
+import org.jspecify.annotations.NullMarked;
+
+/**
+ * Gson based serialization and deserialization.
+ */
+@NullMarked
+module net.kyori.adventure.text.serializer.gson {
+  requires transitive net.kyori.adventure.text.serializer.json;
+  requires gson;
+  requires net.kyori.adventure.text.serializer.commons;
+  requires static com.google.auto.service;
+
+  exports net.kyori.adventure.text.serializer.gson;
+}
diff --git a/text-serializer-json-legacy-impl/src/main/java/module-info.java b/text-serializer-json-legacy-impl/src/main/java/module-info.java
@@ -0,0 +1,14 @@
+import org.jspecify.annotations.NullMarked;
+
+/**
+ * JSON legacy hover event serialization and deserialization.
+ *
+ * <p>This is a replacement for the old {@code adventure-text-serializer-gson-legacyimpl} module.</p>
+ */
+@NullMarked
+module net.kyori.adventure.text.serializer.json.legacyimpl {
+  requires transitive net.kyori.adventure.text.serializer.json;
+  requires net.kyori.adventure.nbt;
+
+  exports net.kyori.adventure.text.serializer.json.legacyimpl;
+}
diff --git a/text-serializer-json/src/main/java/module-info.java b/text-serializer-json/src/main/java/module-info.java
@@ -0,0 +1,12 @@
+import org.jspecify.annotations.NullMarked;
+
+/**
+ * A common abstraction providing an API to serializer components with multiple JSON libraries.
+ */
+@NullMarked
+module net.kyori.adventure.text.serializer.json {
+  requires transitive net.kyori.adventure.api;
+  requires transitive net.kyori.option;
+
+  exports net.kyori.adventure.text.serializer.json;
+}
diff --git a/text-serializer-legacy/src/main/java/module-info.java b/text-serializer-legacy/src/main/java/module-info.java
@@ -0,0 +1,11 @@
+import org.jspecify.annotations.NullMarked;
+
+/**
+ * Legacy text based serialization and deserialization.
+ */
+@NullMarked
+module net.kyori.adventure.text.serializer.legacy {
+  requires transitive net.kyori.adventure.api;
+
+  exports net.kyori.adventure.text.serializer.legacy;
+}
diff --git a/text-serializer-plain/src/main/java/module-info.java b/text-serializer-plain/src/main/java/module-info.java
@@ -0,0 +1,11 @@
+import org.jspecify.annotations.NullMarked;
+
+/**
+ * Plain text based serialization and deserialization.
+ */
+@NullMarked
+module net.kyori.adventure.text.serializer.plain {
+  requires transitive net.kyori.adventure.api;
+
+  exports net.kyori.adventure.text.serializer.plain;
+}

Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@ dependencies {`
`12`	`12`	`api(libs.examination.api)`
`13`	`13`	`api(libs.examination.string)`
`14`	`14`	`compileOnlyApi(libs.jetbrainsAnnotations)`
	`15`	`+ compileOnlyApi(libs.jspecify)`
`15`	`16`	`testImplementation(libs.guava)`
`16`	`17`	`}`
`17`	`18`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@ dependencies {`
`6`	`6`	`api(libs.examination.api)`
`7`	`7`	`api(libs.examination.string)`
`8`	`8`	`compileOnlyApi(libs.jetbrainsAnnotations)`
	`9`	`+ compileOnlyApi(libs.jspecify)`
`9`	`10`	`}`
`10`	`11`
`11`	`12`	`applyJarMetadata("net.kyori.adventure.nbt")`