#164 Support format patterns in version string and printVersionHelp

Closes #164
remkop · Aug 14, 2017 · 0e63404 · 0e63404
1 parent 70a282b
commit 0e63404
Show file tree

Hide file tree

Showing 3 changed files with 46 additions and 0 deletions.
diff --git a/RELEASE-NOTES.adoc b/RELEASE-NOTES.adoc
@@ -3,6 +3,7 @@
 == 1.0.0 - (Work in progress) Public release
 
 * (Work in progress) #121 Added support for command line complete: picocli can generate bash completion scripts that generate completion matches based on `@Option` and `@Command` annotations.
+* #164 Support format patterns in version string and printVersionHelp
 * #166 Fixed bug where adjacent markup sections resulted in incorrect ANSI escape sequences
 
 == 0.9.8 - Bugfix and enhancements release for public review. API may change.

diff --git a/src/main/java/picocli/CommandLine.java b/src/main/java/picocli/CommandLine.java
@@ -460,6 +460,24 @@ public void printVersionHelp(PrintStream out, Help.Ansi ansi) {
             out.println(ansi.new Text(versionInfo));
         }
     }
+    /**
+     * Prints version information from the {@link Command#version()} annotation to the specified {@code PrintStream}.
+     * Each element of the array of version strings is {@linkplain String#format(String, Object...) formatted} with the
+     * specified parameters, and printed on a separate line. Both version strings and parameters may contain
+     * <a href="http://picocli.info/#_usage_help_with_styles_and_colors">markup for colors and style</a>.
+     * @param out the printStream to print to
+     * @param ansi whether the usage message should include ANSI escape codes or not
+     * @param params Arguments referenced by the format specifiers in the version strings
+     * @see Command#version()
+     * @see Option#versionHelp()
+     * @see #isVersionHelpRequested()
+     * @since 1.0.0
+     */
+    public void printVersionHelp(PrintStream out, Help.Ansi ansi, Object... params) {
+        for (String versionInfo : versionLines) {
+            out.println(ansi.new Text(String.format(versionInfo, params)));
+        }
+    }
 
     /**
      * Delegates to {@link #run(Runnable, PrintStream, Help.Ansi, String...)} with {@link Help.Ansi#AUTO}.

diff --git a/src/test/java/picocli/CommandLineHelpTest.java b/src/test/java/picocli/CommandLineHelpTest.java
@@ -1630,4 +1630,31 @@ class Versioned {}
                 "\u001B[34mBuild 12345\u001B[39m\u001B[0m%n" +
                 "\u001B[31m\u001B[47m(c) 2017\u001B[49m\u001B[39m\u001B[0m%n"), result);
     }
+    @Test
+    public void testCommandLine_printVersionInfo_formatsArguments() throws Exception {
+        @Command(version = {"First line %1$s", "Second line %2$s", "Third line %s %s"}) class Versioned {}
+        ByteArrayOutputStream baos = new ByteArrayOutputStream();
+        PrintStream ps = new PrintStream(baos, true, "UTF8");
+        new CommandLine(new Versioned()).printVersionHelp(ps, Help.Ansi.OFF, "VALUE1", "VALUE2", "VALUE3");
+        String result = baos.toString("UTF8");
+        assertEquals(String.format("First line VALUE1%nSecond line VALUE2%nThird line VALUE1 VALUE2%n"), result);
+    }
+
+    @Test
+    public void testCommandLine_printVersionInfo_withMarkupAndParameterContainingMarkup() throws Exception {
+        @Command(version = {
+                "@|yellow Versioned Command 1.0|@",
+                "@|blue Build 12345|@%1$s",
+                "@|red,bg(white) (c) 2017|@%2$s" })
+        class Versioned {}
+        String[] args = {"@|bold VALUE1|@", "@|underline VALUE2|@", "VALUE3"};
+        ByteArrayOutputStream baos = new ByteArrayOutputStream();
+        PrintStream ps = new PrintStream(baos, true, "UTF8");
+        new CommandLine(new Versioned()).printVersionHelp(ps, Help.Ansi.ON, args);
+        String result = baos.toString("UTF8");
+        assertEquals(String.format("" +
+                "\u001B[33mVersioned Command 1.0\u001B[39m\u001B[0m%n" +
+                "\u001B[34mBuild 12345\u001B[39m\u001B[0m\u001B[1mVALUE1\u001B[21m\u001B[0m%n" +
+                "\u001B[31m\u001B[47m(c) 2017\u001B[49m\u001B[39m\u001B[0m\u001B[4mVALUE2\u001B[24m\u001B[0m%n"), result);
+    }
 }