Provide pty info

- Enhance ShellContext for pty info
- Enhance CommandContext to include ShellContext
- Fixes #985

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

@@ -87,6 +87,7 @@
 *** xref:appendices/techintro/registration.adoc[]
 *** xref:appendices/techintro/parser.adoc[]
 *** xref:appendices/techintro/execution.adoc[]
+*** xref:appendices/techintro/shellcontext.adoc[]
 *** xref:appendices/techintro/commandcontext.adoc[]
 *** xref:appendices/techintro/commandcatalog.adoc[]
 *** xref:appendices/techintro/theming.adoc[]

spring-shell-docs/modules/ROOT/pages/appendices/techintro/shellcontext.adoc

@@ -0,0 +1,25 @@
+[[shell-context]]
+= Shell Context
+:page-section-summary-toc: 1
+
+ifndef::snippets[:snippets: ../../../../../src/test/java/org/springframework/shell/docs]
+
+The `ShellContext` interface gives access to a currently running
+shell context. You can use it to get access to a generic shell options.
+
+_InteractionMode_ is telling if shell is running on a _non-interactive_ or
+_interactive_ mode.
+
+[source, java, indent=0]
+----
+include::{snippets}/ShellContextSnippets.java[tag=interactionMode]
+----
+
+_Pty_ is telling if current terminal has a pty features which not a case
+when output is piped into file or if terminal is run in a ci system.
+
+[source, java, indent=0]
+----
+include::{snippets}/ShellContextSnippets.java[tag=hasPty]
+----
+

spring-shell-docs/src/test/java/org/springframework/shell/docs/CommandContextSnippets.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 the original author or authors.
+ * Copyright 2022-2024 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.
@@ -22,7 +22,7 @@ import org.springframework.shell.command.CommandContext;
 @SuppressWarnings("unused")
 public class CommandContextSnippets {
 
-	CommandContext ctx = CommandContext.of(null, null, null, null);
+	CommandContext ctx = CommandContext.of(null, null, null, null, null);
 
 	void dump1() {
 		// tag::snippet1[]

spring-shell-docs/src/test/java/org/springframework/shell/docs/ShellContextSnippets.java

@@ -0,0 +1,54 @@
+/*
+ * Copyright 2024 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.docs;
+
+import org.springframework.shell.context.InteractionMode;
+import org.springframework.shell.context.ShellContext;
+
+@SuppressWarnings("unused")
+class ShellContextSnippets {
+
+	ShellContext ctx = new ShellContext() {
+
+		@Override
+		public InteractionMode getInteractionMode() {
+			return null;
+		}
+
+		@Override
+		public void setInteractionMode(InteractionMode interactionMode) {
+		}
+
+		@Override
+		public boolean hasPty() {
+			return false;
+		}
+
+	};
+
+	void dump1() {
+		// tag::hasPty[]
+		boolean hasPty = ctx.hasPty();
+		// end::hasPty[]
+	}
+
+	void dump2() {
+		// tag::interactionMode[]
+		InteractionMode interactionMode = ctx.getInteractionMode();
+		// end::interactionMode[]
+	}
+
+}