Enrich help message

takahi-i · Mar 25, 2018 · 7a56544 · 7a56544
1 parent 60e4af3
commit 7a56544
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/redpen-cli/pom.xml b/redpen-cli/pom.xml
@@ -117,7 +117,7 @@
         <dependency>
             <groupId>commons-cli</groupId>
             <artifactId>commons-cli</artifactId>
-            <version>1.2</version>
+            <version>1.4</version>
         </dependency>
         <dependency>
             <groupId>ch.qos.logback</groupId>

diff --git a/redpen-cli/src/main/java/cc/redpen/Main.java b/redpen-cli/src/main/java/cc/redpen/Main.java
@@ -46,6 +46,13 @@ public final class Main {
 
     private static final int DEFAULT_LIMIT = 1;
 
+    private static final String HELP_HEADER = "\nValidate input documents with specified configuration settings.\n\nOptions:\n";
+
+    private static final String HELP_FOOTER = "\n\nExample:\n\n" +
+                                              "$redpen -c redpen-config.xml input.md\n\n" +
+                                              "Note:\n" +
+                                              "Setting files can be generated in http://redpen.herokuapp.com/\n";
+
     private Main() {
         super();
     }
@@ -279,7 +286,7 @@ private static void printHelp(Options opt) {
         HelpFormatter formatter = new HelpFormatter();
         formatter.setWidth(100);
         PrintWriter pw = new PrintWriter(System.err);
-        formatter.printHelp(pw, 80, PROGRAM + " [Options] [<INPUT FILE>]", null, opt, 1, 3, "");
+        formatter.printHelp(pw, 80, PROGRAM + " [Options] [<INPUT FILE>]", HELP_HEADER, opt, 1, 3, HELP_FOOTER);
         pw.flush();
     }