Add usage examples in help

mnieto · Jun 7, 2020 · 7e68ce7 · 7e68ce7
1 parent 7358593
commit 7e68ce7
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/ConfigSectionCrypt/Options.cs b/ConfigSectionCrypt/Options.cs
@@ -1,5 +1,6 @@
 using System.Collections.Generic;
 using CommandLine;
+using CommandLine.Text;
 
 public class Options {
     [Option('e', "encrypt", SetName = "encrypt", HelpText = "Encrypt the enumerated sections", Required = true)]
@@ -20,5 +21,22 @@ public class Options {
     [Option('l', "loglevel", HelpText = "Logging level: Quiet, Normal, Verbose", Default = Verbosity.Normal)]
     public Verbosity LogLevel { get; set; }
 
+    [Usage()]
+    public static IEnumerable<Example> Usage {
+        get {
+            yield return new Example("Encrypt multiple sections", new Options {
+                Encrypt = true,
+                ConfigFile = "MyApp.exe.config",
+                Section = "configurationStrings,SharedFolders".Split(','),
+                Include = @"c:\Path\To\Custom\DLL\SharedFolders.dll".Split(',')
+            });
+            yield return new Example("Decript connectionStrings section", new Options {
+                Decrypt = true,
+                ConfigFile = "MyApp.exe.config",
+                Section = "configurationStrings".Split(',')
+            });
+        }
+    }
+
     internal char Operation { get; set; }
 }