Refine contribution #1241

- Add test
- Update documentation

Author: fmbenhassine

spring-shell-core-autoconfigure/src/test/java/org/springframework/shell/core/autoconfigure/CustomPromptProviderAutoConfigurationTests.java

@@ -0,0 +1,70 @@
+/*
+ * Copyright 2025-present the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.shell.core.autoconfigure;
+
+import org.jline.utils.AttributedString;
+import org.jline.utils.AttributedStyle;
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.Test;
+
+import org.springframework.boot.autoconfigure.AutoConfigurations;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.boot.test.context.runner.ApplicationContextRunner;
+import org.springframework.context.annotation.Bean;
+import org.springframework.shell.core.command.annotation.Command;
+import org.springframework.shell.jline.JLineInputProvider;
+import org.springframework.shell.jline.PromptProvider;
+import org.springframework.test.util.ReflectionTestUtils;
+
+public class CustomPromptProviderAutoConfigurationTests {
+
+	@Test
+	void testCustomPromptProviderAutoConfiguration() {
+		// given
+		ApplicationContextRunner contextRunner = new ApplicationContextRunner()
+			.withUserConfiguration(SpringShellApplication.class)
+			.withConfiguration(AutoConfigurations.of(SpringShellAutoConfiguration.class))
+			.withPropertyValues("spring.shell.interactive.enabled=true");
+
+		// when
+		contextRunner.run(context -> {
+			// then
+			assert (context.getBeansOfType(JLineInputProvider.class).size() == 1);
+			JLineInputProvider jLineInputProvider = context.getBean(JLineInputProvider.class);
+			PromptProvider promptProvider = (PromptProvider) ReflectionTestUtils.getField(jLineInputProvider,
+					"promptProvider");
+			AttributedString prompt = promptProvider.getPrompt();
+			Assertions.assertEquals("myprompt:>", prompt.toString());
+		});
+
+	}
+
+	@SpringBootApplication
+	static class SpringShellApplication {
+
+		@Command
+		public void hi() {
+			System.out.println("Hello world!");
+		}
+
+		@Bean
+		public PromptProvider myPromptProvider() {
+			return () -> new AttributedString("myprompt:>", AttributedStyle.DEFAULT.foreground(AttributedStyle.YELLOW));
+		}
+
+	}
+
+}

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

@@ -55,6 +55,7 @@
 ** xref:customization/styling.adoc[]
 ** xref:customization/logging.adoc[]
 ** xref:customization/contextclose.adoc[]
+** xref:customization/custom-prompt.adoc[]
 * xref:execution.adoc[]
 * xref:testing.adoc[]
 * Appendices

spring-shell-docs/modules/ROOT/pages/customization/custom-prompt.adoc

@@ -0,0 +1,28 @@
+[[custom-prompt]]
+= Custom Prompt
+
+Spring Shell provides various ways to customize the shell prompt and output appearance.
+
+When using the JLine-based shell with Spring Boot, you can customize the shell prompt by implementing the `PromptProvider` interface. This allows you to define your own prompt format.
+
+Here is an example of how to create a custom prompt in a Spring Boot application:
+
+[source,java]
+----
+@SpringBootApplication
+static class SpringShellApplication {
+
+	@Command
+	public void hi() {
+		System.out.println("Hello world!");
+	}
+
+	@Bean
+	public PromptProvider myPromptProvider() {
+		return () -> new AttributedString("myprompt:>", AttributedStyle.DEFAULT.foreground(AttributedStyle.YELLOW));
+	}
+
+}
+----
+
+Adding the above `PromptProvider` bean will change the shell prompt to "myprompt:>" displayed in yellow color.