Fix script command to accept the script file as an option

Resolves #1301

Signed-off-by: czpilar <[email protected]>

Author: czpilar

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

@@ -17,6 +17,7 @@
 
 import java.io.File;
 import java.util.List;
+import java.util.Objects;
 
 import org.springframework.shell.core.FileInputProvider;
 import org.springframework.shell.core.NonInteractiveShellRunner;
@@ -27,6 +28,7 @@
  * @author Eric Bottard
  * @author Janne Valkealahti
  * @author Mahmoud Ben Hassine
+ * @author David Pilar
  */
 public class Script implements Command {
 
@@ -42,15 +44,29 @@ public String getGroup() {
 		return "Built-In Commands";
 	}
 
+	@Override
+	public List<CommandOption> getOptions() {
+		return List.of(CommandOption.with()
+			.type(String.class)
+			.shortName('f')
+			.longName("file")
+			.required(true)
+			.description("The absolute path to the script file to execute")
+			.build());
+	}
+
 	@Override
 	public ExitStatus execute(CommandContext commandContext) throws Exception {
-		List<CommandArgument> arguments = commandContext.parsedInput().arguments();
-		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);
+		String scriptFile = commandContext.parsedInput()
+			.options()
+			.stream()
+			.filter(o -> "file".equals(o.longName()) || 'f' == o.shortName())
+			.map(CommandOption::value)
+			.filter(Objects::nonNull)
+			.findFirst()
+			.orElseThrow(() -> new IllegalArgumentException(
+					"Script command expects option --file or -f with exactly one argument: the absolute path to the script file to execute."));
+		File file = new File(Objects.requireNonNull(scriptFile));
 		try (FileInputProvider inputProvider = new FileInputProvider(file)) {
 			String input;
 			while ((input = inputProvider.readInput()) != null) {

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

@@ -3,13 +3,11 @@
 
 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:
+This command expects a file absolute path as an option, which points to the script file containing the commands to be executed. For example:
 
 [source,shell]
 ----
-$>script -- /path/to/your/script.txt
+$>script --file /absolute/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.