Merge pull request #537 from JorelAli/dev/literal-argument-help

Updates help generation for literal arguments

README.md

@@ -422,6 +422,7 @@ This is the current roadmap for the CommandAPI (as of 11th May 2023):
                     <li>https://github.com/JorelAli/CommandAPI/issues/495 Adds a parameter to <code>EntitySelectorArgument</code> to allow failure when no entity lists are empty</li>
                     <li>https://github.com/JorelAli/CommandAPI/issues/367, https://github.com/JorelAli/CommandAPI/pull/509 Adds the ability to register commands with a custom namespace</li>
                     <li>https://github.com/JorelAli/CommandAPI/pull/523 Exposed more details of the <code>CommandPermission</code></li>
+                    <li>https://github.com/JorelAli/CommandAPI/issues/526, https://github.com/JorelAli/CommandAPI/pull/527 Fix wrong help generation for literal arguments</li>
                 </ul>
             </td>
         </tr>

commandapi-core/src/main/java/dev/jorel/commandapi/CommandAPIHandler.java

@@ -618,7 +618,7 @@ void register(CommandMetaData<CommandSender> meta, final Argument[] args,
 		for (Argument arg : args) {
 			argumentsString.add(arg.getNodeName() + ":" + arg.getClass().getSimpleName());
 		}
-		RegisteredCommand registeredCommandInformation = new RegisteredCommand(commandName, argumentsString, shortDescription,
+		RegisteredCommand registeredCommandInformation = new RegisteredCommand(commandName, argumentsString, List.of(args), shortDescription,
 			fullDescription, usageDescription, aliases, permission, namespace);
 		registeredCommands.add(registeredCommandInformation);
 

commandapi-core/src/main/java/dev/jorel/commandapi/RegisteredCommand.java

@@ -1,5 +1,7 @@
 package dev.jorel.commandapi;
 
+import dev.jorel.commandapi.arguments.AbstractArgument;
+
 import java.util.Arrays;
 import java.util.List;
 import java.util.Objects;
@@ -26,6 +28,11 @@ public record RegisteredCommand(
 	 */
 	List<String> argsAsStr,
 
+	/**
+	 * @return An unmodifiable list of arguments for this command
+	 */
+	List<AbstractArgument<?, ?, ?, ?>> arguments,
+
 	/**
 	 * @return An {@link Optional} containing this command's help's short
 	 *         descriptions

commandapi-core/src/main/java/dev/jorel/commandapi/arguments/AbstractArgument.java

@@ -361,6 +361,10 @@ public void copyPermissionsAndRequirements(Argument argument) {
 		this.withPermission(argument.getArgumentPermission());
 	}
 
+	public String getHelpString() {
+		return "<" + this.getNodeName() + ">";
+	}
+
 	@Override
 	public String toString() {
 		return this.getNodeName() + "<" + this.getClass().getSimpleName() + ">";

commandapi-platforms/commandapi-bukkit/commandapi-bukkit-core/src/main/java/dev/jorel/commandapi/CommandAPIBukkit.java

@@ -13,6 +13,7 @@
 import java.util.logging.Level;
 import java.util.logging.Logger;
 
+import dev.jorel.commandapi.arguments.AbstractArgument;
 import dev.jorel.commandapi.commandsenders.*;
 import org.bukkit.Bukkit;
 import org.bukkit.ChatColor;
@@ -315,8 +316,8 @@ private String[] getUsageList(RegisteredCommand currentCommand) {
 				final RegisteredCommand command = commandsWithIdenticalNames.get(i);
 				StringBuilder usageString = new StringBuilder();
 				usageString.append("/").append(command.commandName()).append(" ");
-				for (String arg : command.argsAsStr()) {
-					usageString.append("<").append(arg.split(":")[0]).append("> ");
+				for (AbstractArgument<?, ?, ?, ?> arg : command.arguments()) {
+					usageString.append(arg.getHelpString()).append(" ");
 				}
 				usages[i] = usageString.toString().trim();
 			}

commandapi-platforms/commandapi-bukkit/commandapi-bukkit-core/src/main/java/dev/jorel/commandapi/arguments/LiteralArgument.java

@@ -137,6 +137,11 @@ public CommandAPIArgumentType getArgumentType() {
 		return CommandAPIArgumentType.LITERAL;
 	}
 
+	@Override
+	public String getHelpString() {
+		return literal;
+	}
+
 	@Override
 	public <Source> String parseArgument(CommandContext<Source> cmdCtx, String key, CommandArguments previousArgs) throws CommandSyntaxException {
 		return literal;

commandapi-platforms/commandapi-velocity/commandapi-velocity-core/src/main/java/dev/jorel/commandapi/arguments/LiteralArgument.java

@@ -133,6 +133,11 @@ public CommandAPIArgumentType getArgumentType() {
 		return CommandAPIArgumentType.LITERAL;
 	}
 
+	@Override
+	public String getHelpString() {
+		return literal;
+	}
+
 	@Override
 	public <Source> String parseArgument(CommandContext<Source> cmdCtx, String key, CommandArguments previousArgs) throws CommandSyntaxException {
 		return literal;