Updates for better help command

Author: mikera

convex-cli/src/main/java/convex/cli/ACommand.java

@@ -23,10 +23,15 @@ public abstract class ACommand implements Runnable {
 
 	public void showUsage() {
 		CommandLine cl=new CommandLine(this);
+		showUsage(cl);
+	}
+	
+	protected void showUsage(CommandLine cl) {
 		cl.setUsageHelpAutoWidth(true);
 		cl.setUsageHelpWidth(100);
 		cl.setUsageHelpLongOptionsMaxWidth(40);
-		cl.usage(cli().commandLine().getOut(),Help.defaultColorScheme(Ansi.ON));
+		Ansi ansi=cli().isColoured()?Ansi.ON:Ansi.OFF;
+		cl.usage(cli().commandLine().getOut(),Help.defaultColorScheme(ansi));
 	}
 
 	public CommandLine commandLine() {

convex-cli/src/main/java/convex/cli/ATopCommand.java

@@ -2,6 +2,9 @@
 
 import picocli.CommandLine.ParentCommand;
 
+/**
+ * Abstract base class for top level subcommands, i.e. convex xxxx
+ */
 public abstract class ATopCommand extends ACommand {
 
 	@ParentCommand

convex-cli/src/main/java/convex/cli/Help.java

@@ -0,0 +1,36 @@
+package convex.cli;
+
+import java.io.PrintWriter;
+
+import picocli.CommandLine;
+import picocli.CommandLine.Command;
+import picocli.CommandLine.Help.ColorScheme;
+import picocli.CommandLine.IHelpCommandInitializable2;
+import picocli.CommandLine.ParentCommand;
+
+@Command(
+		name="help",
+		description="Show usage help",
+		helpCommand = true)
+public class Help extends ACommand implements IHelpCommandInitializable2  {
+
+	@ParentCommand
+	protected ACommand parent;
+	protected CommandLine commandLine=null;
+
+	@Override
+	public void init(CommandLine helpCommandLine, ColorScheme colorScheme, PrintWriter outWriter,
+			PrintWriter errWriter) {
+		this.commandLine=helpCommandLine;
+	}
+
+	@Override
+	public Main cli() {
+		return parent.cli();
+	}
+
+	@Override
+	protected void execute() throws InterruptedException {
+		parent.showUsage();
+	}
+}

convex-cli/src/main/java/convex/cli/Main.java

@@ -36,8 +36,7 @@
  */
 @Command(name = "convex", 
 		subcommands = { Account.class, Key.class, Local.class, Peer.class, Query.class, Status.class, Desktop.class,
-		Etch.class, Transact.class,
-		CommandLine.HelpCommand.class }, 
+		Etch.class, Transact.class, Help.class }, 
 		usageHelpAutoWidth = true, 
 		sortOptions = true, 
 		mixinStandardHelpOptions = true,
@@ -52,8 +51,12 @@
 public class Main extends ACommand {
 	private static Logger log = LoggerFactory.getLogger(Main.class);
 
-	public CommandLine commandLine = new CommandLine(this);
-
+	public CommandLine commandLine;
+	
+	public Main() {
+		commandLine= new CommandLine(this);
+		commandLine.setExecutionExceptionHandler(new Main.ExceptionHandler());
+	}
 
 	@Option(names = { "-S","--strict-security" }, 
 			defaultValue = "false", 
@@ -78,10 +81,6 @@ public class Main extends ACommand {
 			description = "Specify verbosity level. Use -v0 to suppress user output, -v5 for all log output. Default: ${DEFAULT-VALUE}") 
 	private Integer verbose;
 
-	public Main() {
-		commandLine = commandLine.setExecutionExceptionHandler(new Main.ExceptionHandler());
-	}
-
 	@Override
 	public void execute() {
 		String art=Helpers.getConvexArt();
@@ -170,7 +169,7 @@ public static final class VersionProvider implements IVersionProvider {
 		@Override
 		public String[] getVersion() throws Exception {
 			String s = Utils.getVersion();
-			return new String[] { "Convex version: " + s };
+			return new String[] { s };
 		}
 	}
 

convex-cli/src/main/java/convex/cli/peer/Peer.java

@@ -2,7 +2,7 @@
 
 import convex.cli.ATopCommand;
 import convex.cli.Constants;
-import picocli.CommandLine;
+import convex.cli.Help;
 import picocli.CommandLine.Command;
 import picocli.CommandLine.Option;
 import picocli.CommandLine.ScopeType;
@@ -21,7 +21,7 @@
 		PeerStart.class,
 		PeerList.class,
 		PeerGenesis.class,
-		CommandLine.HelpCommand.class
+		Help.class
 	},
 	mixinStandardHelpOptions=true,
 	description="Operate a Convex Peer")

convex-cli/src/test/java/convex/cli/CLIHelpTest.java

@@ -8,9 +8,8 @@ public class CLIHelpTest {
 
 	@Test
 	public void testHelp() {
-		assertExecuteCommandLineResult(0, "^Usage: convex ", "--help");
-		assertExecuteCommandLineResult(0, "^Usage: convex ", "-h");
-		assertExecuteCommandLineResult(0, "^Usage: convex ", "help");
+		assertExecuteCommandLineResult(0, "^Usage: convex ", "--help", "--no-color");
+		assertExecuteCommandLineResult(0, "^Usage: convex ", "-h", "--no-color");
 		assertExecuteCommandLineResult(0, "^Usage: convex account ", "account", "help");
 		assertExecuteCommandLineResult(0, "^Usage: convex account balance ", "account",  "balance", "--help");
 		assertExecuteCommandLineResult(0, "^Usage: convex account create ", "account",  "create", "--help");
@@ -19,14 +18,15 @@ public void testHelp() {
 		assertExecuteCommandLineResult(0, "^Usage: convex key ", "key", "help");
 		assertExecuteCommandLineResult(0, "^Usage: convex key generate ", "key", "generate", "--help");
 		assertExecuteCommandLineResult(0, "^Usage: convex key list ", "key", "list", "--help");
-		assertExecuteCommandLineResult(0, "^Usage: convex peer ", "peer", "help");
-		assertExecuteCommandLineResult(0, "^Usage: convex peer start ", "peer", "start", "--help");
+		assertExecuteCommandLineResult(0, "^Usage: convex peer ", "peer", "-h", "--no-color");
+		assertExecuteCommandLineResult(0, "^Usage: convex peer start ", "peer", "start", "--help", "--no-color");
 		assertExecuteCommandLineResult(0, "^Usage: convex local ", "local", "--help");
 		assertExecuteCommandLineResult(0, "^Usage: convex local start ", "local", "start", "--help");
 		assertExecuteCommandLineResult(0, "^Usage: convex local gui ", "local", "gui", "--help");
 		assertExecuteCommandLineResult(0, "^Usage: convex query ", "query", "--help");
 		assertExecuteCommandLineResult(0, "^Usage: convex status ", "status", "--help");
 		assertExecuteCommandLineResult(0, "^Usage: convex transact ", "transact", "--help");
+		// assertExecuteCommandLineResult(0, "^Usage: convex \\[", "help", "--help", "--no-color");
 	}
 
 }

convex-cli/src/test/java/convex/cli/HelperTest.java

@@ -18,9 +18,9 @@ public void testSplitArray() {
 		assertEquals(List.of("a"),Helpers.splitArrayParameter(" a "));
 	}
 
-	public static void assertExecuteCommandLineResult(int returnCode, String patternText, String ... args) {
+	public static void assertExecuteCommandLineResult(int exitCode, String patternText, String ... args) {
 		CLTester tester =  CLTester.run(args);
-		assertEquals(returnCode, tester.getResult());
+		tester.assertExitCode(exitCode);;
 
 		String output=tester.getOutput();
 		Pattern regex = Pattern.compile(patternText, Pattern.MULTILINE + Pattern.DOTALL);