Introduce new command builder DSL

Signed-off-by: Piotr Olaszewski <[email protected]>

Author: piotrooo

spring-shell-core/src/main/java/org/springframework/shell/core/command/Command.java

@@ -13,11 +13,19 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
 package org.springframework.shell.core.command;
 
+import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.Collections;
 import java.util.List;
+import java.util.function.Consumer;
+import java.util.function.Function;
+
+import org.springframework.shell.core.commands.AbstractCommand;
+import org.springframework.shell.core.commands.adapter.ConsumerCommandAdapter;
+import org.springframework.shell.core.commands.adapter.FunctionCommandAdapter;
+import org.springframework.util.Assert;
 
 /**
  * @author Eric Bottard
@@ -74,4 +82,86 @@ default List<String> getAliases() {
 	 */
 	ExitStatus execute(CommandContext commandContext) throws Exception;
 
+	/**
+	 * Creates and returns a new instance of a {@code Builder} for defining and
+	 * constructing commands.
+	 * <p>
+	 * The builder allows customization of command properties such as name, description,
+	 * group, help text, aliases, and execution logic.
+	 * @return a new {@code Builder} instance for configuring and creating commands
+	 */
+	static Builder builder() {
+		return new Builder();
+	}
+
+	/**
+	 * Builder for creating command.
+	 */
+	final class Builder {
+
+		private String name = "";
+
+		private String description = "";
+
+		private String group = "";
+
+		private String help = "";
+
+		private List<String> aliases = new ArrayList<>();
+
+		public Builder name(String name) {
+			this.name = name;
+			return this;
+		}
+
+		public Builder description(String description) {
+			this.description = description;
+			return this;
+		}
+
+		public Builder help(String help) {
+			this.help = help;
+			return this;
+		}
+
+		public Builder group(String group) {
+			this.group = group;
+			return this;
+		}
+
+		public Builder aliases(String... aliases) {
+			this.aliases = Arrays.asList(aliases);
+			return this;
+		}
+
+		public AbstractCommand execute(Consumer<CommandContext> commandExecutor) {
+			Assert.hasText(name, "'name' must be specified");
+
+			ConsumerCommandAdapter command = new ConsumerCommandAdapter(name, description, group, help,
+					commandExecutor);
+
+			initAliases(command);
+
+			return command;
+		}
+
+		public AbstractCommand execute(Function<CommandContext, String> commandExecutor) {
+			Assert.hasText(name, "'name' must be specified");
+
+			FunctionCommandAdapter command = new FunctionCommandAdapter(name, description, group, help,
+					commandExecutor);
+
+			initAliases(command);
+
+			return command;
+		}
+
+		private void initAliases(AbstractCommand command) {
+			if (aliases != null) {
+				command.setAliases(aliases);
+			}
+		}
+
+	}
+
 }

spring-shell-core/src/main/java/org/springframework/shell/core/commands/adapter/package-info.java

@@ -0,0 +1,4 @@
+@NullMarked
+package org.springframework.shell.core.commands.adapter;
+
+import org.jspecify.annotations.NullMarked;

spring-shell-samples/spring-shell-sample-hello-world/src/main/java/org/springframework/shell/samples/helloworld/SpringShellApplication.java

@@ -3,16 +3,18 @@
 import java.io.PrintWriter;
 import java.util.List;
 
+import org.jline.utils.AttributedStringBuilder;
+
 import org.springframework.context.ApplicationContext;
 import org.springframework.context.annotation.AnnotationConfigApplicationContext;
 import org.springframework.context.annotation.Bean;
 import org.springframework.shell.core.ShellRunner;
 import org.springframework.shell.core.command.CommandContext;
-import org.springframework.shell.core.command.annotation.Argument;
-import org.springframework.shell.core.command.annotation.Arguments;
-import org.springframework.shell.core.command.annotation.Command;
-import org.springframework.shell.core.command.annotation.EnableCommand;
-import org.springframework.shell.core.command.annotation.Option;
+import org.springframework.shell.core.command.annotation.*;
+import org.springframework.shell.core.commands.AbstractCommand;
+
+import static org.jline.utils.AttributedStyle.BOLD;
+import static org.jline.utils.AttributedStyle.GREEN;
 
 @EnableCommand(SpringShellApplication.class)
 public class SpringShellApplication {
@@ -44,10 +46,37 @@ public void sayHeyToEveryone(@Arguments List<String> names, @Option(shortName =
 	public void sayYo(CommandContext commandContext) {
 		try (PrintWriter outputWriter = commandContext.outputWriter()) {
 			outputWriter.println("Yo there! what's up?");
-			outputWriter.flush();
 		}
 	}
 
+	@Bean
+	public AbstractCommand sayGoodMorning() {
+		return org.springframework.shell.core.command.Command.builder()
+			.name("good-morning")
+			.description("Say good morning")
+			.group("greetings")
+			.help("A command that greets the user with 'Good morning!'")
+			.execute(commandContext -> {
+				String ansiString = new AttributedStringBuilder().append("Good morning!", BOLD.foreground(GREEN))
+					.append("!")
+					.toAnsi();
+				try (PrintWriter outputWriter = commandContext.outputWriter()) {
+					outputWriter.println(ansiString);
+					outputWriter.flush();
+				}
+			});
+	}
+
+	@Bean
+	public AbstractCommand sayGoodDay() {
+		return org.springframework.shell.core.command.Command.builder()
+			.name("good-day")
+			.description("Say good day")
+			.group("greetings")
+			.help("A command that greets the user with 'Good day!'")
+			.execute(commandContext -> "Good day!");
+	}
+
 	@Bean
 	public HelloCommand sayHello() {
 		return new HelloCommand();