Fully use CommandLine modelling

Author: mnadareski

Hasher/Options.cs Hasher/HashFeature.csHasher/Options.cs renamed to Hasher/HashFeature.cs

@@ -12,17 +12,15 @@ namespace Hasher
     /// Set of options for the test executable
     /// </summary>
     /// TODO: Add file output
-    internal sealed class Options : Feature
+    internal sealed class HashFeature : Feature
     {
         #region Feature Definition
 
         public const string DisplayName = "options";
 
-        /// <remarks>Default feature does not use flags</remarks>
-        private static readonly string[] _flags = [];
+        private static readonly string[] _flags = ["hash"];
 
-        /// <remarks>Default feature does not use description</remarks>
-        private const string _description = "";
+        private const string _description = "Hash all input paths (default)";
 
         #endregion
 
@@ -42,13 +40,13 @@ internal sealed class Options : Feature
 
         #region Constructors
 
-        public Options()
+        public HashFeature()
             : base(DisplayName, _flags, _description)
         {
             RequiresInputs = true;
 
             Add(new FlagInput("debug", ["-d", "--debug"], "Enable debug mode"));
-            Add(new StringListInput("type", ["-t", "--type"], "Output file hashes"));
+            Add(new StringListInput("type", ["-t", "--type"], "Select included hashes"));
         }
 
         #endregion
@@ -86,13 +84,6 @@ public override bool ProcessArgs(string[] args, int index)
                 }
             }
 
-            // Validate we have any input paths to work on
-            if (!VerifyInputs())
-            {
-                Console.WriteLine("At least one path is required!");
-                return false;
-            }
-
             return true;
         }
 
@@ -110,28 +101,6 @@ public override bool Execute()
             return true;
         }
 
-        /// <summary>
-        /// Display help text
-        /// </summary>
-        /// TODO: Replace this with standard help output
-        public static void DisplayHelp()
-        {
-            Console.WriteLine("File Hashing Program");
-            Console.WriteLine();
-            Console.WriteLine("Hasher <options> file|directory ...");
-            Console.WriteLine();
-            Console.WriteLine("Options:");
-            Console.WriteLine("-?, -h, --help           Display this help text and quit");
-            Console.WriteLine("-d, --debug              Enable debug mode");
-            Console.WriteLine("-l, --list               List all available hashes and quit");
-            Console.WriteLine("-t, --type [TYPE]        Output file hashes");
-            Console.WriteLine();
-            Console.WriteLine("If no hash types are provided, this tool will default");
-            Console.WriteLine("to outputting CRC-32, MD5, SHA-1, and SHA-256.");
-            Console.WriteLine("Optionally, all supported hashes can be output");
-            Console.WriteLine("by specifying a value of 'all'.");
-        }
-
         /// <summary>
         /// Wrapper to print hashes for a single path
         /// </summary>

Hasher/HelpFeature.cs

@@ -0,0 +1,28 @@
+
+
+using SabreTools.CommandLine;
+
+namespace Hasher
+{
+    /// <remarks>Copied implementation from CommandLine until printing is fixed</remarks>
+    internal sealed class HelpFeature : Feature
+    {
+        public const string DisplayName = "Help";
+
+        private static readonly string[] _flags = ["-?", "-h", "--help"];
+
+        private const string _description = "Show this help";
+
+        public HelpFeature()
+            : base(DisplayName, _flags, _description)
+        {
+            RequiresInputs = false;
+        }
+
+        /// <inheritdoc/>
+        public override bool VerifyInputs() => true;
+
+        /// <inheritdoc/>
+        public override bool Execute() => true;
+    }
+}

Hasher/ListFeature.cs

@@ -4,7 +4,7 @@
 
 namespace Hasher
 {
-    internal class ListFeature : Feature
+    internal sealed class ListFeature : Feature
     {
         #region Feature Definition
 

Hasher/Program.cs

@@ -1,6 +1,6 @@
-using System.Collections.Generic;
+using System;
+using System.Collections.Generic;
 using SabreTools.CommandLine;
-using SabreTools.CommandLine.Features;
 
 namespace Hasher
 {
@@ -22,10 +22,11 @@ public static class Program
         /// Help footer
         /// </summary>
         private static readonly List<string> _footer = [
-            "If no hash types are provided, this tool will default",
-            "to outputting CRC-32, MD5, SHA-1, and SHA-256.",
-            "Optionally, all supported hashes can be output",
-            "by specifying a value of 'all'.",
+            string.Empty,
+            "If no hash types are provided, this tool will default to",
+            "outputting CRC-32, MD5, SHA-1, and SHA-256.",
+            "Optionally, all supported hashes can be output by",
+            "specifying a value of 'all'.",
         ];
 
         #endregion
@@ -34,15 +35,15 @@ public static void Main(string[] args)
         {
             // Build the command set
             var commandSet = new CommandSet(_header, _footer);
-            commandSet.Add(new Help(["-?", "-h", "--help"]));
+            commandSet.Add(new HelpFeature());
             commandSet.Add(new ListFeature());
-            var options = new Options();
-            commandSet.Add(options);
+            var hashFeature = new HashFeature();
+            commandSet.Add(hashFeature);
 
             // If there are no arguments
             if (args.Length == 0)
             {
-                Options.DisplayHelp();
+                commandSet.OutputAllHelp();
                 return;
             }
 
@@ -51,26 +52,29 @@ public static void Main(string[] args)
 
             // Check if the feature is recognized
             var feature = commandSet.GetTopLevel(featureName);
-            if (feature is Help)
+            switch (feature)
             {
-                Options.DisplayHelp();
-                return;
+                case HelpFeature: commandSet.OutputAllHelp(); return;
+                case ListFeature lf: lf.Execute(); return;
             }
-            else if (feature is ListFeature lf)
+
+            // Otherwise, process the arguments normally
+            if (!hashFeature.ProcessArgs(args, 0))
             {
-                lf.Execute();
+                commandSet.OutputAllHelp();
                 return;
             }
 
-            // Otherwise, process the arguments normally
-            if (!options.ProcessArgs(args, 0))
+            // If there are no valid inputs
+            if (hashFeature.RequiresInputs && !hashFeature.VerifyInputs())
             {
-                commandSet.OutputGenericHelp();
+                Console.WriteLine("At least one path is required!");
+                commandSet.OutputAllHelp();
                 return;
             }
 
             // Execute based on the options set
-            options.Execute();
+            hashFeature.Execute();
         }
     }
 }

README.MD

@@ -19,16 +19,17 @@ For the latest WIP build here: [Rolling Release](https://github.com/SabreTools/S
 ```
 Hasher <options> file|directory ...
 
-Options:
--?, -h, --help           Display this help text and quit
--d, --debug              Enable debug mode
--l, --list               List all available hashes and quit
--t, --type [TYPE]        Output file hashes
-
-If no hash types are provided, this tool will default
-to outputting CRC-32, MD5, SHA-1, and SHA-256.
-Optionally, all supported hashes can be output
-by specifying a value of 'all'.
+Available options:
+  -?, -h, --help              Show this help
+  -l, --list                  List all available hashes and quit
+  hash                        Hash all input paths (default)
+      -d, --debug                 Enable debug mode
+      -t=, --type=                Select included hashes
+
+If no hash types are provided, this tool will default to
+outputting CRC-32, MD5, SHA-1, and SHA-256.
+Optionally, all supported hashes can be output by
+specifying a value of 'all'.
 ```
 
 ## Internal Implementations