Use translation keys instead of literal messages

Updated test toolkit's MockBukkit version to include MockBukkit/MockBukkit#1077, which allows accessing Minecraft Language codes. Moved utilities for creating mock argument parsers into ArgumentUtilities class. Made example project build script run maven tests, so the tests in the `automated-tests` and `automated-tests-shaded` example projects are run by GitHub Actions.
CommandAPI · JorelAli · Dec 4, 2024 · Oct 28, 2024 · Jul 4, 2024 · Jul 5, 2024
commit 3b7449960a65c49f0b9dd315cb440d7ae2972bc3
diff --git a/commandapi-platforms/commandapi-bukkit/commandapi-bukkit-test-toolkit/pom.xml b/commandapi-platforms/commandapi-bukkit/commandapi-bukkit-test-toolkit/pom.xml
@@ -33,8 +33,8 @@
 		<!-- Compatibility with MockBukkit API -->
 		<dependency>
 			<groupId>com.github.seeseemelk</groupId>
-			<artifactId>MockBukkit-v1.20</artifactId>
-			<version>3.9.0</version>
+			<artifactId>MockBukkit-v1.21</artifactId>
+			<version>3.120.4</version>
 			<scope>provided</scope>
 		</dependency>
 
@@ -89,10 +89,12 @@
 		</dependency>
 
 		<!-- Run our own tests with JUnit API -->
+		<!-- Note: This version matches the artifactId `junit-jupiter` dependency transitively inherited
+		     from `MockBukkit-v1.21`. If it doesn't match, the tests might fail with class not found errors. -->
 		<dependency>
 			<groupId>org.junit.jupiter</groupId>
 			<artifactId>junit-jupiter-engine</artifactId>
-			<version>5.8.2</version>
+			<version>5.11.0</version>
 			<scope>test</scope>
 		</dependency>
 	</dependencies>

diff --git a/...mmandapi-bukkit-test-toolkit/src/main/java/dev/jorel/commandapi/MockCommandAPIBukkit.java b/...mmandapi-bukkit-test-toolkit/src/main/java/dev/jorel/commandapi/MockCommandAPIBukkit.java
@@ -14,6 +14,8 @@
 import dev.jorel.commandapi.wrappers.*;
 import net.kyori.adventure.text.Component;
 import net.kyori.adventure.text.format.NamedTextColor;
+import net.kyori.adventure.text.serializer.gson.GsonComponentSerializer;
+import net.kyori.adventure.text.serializer.plain.PlainTextComponentSerializer;
 import net.md_5.bungee.api.chat.BaseComponent;
 import org.bukkit.*;
 import org.bukkit.advancement.Advancement;
@@ -128,7 +130,7 @@ public MockCommandSource getBrigadierSourceFromCommandSender(AbstractCommandSend
 		return new MockCommandSource(sender.getSource());
 	}
 
-	// Logging
+	// Miscellaneous methods
 	/**
 	 * A global toggle for whether the default logger returned by {@link #getLogger()} should print messages to the
 	 * console. This is {@code false} by default, so not messages will appear. If you don't provide your own logger
@@ -144,6 +146,14 @@ public CommandAPILogger getLogger() {
 			CommandAPILogger.bindToMethods(msg -> {}, msg -> {}, msg -> {}, (msg, ex) -> {});
 	}
 
+	@Override
+	public Message generateMessageFromJson(String json) {
+		Component component = GsonComponentSerializer.gson().deserialize(json);
+		String text = PlainTextComponentSerializer.plainText().serialize(component);
+
+		return () -> text;
+	}
+
 	// Arguments
 	@Override
 	public ArgumentType<?> _ArgumentEntity(ArgumentSubType subType) {
@@ -645,9 +655,4 @@ public HelpTopic generateHelpTopic(String commandName, String shortDescription,
 	publi
10000
c Map<String, HelpTopic> getHelpMap() {
 		throw new UnimplementedMethodException();
 	}
-
-	@Override
-	public Message generateMessageFromJson(String json) {
-		throw new UnimplementedMethodException();
-	}
 }
diff --git a/...i-bukkit-test-toolkit/src/main/java/dev/jorel/commandapi/arguments/ArgumentUtilities.java b/...i-bukkit-test-toolkit/src/main/java/dev/jorel/commandapi/arguments/ArgumentUtilities.java
@@ -0,0 +1,73 @@
+package dev.jorel.commandapi.arguments;
+
+import com.mojang.brigadier.Message;
+import com.mojang.brigadier.StringReader;
+import com.mojang.brigadier.exceptions.CommandSyntaxException;
+import com.mojang.brigadier.exceptions.SimpleCommandExceptionType;
+import dev.jorel.commandapi.BukkitTooltip;
+import dev.jorel.commandapi.arguments.parser.Parser;
+import net.kyori.adventure.text.Component;
+import net.kyori.adventure.text.TextComponent;
+
+import java.util.function.Function;
+
+/**
+ * Utilities for creating mock argument parsers
+ */
+public class ArgumentUtilities {
+	private ArgumentUtilities() {
+	}
+
+	// Translatable messages
+	public static Message translatedMessage(String key) {
+		return BukkitTooltip.messageFromAdventureComponent(Component.translatable(key));
+	}
+
+
+	public static Message translatedMessage(String key, Object... args) {
+		TextComponent[] argsComponents = new TextComponent[args.length];
+		for (int i = 0; i < args.length; i++) {
+			Object arg = args[i];
+			String text = arg.toString();
+			argsComponents[i] = Component.text(text);
+		}
+		return BukkitTooltip.messageFromAdventureComponent(Component.translatable(key, argsComponents));
+	}
+
+	// Parser utilities
+	public static final CommandSyntaxException NEXT_BRANCH = new SimpleCommandExceptionType(
+		() -> "This branch did not match"
+	).create();
+
+
+	public static Parser.Literal assertCanRead(Function<StringReader, CommandSyntaxException> exception) {
+		return reader -> {
+			if (!reader.canRead()) throw exception.apply(reader);
+		};
+	}
+
+	public static Parser.Literal literal(String literal) {
+		return reader -> {
+			if (reader.canRead(literal.length())) {
+				int start = reader.getCursor();
+				int end = start + literal.length();
+
+				if (reader.getString().substring(start, end).equals(literal)) {
+					reader.setCursor(end);
+					return;
+				}
+			}
+			throw CommandSyntaxException.BUILT_IN_EXCEPTIONS.literalIncorrect().createWithContext(reader, literal);
+		};
+	}
+
+	public static Parser.Argument<String> readUntilWithoutEscapeCharacter(char terminator) {
+		return reader -> {
+			int start = reader.getCursor();
+			while (reader.canRead() && reader.peek() != terminator) {
+				reader.skip();
+			}
+			return reader.getString().substring(start, reader.getCursor());
+		};
+	}
+}
diff --git a/...test-toolkit/src/main/java/dev/jorel/commandapi/arguments/EntitySelectorArgumentType.java b/...test-toolkit/src/main/java/dev/jorel/commandapi/arguments/EntitySelectorArgumentType.java
@@ -34,19 +34,19 @@ public static EntitySelectorArgumentType player() {
 
 	// ArgumentType implementation
 	public static final SimpleCommandExceptionType ERROR_NOT_SINGLE_ENTITY = new SimpleCommandExceptionType(
-		() -> "Only one entity is allowed, but the provided selector allows more than one"
+		ArgumentUtilities.translatedMessage("argument.entity.toomany")
 	);
 	public static final SimpleCommandExceptionType ERROR_NOT_SINGLE_PLAYER = new SimpleCommandExceptionType(
-		() -> "Only one player is allowed, but the provided selector allows more than one"
+		ArgumentUtilities.translatedMessage("argument.player.toomany")
 	);
 	public static final SimpleCommandExceptionType ERROR_ONLY_PLAYERS_ALLOWED = new SimpleCommandExceptionType(
-		() -> "Only players may be affected by this command, but the provided selector includes entities"
+		ArgumentUtilities.translatedMessage("argument.player.entities")
 	);
 	public static final SimpleCommandExceptionType NO_ENTITIES_FOUND = new SimpleCommandExceptionType(
-		() -> "No entity was found"
+		ArgumentUtilities.translatedMessage("argument.entity.notfound.entity")
 	);
 	public static final SimpleCommandExceptionType NO_PLAYERS_FOUND = new SimpleCommandExceptionType(
-		() -> "No player was found"
+		ArgumentUtilities.translatedMessage("argument.entity.notfound.player")
 	);
 
 	@Override

diff --git a/...ukkit-test-toolkit/src/main/java/dev/jorel/commandapi/arguments/EntitySelectorParser.java b/...ukkit-test-toolkit/src/main/java/dev/jorel/commandapi/arguments/EntitySelectorParser.java
@@ -16,16 +16,13 @@
 public class EntitySelectorParser {
 	// Errors
 	public static final SimpleCommandExceptionType ERROR_INVALID_NAME_OR_UUID = new SimpleCommandExceptionType(
-		() -> "Invalid name or UUID"
+		ArgumentUtilities.translatedMessage("argument.entity.invalid")
 	);
 	public static final DynamicCommandExceptionType ERROR_UNKNOWN_SELECTOR_TYPE = new DynamicCommandExceptionType(
-		object -> {
-			String message = "Unknown selector type '%s'".formatted(object);
-			return () -> message;
-		}
+		object -> ArgumentUtilities.translatedMessage("argument.entity.selector.unknown", object)
 	);
 	public static final SimpleCommandExceptionType ERROR_MISSING_SELECTOR_TYPE = new SimpleCommandExceptionType(
-		() -> "Missing selector type"
+		ArgumentUtilities.translatedMessage("argument.entity.selector.missing")
 	);
 
 	// State for building a selector
@@ -52,7 +49,7 @@ private EntitySelector build() {
 
 	// Parsing
 	private static final Parser.Literal isSelectorStart = reader -> {
-		if (!(reader.canRead() && reader.peek() == '@')) throw Parser.NEXT_BRANCH;
+		if (!(reader.canRead() && reader.peek() == '@')) throw ArgumentUtilities.NEXT_BRANCH;
 	};
 
 	private static Parser.Literal parseSelector(ParameterGetter<EntitySelectorParser> selectorBuilderGetter) {
@@ -108,7 +105,7 @@ private static Parser.Literal parseSelector(ParameterGetter<EntitySelectorParser
 	}
 
 	private static final Parser.Literal isSelectorOptionsStart = reader -> {
-		if (!(reader.canRead() && reader.peek() == '[')) throw Parser.NEXT_BRANCH;
+		if (!(reader.canRead() && reader.peek() == '[')) throw ArgumentUtilities.NEXT_BRANCH;
 	};
 
 	private static Parser.Literal parseSelectorOptions(ParameterGetter<EntitySelectorParser> selectorBuilderGetter) {
@@ -164,11 +161,11 @@ private static Parser.Argument<EntitySelector> conclude(ParameterGetter<EntitySe
 		});
 	};
 	private static final SuggestionProvider suggestSelector = (context, builder) -> {
-		builder.suggest("@p", () -> "Nearest player");
-		builder.suggest("@a", () -> "All players");
-		builder.suggest("@r", () -> "Random player");
-		builder.suggest("@s", () -> "Current entity");
-		builder.suggest("@e", () -> "All entities");
+		builder.suggest("@p", ArgumentUtilities.translatedMessage("argument.entity.selector.nearestPlayer"));
+		builder.suggest("@a", ArgumentUtilities.translatedMessage("argument.entity.selector.allPlayers"));
+		builder.suggest("@r", ArgumentUtilities.translatedMessage("argument.entity.selector.randomPlayer"));
+		builder.suggest("@s", ArgumentUtilities.translatedMessage("argument.entity.selector.self"));
+		builder.suggest("@e", ArgumentUtilities.translatedMessage("argument.entity.selector.allEntities"));
 	};
 	private static final SuggestionProvider suggestNameOrSelector = (context, builder) -> {
 		suggestSelector.addSuggestions(context, builder);

diff --git a/...t-test-toolkit/src/main/java/dev/jorel/commandapi/arguments/IntegerRangeArgumentType.java b/...t-test-toolkit/src/main/java/dev/jorel/commandapi/arguments/IntegerRangeArgumentType.java
@@ -24,10 +24,10 @@ private IntegerRangeArgumentType() {
 	//  but MockBukkit doesn't seem to currently support that: https://github.com/MockBukkit/MockBukkit/issues/1040.
 	//  For now, just grabbing the literal strings from https://gist.github.com/sppmacd/82af47c83b225d4ffd33bb0c27b0d932.
 	public static final SimpleCommandExceptionType EMPTY_INPUT = new SimpleCommandExceptionType(
-		() -> "Expected value or range of values"
+		ArgumentUtilities.translatedMessage("argument.range.empty")
 	);
 	public static final SimpleCommandExceptionType RANGE_SWAPPED = new SimpleCommandExceptionType(
-		() -> "Min cannot be bigger than max"
+		ArgumentUtilities.translatedMessage("argument.range.swapped")
 	);
 
 	private static final Parser.Argument<Integer> READ_INT_BEFORE_RANGE = reader -> {
@@ -58,11 +58,11 @@ private IntegerRangeArgumentType() {
 	private static final Predicate<CommandSyntaxException> THROW_INVALID_INT_EXCEPTIONS = exception ->
 		exception.getType().equals(CommandSyntaxException.BUILT_IN_EXCEPTIONS.readerInvalidInt());
 
-	private static final Parser<IntegerRange> PARSER = Parser
+	private static final Parser<IntegerRange> PARSER = ArgumentUtilities
 		.assertCanRead(EMPTY_INPUT::createWithContext)
 		.alwaysThrowException()
 		.continueWith(
-			Parser.tryParse(Parser.literal("..")
+			Parser.tryParse(ArgumentUtilities.literal("..")
 				.neverThrowException()
 				// Input ..
 				.continueWith(
@@ -98,7 +98,7 @@ private IntegerRangeArgumentType() {
 						})
 						// Input low
 						.continueWith(getLow ->
-							Parser.tryParse(Parser.literal("..")
+							Parser.tryParse(ArgumentUtilities.literal("..")
 								.neverThrowException()
 								// Input low..
 								.continueWith(

diff --git a/...bukkit-test-toolkit/src/main/java/dev/jorel/commandapi/arguments/ProfileArgumentType.java b/...bukkit-test-toolkit/src/main/java/dev/jorel/commandapi/arguments/ProfileArgumentType.java
@@ -30,11 +30,11 @@ public interface Result {
 	}
 
 	public static final SimpleCommandExceptionType ERROR_UNKNOWN_PLAYER = new SimpleCommandExceptionType(
-		() -> "That player does not exist"
+		ArgumentUtilities.translatedMessage("argument.player.unknown")
 	);
 
 	private static final Parser.Literal isSelectorStart = reader -> {
-		if (!(reader.canRead() && reader.peek() == '@')) throw Parser.NEXT_BRANCH;
+		if (!(reader.canRead() && reader.peek() == '@')) throw ArgumentUtilities.NEXT_BRANCH;
 	};
 
 	private static final Parser<Result> PARSER = Parser
@@ -64,7 +64,7 @@ public interface Result {
 						}
 					))
 			)
-		).then(Parser.readUntilWithoutEscapeCharacter(' ')
+		).then(ArgumentUtilities.readUntilWithoutEscapeCharacter(' ')
 			.alwaysThrowException()
 			.continueWith(nameGetter -> Parser.parse(
 				reader -> {

diff --git a/...ndapi-bukkit-test-toolkit/src/main/java/dev/jorel/commandapi/arguments/parser/Parser.java b/...ndapi-bukkit-test-toolkit/src/main/java/dev/jorel/commandapi/arguments/parser/Parser.java
@@ -3,7 +3,6 @@
 import com.mojang.brigadier.StringReader;
 import com.mojang.brigadier.context.CommandContext;
 import com.mojang.brigadier.exceptions.CommandSyntaxException;
-import com.mojang.brigadier.exceptions.SimpleCommandExceptionType;
 import com.mojang.brigadier.suggestion.Suggestions;
 import com.mojang.brigadier.suggestion.SuggestionsBuilder;
 
@@ -353,42 +352,4 @@ public Parser<T> then(Parser<T> parser) {
 			};
 		}
 	}
-
-	//////////////////////////////////
-	// Common parsers and utilities //
-	//////////////////////////////////
-	CommandSyntaxException NEXT_BRANCH = new SimpleCommandExceptionType(
-		() -> "This branch did not match"
-	).create();
-
-	static Literal assertCanRead(Function<StringReader, CommandSyntaxException> exception) {
-		return reader -> {
-			if (!reader.canRead()) throw exception.apply(reader);
-		};
-	}
-
-	static Literal literal(String literal) {
-		return reader -> {
-			if (reader.canRead(literal.length())) {
-				int start = reader.getCursor();
-				int end = start + literal.length();
-
-				if (reader.getString().substring(start, end).equals(literal)) {
-					reader.setCursor(end);
-					return;
-				}
-			}
-			throw CommandSyntaxException.BUILT_IN_EXCEPTIONS.literalIncorrect().createWithContext(reader, literal);
-		};
-	}
-
-	static Argument<String> readUntilWithoutEscapeCharacter(char terminator) {
-		return reader -> {
-			int start = reader.getCursor();
-			while (reader.canRead() && reader.peek() != terminator) {
-				reader.skip();
-			}
-			return reader.getString().substring(start, reader.getCursor());
-		};
-	}
 }
diff --git a/examples/build.sh b/examples/build.sh
@@ -9,7 +9,7 @@ echo "Building Maven examples"
 for folder in $(find $PWD -name "pom.xml" -print0 | xargs -0 dirname); do
 	if [[ ! $folder =~ "maven-shaded-tests" ]]; then
 		# The parentheses are required to only change the directory for the command so the second find $PWD does not break
-		(cd "$folder" && mvn clean package)
+		(cd "$folder" && mvn clean verify)
 	fi
 done