Improve terminal help text

Fixes quarkusio#23036
stuartwdouglas · Jan 24, 2022 · e194757 · e194757
1 parent 685d832
commit e194757
Show file tree

Hide file tree

Showing 6 changed files with 53 additions and 5 deletions.
diff --git a/core/deployment/src/main/java/io/quarkus/deployment/console/AeshConsole.java b/core/deployment/src/main/java/io/quarkus/deployment/console/AeshConsole.java
@@ -70,6 +70,7 @@ protected Boolean initialValue() {
     private final StatusLine prompt;
 
     private volatile boolean pauseOutput;
+    private volatile boolean firstConsoleRun = true;
     private DelegateConnection delegateConnection;
     private ReadlineConsole aeshConsole;
 
@@ -528,8 +529,14 @@ public void runAeshCli() {
             pauseOutput = true;
             delegateConnection = new DelegateConnection(connection);
             connection.write(ALTERNATE_SCREEN_BUFFER);
+            if (firstConsoleRun) {
+                connection.write(
+                        "You are now in Quarkus Terminal. Your app is still running. Use `help` or tab completion to explore, `quit` or `q` to return to your application.\n");
+                firstConsoleRun = false;
+            }
             AeshCommandRegistryBuilder<CommandInvocation> commandBuilder = AeshCommandRegistryBuilder.builder();
             ConsoleCliManager.commands.forEach(commandBuilder::command);
+
             CommandRegistry registry = commandBuilder
                     .create();
             Settings settings = SettingsBuilder

diff --git a/core/deployment/src/main/java/io/quarkus/deployment/console/ConsoleProcessor.java b/core/deployment/src/main/java/io/quarkus/deployment/console/ConsoleProcessor.java
@@ -188,4 +188,24 @@ public CommandResult execute(CommandInvocation commandInvocation) throws Command
             return CommandResult.SUCCESS;
         }
     }
+
+    @BuildStep
+    ConsoleCommandBuildItem helpCommand() {
+        return new ConsoleCommandBuildItem(new HelpCommand());
+    }
+
+    @CommandDefinition(name = "help", description = "Displays the command list", aliases = { "h" })
+    public static class HelpCommand implements Command {
+
+        @Override
+        public CommandResult execute(CommandInvocation commandInvocation) throws CommandException, InterruptedException {
+            commandInvocation.getShell().writeln("The following commands are available, run them with -h for more info:\n");
+            for (var c : ConsoleCliManager.commands) {
+                commandInvocation.getShell().writeln(
+                        c.getParser().getProcessedCommand().name() + "\t" + c.getParser().getProcessedCommand().description());
+            }
+
+            return CommandResult.SUCCESS;
+        }
+    }
 }
diff --git a/core/deployment/src/main/java/io/quarkus/deployment/console/QuarkusCommand.java b/core/deployment/src/main/java/io/quarkus/deployment/console/QuarkusCommand.java
@@ -10,11 +10,18 @@
 
 public abstract class QuarkusCommand implements Command {
 
-    @Option(shortName = 'd', hasValue = false)
+    @Option(shortName = 'd', hasValue = false, description = "Return to the application after the command has run")
     public boolean done;
 
+    @Option(shortName = 'h', hasValue = false, overrideRequired = true)
+    public boolean help;
+
     @Override
     public CommandResult execute(CommandInvocation commandInvocation) throws CommandException, InterruptedException {
+        if (help) {
+            commandInvocation.getShell().write(commandInvocation.getHelpInfo());
+            return CommandResult.SUCCESS;
+        }
         var result = doExecute(commandInvocation);
         if (done) {
             QuarkusConsole.INSTANCE.exitCliMode();

diff --git a/core/deployment/src/main/java/io/quarkus/deployment/logging/LoggingResourceProcessor.java b/core/deployment/src/main/java/io/quarkus/deployment/logging/LoggingResourceProcessor.java
@@ -525,24 +525,28 @@ ConsoleCommandBuildItem logConsoleCommand() {
     @GroupCommandDefinition(name = "log", description = "Logging Commands")
     public static class LogCommand implements GroupCommand {
 
+        @Option(shortName = 'h', hasValue = false, overrideRequired = true)
+        public boolean help;
+
         @Override
         public List<Command> getCommands() {
             return List.of(new SetLogLevelCommand());
         }
 
         @Override
         public CommandResult execute(CommandInvocation commandInvocation) throws CommandException, InterruptedException {
+            commandInvocation.getShell().writeln(commandInvocation.getHelpInfo());
             return CommandResult.SUCCESS;
         }
     }
 
     @CommandDefinition(name = "set-level", description = "Sets the log level for a logger")
     public static class SetLogLevelCommand extends QuarkusCommand {
 
-        @Option(required = true, completer = LoggerCompleter.class)
+        @Option(required = true, completer = LoggerCompleter.class, description = "The logger to modify")
         private String logger;
 
-        @Option(required = true, completer = LevelCompleter.class)
+        @Option(required = true, completer = LevelCompleter.class, description = "The log level")
         private String level;
 
         @Override

diff --git a/...ostgresql/src/main/java/io/quarkus/devservices/postgresql/deployment/PostgresCommand.java b/...ostgresql/src/main/java/io/quarkus/devservices/postgresql/deployment/PostgresCommand.java
@@ -8,6 +8,7 @@
 import org.aesh.command.GroupCommand;
 import org.aesh.command.GroupCommandDefinition;
 import org.aesh.command.invocation.CommandInvocation;
+import org.aesh.command.option.Option;
 
 import io.quarkus.deployment.builditem.DevServicesLauncherConfigResultBuildItem;
 
@@ -16,6 +17,9 @@ public class PostgresCommand implements GroupCommand {
 
     private final DevServicesLauncherConfigResultBuildItem devServicesLauncherConfigResultBuildItem;
 
+    @Option(shortName = 'h', hasValue = false, overrideRequired = true)
+    public boolean help;
+
     public PostgresCommand(DevServicesLauncherConfigResultBuildItem devServicesLauncherConfigResultBuildItem) {
         this.devServicesLauncherConfigResultBuildItem = devServicesLauncherConfigResultBuildItem;
     }
@@ -27,6 +31,7 @@ public List<Command> getCommands() {
 
     @Override
     public CommandResult execute(CommandInvocation commandInvocation) throws CommandException, InterruptedException {
-        return null;
+        commandInvocation.getShell().writeln(commandInvocation.getHelpInfo());
+        return CommandResult.SUCCESS;
     }
 }
diff --git a/...src/main/java/io/quarkus/vertx/http/deployment/devmode/console/ConfigEditorProcessor.java b/...src/main/java/io/quarkus/vertx/http/deployment/devmode/console/ConfigEditorProcessor.java
@@ -27,6 +27,7 @@
 import org.aesh.command.completer.OptionCompleter;
 import org.aesh.command.invocation.CommandInvocation;
 import org.aesh.command.option.Argument;
+import org.aesh.command.option.Option;
 import org.aesh.command.validator.CommandValidator;
 import org.aesh.command.validator.CommandValidatorException;
 
@@ -293,11 +294,14 @@ private boolean isSetByDevServices(Optional<DevServicesLauncherConfigResultBuild
         return false;
     }
 
-    @GroupCommandDefinition(name = "config", description = "Config Commands")
+    @GroupCommandDefinition(name = "config", description = "Config Editing Commands")
     public static class ConfigCommandGroup implements GroupCommand {
 
         final ConfigDescriptionsManager configDescriptionsManager;
 
+        @Option(shortName = 'h', hasValue = false, overrideRequired = true)
+        public boolean help;
+
         public ConfigCommandGroup(ConfigDescriptionsManager configDescriptionsManager) {
             this.configDescriptionsManager = configDescriptionsManager;
         }
@@ -309,6 +313,7 @@ public List<Command> getCommands() {
 
         @Override
         public CommandResult execute(CommandInvocation commandInvocation) throws CommandException, InterruptedException {
+            commandInvocation.getShell().writeln(commandInvocation.getHelpInfo());
             return CommandResult.SUCCESS;
         }
     }