8000 Update the default namespace by DerEchtePilz · Pull Request #636 · CommandAPI/CommandAPI · GitHub
[go: up one dir, main page]
Skip to content

Update the default namespace #636

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 13, 2025
Merged

Update the default namespace #636

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
00f603f
Use the plugin namespace as the default namespace when shading
DerEchtePilz Mar 12, 2025
2e59a9e
Fix the tests
DerEchtePilz Mar 12, 2025
7c9204a
Revert "Fix the tests" and do some other stuff to fix them
DerEchtePilz Mar 13, 2025
5d4aa3f
Code review
DerEchtePilz Mar 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion ...kit/commandapi-bukkit-core/src/main/java/dev/jorel/commandapi/CommandAPIBukkitConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ public class CommandAPIBukkitConfig extends CommandAPIConfig<CommandAPIBukkitCon
*/
public CommandAPIBukkitConfig(JavaPlugin plugin) {
this.plugin = plugin;
super.setNamespace("minecraft");
super.setNamespace(plugin.getName().toLowerCase());
}

/**
Expand Down Expand Up @@ -71,8 +71,10 @@ public CommandAPIBukkitConfig useMojangMappings(boolean useMojangMappings) {
}

/**
* @deprecated The plugin namespace is now the default namespace
* @return this CommandAPIBukkitConfig
*/
@Deprecated(since = "10.0.0", forRemoval = true)
public CommandAPIBukkitConfig usePluginNamespace() {
super.setNamespace(plugin.getName().toLowerCase());
super.usePluginNamespace = true;
Expand Down
1 change: 1 addition & 0 deletions ...ommandapi-bukkit-core/src/main/java/dev/jorel/commandapi/CommandRegistrationStrategy.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
import com.mojang.brigadier.tree.RootCommandNode;
import dev.jorel.commandapi.preprocessor.RequireField;

import java.util.Arrays;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
Expand Down
65 changes: 35 additions & 30 deletions ...dapi-bukkit-test-tests/src/test/java/dev/jorel/commandapi/test/CommandNamespaceTests.java
View file
Open in desktop
5649
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Player enableWithNamespaces() {
SimpleCommandMap commandMap = mockPlatform.getSimpleCommandMap();
SpigotCommandRegistration<Object> spigotCommandRegistration = (SpigotCommandRegistration<Object>) mockPlatform.getCommandRegistrationStrategy();
for (CommandNode<Object> node : mockPlatform.getBrigadierDispatcher().getRoot().getChildren()) {
commandMap.register("minecraft", spigotCommandRegistration.wrapToVanillaCommandWrapper(node));
commandMap.register("commandapitest", spigotCommandRegistration.wrapToVanillaCommandWrapper(node));
}

// Run the CommandAPI's enable tasks, especially `fixNamespaces`
Expand Down Expand Up @@ -137,11 +137,11 @@ public void testDefaultMinecraftNamespace(boolean enableBeforeRegistering) {
// Check contents of Bukkit CommandMap
CommandMap commandMap = MockPlatform.getInstance().getSimpleCommandMap();
assertNotNull(commandMap.getCommand("test"));
assertNotNull(commandMap.getCommand("minecraft:test"));
assertNotNull(commandMap.getCommand("commandapitest:test"));

// Commands should run
assertStoresResult(player, "test alpha", results, "alpha");
assertStoresResult(player, "minecraft:test alpha", results, "alpha");
assertStoresResult(player, "commandapitest:test alpha", results, "alpha");

assertNoMoreResults(results);
}
Expand Down Expand Up @@ -174,6 +174,7 @@ public void testStringNamespace(boolean enableBeforeRegistering) {
assertNotNull(rootNode.getChild("test"));
assertNotNull(rootNode.getChild("commandtest:test"));
assertNull(rootNode.getChild("minecraft:test"));
assertNull(rootNode.getChild("commandapitest:test"));

// Check contents of Bukkit CommandMap
CommandMap commandMap = MockPlatform.getInstance().getSimpleCommandMap();
Expand Down Expand Up @@ -281,19 +282,22 @@ public void testAliasesWithDefaultNamespace(boolean enableBeforeRegistering) {
// Check contents of Bukkit CommandMap
CommandMap commandMap = MockPlatform.getInstance().getSimpleCommandMap();
assertNotNull(commandMap.getCommand("test"));
assertNotNull(commandMap.getCommand("minecraft:test"));
assertNull(commandMap.getCommand("minecraft:test"));
assertNotNull(commandMap.getCommand("commandapitest:test"));
assertNotNull(commandMap.getCommand("alpha"));
assertNotNull(commandMap.getCommand("minecraft:alpha"));
assertNull(commandMap.getCommand("minecraft:alpha"));
assertNotNull(commandMap.getCommand("commandapitest:alpha"));
assertNotNull(commandMap.getCommand("beta"));
assertNotNull(commandMap.getCommand("minecraft:beta"));
assertNull(commandMap.getCommand("minecraft:beta"));
assertNotNull(commandMap.getCommand("commandapitest:beta"));

// Commands should run
assertStoresResult(player, "test discord", results, "discord");
assertStoresResult(player, "alpha discord", results, "discord");
assertStoresResult(player, "beta discord", results, "discord");
assertStoresResult(player, "minecraft:test discord", results, "discord");
assertStoresResult(player, "minecraft:alpha discord", results, "discord");
assertStoresResult(player, "minecraft:beta discord", results, "discord");
assertStoresResult(player, "commandapitest:test discord", results, "discord");
assertStoresResult(player, "commandapitest:alpha discord", results, "discord");
assertStoresResult(player, "commandapitest:beta discord", results, "discord");

assertNoMoreResults(results);
}
Expand Down Expand Up @@ -546,19 +550,20 @@ public void testSameCommandNameConflictWithDefaultNamespaceAndCustomNamespace(bo
RootCommandNode<Object> root = MockPlatform.getInstance().getBrigadierDispatcher().getRoot();
assertNotNull(root.getChild("test"));
assertNotNull(root.getChild("custom:test"));
// The `minecraft:test` node should exist in the Brigadier map so the `minecraft:test` VanillaCommandWrapper
// The `commandapitest:test` node should exist in the Brigadier map so the `commandapitest:test` VanillaCommandWrapper
// can properly execute the command separately from the `custom:test` b branch
assertNotNull(root.getChild("minecraft:test"));
assertNotNull(root.getChild("commandapitest:test"));

CommandMap commandMap = MockPlatform.getInstance().getSimpleCommandMap();
assertNotNull(commandMap.getCommand("test"));
assertNotNull(commandMap.getCommand("minecraft:test"));
assertNotNull(commandMap.getCommand("commandapitest:test"));
assertNotNull(commandMap.getCommand("custom:test"));
assertNull(commandMap.getCommand("minecraft:test"));
assertNull(commandMap.getCommand("minecraft:custom:test"));

assertStoresResult(player, "test a", results, "a");
assertStoresResult(player, "test b", results, "b");
assertStoresResult(player, "minecraft:test a", results, "a");
assertStoresResult(player, "commandapitest:test a", results, "a");
assertStoresResult(player, "custom:test b", results, "b");

assertThrowsWithMessage(
Expand All @@ -568,8 +573,8 @@ public void testSameCommandNameConflictWithDefaultNamespaceAndCustomNamespace(bo
);
assertThrowsWithMessage(
CommandSyntaxException.class,
"Incorrect argument for command at position 15: ...raft:test <--[HERE]",
() -> server.dispatchThrowableBrigadierCommand(player, "minecraft:test b")
"Incorrect argument for command at position 20: ...test:test <--[HERE]",
() -> server.dispatchThrowableBrigadierCommand(player, "commandapitest:test b")
);

assertNoMoreResults(results);
Expand Down Expand Up @@ -603,7 +608,7 @@ public void testCommandTreeRegistrationDefaultNamespace(boolean enableBeforeRegi
)
);

// Make sure the default registration with the minecraft: namespace works
// Make sure the default registration with the commandapitest: namespace works
command.register();

if (!enableBeforeRegistering) {
Expand All @@ -614,15 +619,15 @@ public void testCommandTreeRegistrationDefaultNamespace(boolean enableBeforeRegi
assertEquals("a", results.get());
assertEquals("alpha", results.get());

server.dispatchCommand(player, "minecraft:test a alpha");
server.dispatchCommand(player, "commandapitest:test a alpha");
assertEquals("a", results.get());
assertEquals("alpha", results.get());

server.dispatchCommand(player, "test b 123");
assertEquals("b", results.get());
assertEquals("123", results.get());

server.dispatchCommand(player, "minecraft:test b 123");
server.dispatchCommand(player, "commandapitest:test b 123");
assertEquals("b", results.get());
assertEquals("123", results.get());

Expand Down Expand Up @@ -800,12 +805,12 @@ public void testPermissionsWithDefaultNamespace(boolean enableBeforeRegistering)
}

assertPermissionCheckFails(player, "test");
assertPermissionCheckFails(player, "minecraft:test");
assertPermissionCheckFails(player, "commandapitest:test");

player.addAttachment(super.plugin, "permission", true);

assertStoresResult(player, "test", commandRan, "ran");
assertStoresResult(player, "minecraft:test", commandRan, "ran");
assertStoresResult(player, "commandapitest:test", commandRan, "ran");

assertNoMoreResults(commandRan);
}
Expand Down Expand Up @@ -931,8 +936,8 @@ public void testConfigNamespace() {
CommandAPIBukkitConfig config = new CommandAPIBukkitConfig(MockPlatform.getConfiguration().getPlugin());
InternalBukkitConfig internalConfig = new InternalBukkitConfig(config);

// The namespace wasn't changed so it should default to minecraft
assertEquals("minecraft", internalConfig.getNamespace());
// The namespace wasn't changed so it should default to commandapitest
assertEquals("commandapitest", internalConfig.getNamespace());

config = new CommandAPIBukkitConfig(MockPlatform.getConfiguration().getPlugin());
CommandAPIBukkitConfig finalConfig = config;
Expand All @@ -944,8 +949,8 @@ public void testConfigNamespace() {
.setNamespace("");
internalConfig = new InternalBukkitConfig(config);

// The namespace was set to an empty namespace so this should result in the default minecraft namespace
assertEquals("minecraft", internalConfig.getNamespace());
// The namespace was set to an empty namespace so this should result in the default commandapitest namespace
assertEquals("commandapitest", internalConfig.getNamespace());

config = new CommandAPIBukkitConfig(MockPlatform.getConfiguration().getPlugin())
.setNamespace("custom");
Expand Down Expand Up @@ -983,8 +988,8 @@ public void testConfigNamespace() {
.setNamespace("Custom");
internalConfig = new InternalBukkitConfig(config);

// The namespace uses invalid characters so the namespace should default to minecraft
assertEquals("minecraft", internalConfig.getNamespace());
// The namespace uses invalid characters so the namespace should default to commandapitest
assertEquals("commandapitest", internalConfig.getNamespace());

Player player = enableWithNamespaces();

Expand All @@ -994,17 +999,17 @@ public void testConfigNamespace() {

command.register("");

// The command should be registered with the minecraft namespace because the namespace was empty
// The command should be registered with the commandapitest namespace because the namespace was empty
assertTrue(server.dispatchCommand(player, "test"));
assertTrue(server.dispatchCommand(player, "minecraft:test"));
assertTrue(server.dispatchCommand(player, "commandapitest:test"));

CommandAPI.unregister("test", true);

command.register("Command");

// The command should be registered with the minecraft namespace because the namespace was invalid
// The command should be registered with the commandapitest namespace because the namespace was invalid
assertTrue(server.dispatchCommand(player, "test"));
assertTrue(server.dispatchCommand(player, "minecraft:test"));
assertTrue(server.dispatchCommand(player, "commandapitest:test"));

CommandAPI.unregister("test", true);

Expand Down
Loading
Loading
0