Skip to content

Introduce new command builder DSL #1211

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
+141 −4
Open

Introduce new command builder DSL #1211

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
a14657f
Introduce new command DSL
piotrooo Nov 6, 2025
cedf6f3
Cleanup
piotrooo Nov 29, 2025
c9848b3
Cleanup
piotrooo Nov 30, 2025
932b593
Cleanup
piotrooo Dec 1, 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
5 changes: 5 additions & 0 deletions .editorconfig
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
root = true

[*.{java,xml,gradle}]
indent_style = tab
indent_size = 4
8 changes: 4 additions & 4 deletions ...configure/src/main/java/org/springframework/shell/boot/CommandRegistrationCustomizer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,20 +15,20 @@
*/
package org.springframework.shell.boot;

import org.springframework.shell.core.command.CommandRegistration;
import org.springframework.shell.core.command.Command;

/**
* Callback interface that can be used to customize a {@link CommandRegistration.Builder}.
* Callback interface that can be used to customize a {@link Command.Builder}.
*
* @author Janne Valkealahti
*/
@FunctionalInterface
public interface CommandRegistrationCustomizer {

/**
* Callback to customize a {@link CommandRegistration.Builder} instance.
* Callback to customize a {@link Command.Builder} instance.
* @param commandRegistrationBuilder the command registration builder to customize
*/
void customize(CommandRegistration.Builder commandRegistrationBuilder);
void customize(Command.Builder commandRegistrationBuilder);

}
16 changes: 7 additions & 9 deletions ...figure/src/main/java/org/springframework/shell/boot/CommandRegistryAutoConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,11 @@
import org.springframework.context.annotation.Bean;
import org.springframework.shell.core.MethodTargetRegistrar;
import org.springframework.shell.boot.SpringShellProperties.Help;
import org.springframework.shell.core.command.Command;
import org.springframework.shell.core.command.CommandRegistry;
import org.springframework.shell.core.command.CommandRegistryCustomizer;
import org.springframework.shell.core.command.CommandRegistration;
import org.springframework.shell.core.command.CommandRegistration.BuilderSupplier;
import org.springframework.shell.core.command.CommandRegistration.OptionNameModifier;
import org.springframework.shell.core.command.BuilderSupplier;
import org.springframework.shell.core.command.OptionNameModifier;
import org.springframework.shell.core.command.support.OptionNameModifierSupport;
import org.springframework.shell.core.command.CommandResolver;
import org.springframework.shell.core.context.ShellContext;
Expand All @@ -57,8 +57,7 @@ public CommandRegistry commandRegistry(ObjectProvider<MethodTargetRegistrar> met
}

@Bean
public CommandRegistryCustomizer defaultCommandRegistryCustomizer(
ObjectProvider<CommandRegistration> commandRegistrations) {
public CommandRegistryCustomizer defaultCommandRegistryCustomizer(ObjectProvider<Command> commandRegistrations) {
return registry -> {
commandRegistrations.orderedStream().forEach(registration -> {
registry.register(registration);
Expand All @@ -71,11 +70,10 @@ public CommandRegistrationCustomizer helpOptionsCommandRegistrationCustomizer(Sp
return registration -> {
Help help = properties.getHelp();
if (help.isEnabled()) {
registration.withHelpOptions()
.enabled(true)
registration.withHelpOptions(helpOptionsSpec -> helpOptionsSpec.enabled(true)
.longNames(help.getLongNames())
.shortNames(help.getShortNames())
.command(help.getCommand());
.command(help.getCommand()));
}
};
}
Expand Down Expand Up @@ -121,7 +119,7 @@ public CommandRegistrationCustomizer defaultOptionNameModifierCommandRegistratio
public BuilderSupplier commandRegistrationBuilderSupplier(
ObjectProvider<CommandRegistrationCustomizer> customizerProvider) {
return () -> {
CommandRegistration.Builder builder = CommandRegistration.builder();
Command.Builder builder = Command.builder();
customizerProvider.orderedStream().forEach((customizer) -> customizer.customize(builder));
return builder;
};
Expand Down
Loading