Fix script command

Author: fmbenhassine

spring-shell-core-autoconfigure/src/main/java/org/springframework/shell/core/autoconfigure/StandardCommandsAutoConfiguration.java

@@ -23,6 +23,7 @@
 import org.springframework.shell.core.command.Clear;
 import org.springframework.shell.core.command.Command;
 import org.springframework.shell.core.command.Help;
+import org.springframework.shell.core.command.Script;
 import org.springframework.shell.core.command.Version;
 
 /**
@@ -54,4 +55,10 @@ public Command versionCommand() {
 		return new Version();
 	}
 
+	@Bean
+	@ConditionalOnProperty(value = "spring.shell.command.script.enabled", havingValue = "true", matchIfMissing = true)
+	public Command scriptCommand() {
+		return new Script();
+	}
+
 }

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

@@ -19,7 +19,7 @@
 import java.util.List;
 
 import org.springframework.shell.core.FileInputProvider;
-import org.springframework.shell.core.utils.Utils;
+import org.springframework.shell.core.NonInteractiveShellRunner;
 
 /**
  * A command that can read and execute other commands from a file.
@@ -28,16 +28,29 @@
  * @author Janne Valkealahti
  * @author Mahmoud Ben Hassine
  */
-public class Script extends AbstractCommand {
+public class Script implements Command {
 
-	public Script(String name, String description) {
-		super(name, description);
+	private CommandParser commandParser = new DefaultCommandParser();
+
+	@Override
+	public String getDescription() {
+		return "Execute commands from a script file";
+	}
+
+	@Override
+	public String getGroup() {
+		return "Built-In Commands";
 	}
 
 	@Override
-	public ExitStatus doExecute(CommandContext commandContext) throws Exception {
+	public ExitStatus execute(CommandContext commandContext) throws Exception {
 		List<CommandArgument> arguments = commandContext.parsedInput().arguments();
-		File file = new File(arguments.get(0).value());
+		if (arguments.size() != 1) {
+			throw new IllegalArgumentException(
+					"Script command expects exactly one argument: the absolute path to the script file to execute.");
+		}
+		String scriptFile = arguments.get(0).value();
+		File file = new File(scriptFile);
 		try (FileInputProvider inputProvider = new FileInputProvider(file)) {
 			String input;
 			while ((input = inputProvider.readInput()) != null) {
@@ -48,14 +61,18 @@ public ExitStatus doExecute(CommandContext commandContext) throws Exception {
 	}
 
 	private void executeCommand(CommandContext commandContext, String input) throws Exception {
-		Command command = commandContext.commandRegistry().getCommandByName(input);
-		if (command == null) {
-			String availableCommands = Utils.formatAvailableCommands(commandContext.commandRegistry());
-			throw new CommandNotFoundException("No command found for name: " + input + ". " + availableCommands);
-		}
-		CommandContext singleCommandContext = new CommandContext(commandContext.parsedInput(),
-				commandContext.commandRegistry(), commandContext.outputWriter());
-		command.execute(singleCommandContext);
+		String[] commandTokens = input.split(" ");
+		NonInteractiveShellRunner shellRunner = new NonInteractiveShellRunner(this.commandParser,
+				commandContext.commandRegistry());
+		shellRunner.run(commandTokens);
+	}
+
+	/**
+	 * Set the command parser to use to parse commands in the script.
+	 * @param commandParser the command parser to set
+	 */
+	public void setCommandParser(CommandParser commandParser) {
+		this.commandParser = commandParser;
 	}
 
 }

spring-shell-core/src/main/java/org/springframework/shell/core/command/annotation/support/EnableCommandRegistrar.java

@@ -48,6 +48,7 @@ public void registerBeanDefinitions(AnnotationMetadata metadata, BeanDefinitionR
 		registry.registerBeanDefinition("help", new RootBeanDefinition(Help.class));
 		registry.registerBeanDefinition("clear", new RootBeanDefinition(Clear.class));
 		registry.registerBeanDefinition("version", new RootBeanDefinition(Version.class));
+		registry.registerBeanDefinition("script", new RootBeanDefinition(Script.class));
 
 		// register user defined commands
 		Class<?>[] candidateClasses = shellAnnotation.value();

spring-shell-docs/modules/ROOT/nav.adoc

@@ -18,6 +18,7 @@
 *** xref:commands/builtin/clear.adoc[]
 *** xref:commands/builtin/exit.adoc[]
 *** xref:commands/builtin/version.adoc[]
+*** xref:commands/builtin/script.adoc[]
 ** xref:commands/writing.adoc[]
 * xref:building.adoc[]
 * xref:components/index.adoc[]

spring-shell-docs/modules/ROOT/pages/commands/builtin/script.adoc

@@ -0,0 +1,15 @@
+[[built-in-commands-script]]
+= Script
+
+The `script` command allows you to execute a series of commands from a specified script file. This is useful for automating repetitive tasks or setting up an environment quickly.
+
+This command expects a file path as an argument, which points to the script file containing the commands to be executed. For example:
+
+[source,shell]
+----
+$>script -- /path/to/your/script.txt
+----
+
+Since the script command does not define any options, you need to use the `--` separator before specifying the script file path to avoid ambiguity. Please refer to the xref:commands/syntax.adoc[] section fpr more details about command syntax.
+
+The script file should contain one command per line, and the commands will be executed in the order they appear in the file. Comments can be added to the script file by starting a line with a `#` character.

spring-shell-samples/spring-shell-sample-hello-world/src/main/resources/script.cmd

@@ -0,0 +1,2 @@
+hello --name=foo
+hello --name=bar