Write documentation of EasySign.CommandLine classes

Author: Aeliux

src/EasySign.CommandLine/BundleWorker.cs

@@ -10,10 +10,22 @@ namespace SAPTeam.EasySign.CommandLine
     public abstract partial class CommandProvider<T>
         where T : Bundle
     {
-        public T Bundle { get; protected set; }
-
+        /// <summary>
+        /// Gets or sets the bundle.
+        /// </summary>
+        public T? Bundle { get; protected set; }
+
+        /// <summary>
+        /// Initializes the bundle with the specified working directory and bundle name.
+        /// </summary>
+        /// <param name="workingDirectory">The working directory.</param>
+        /// <param name="bundleName">The bundle name.</param>
         public abstract void InitializeBundle(string workingDirectory, string bundleName);
 
+        /// <summary>
+        /// Runs the add command.
+        /// </summary>
+        /// <param name="statusContext">The status context for interacting with <see cref="AnsiConsole.Status"/>.</param>
         protected virtual void RunAdd(StatusContext statusContext)
         {
             if (Bundle == null)
@@ -35,6 +47,11 @@ protected virtual void RunAdd(StatusContext statusContext)
             Bundle.Update();
         }
 
+        /// <summary>
+        /// Runs the sign command.
+        /// </summary>
+        /// <param name="statusContext">The status context for interacting with <see cref="AnsiConsole.Status"/>.</param>
+        /// <param name="certificates">The certificates.</param>
         protected virtual void RunSign(StatusContext statusContext, X509Certificate2Collection certificates)
         {
             if (Bundle == null)
@@ -80,6 +97,10 @@ protected virtual void RunSign(StatusContext statusContext, X509Certificate2Coll
             Bundle.Update();
         }
 
+        /// <summary>
+        /// Runs the verify command.
+        /// </summary>
+        /// <param name="statusContext">The status context for interacting with <see cref="AnsiConsole.Status"/>.</param>
         protected virtual void RunVerify(StatusContext statusContext)
         {
             if (Bundle == null)
@@ -200,6 +221,11 @@ protected virtual void RunVerify(StatusContext statusContext)
             AnsiConsole.MarkupLine("[green]Bundle Verification Completed Successfully[/]");
         }
 
+        /// <summary>
+        /// Verifies the validity of a certificate.
+        /// </summary>
+        /// <param name="certificate">The certificate to verify.</param>
+        /// <returns>True if the certificate is valid; otherwise, false.</returns>
         protected bool VerifyCertificate(X509Certificate2 certificate)
         {
             if (Bundle == null)

src/EasySign.CommandLine/CommandProvider.cs

@@ -8,23 +8,40 @@
 
 namespace SAPTeam.EasySign.CommandLine
 {
+    /// <summary>
+    /// Provides command definitions and handlers for the EasySign command line interface.
+    /// </summary>
+    /// <typeparam name="T">The type of the bundle.</typeparam>
     public abstract partial class CommandProvider<T>
     {
+        /// <summary>
+        /// Gets the common argument for the working directory.
+        /// </summary>
         protected Argument<string> WorkingDirectory { get; } = new Argument<string>("directory", "Working directory");
 
+        /// <summary>
+        /// Gets the common option for the bundle file name.
+        /// </summary>
         protected Option<string> BundleName { get; } = new Option<string>("-f", () => ".eSign", "Bundle file name");
 
+        /// <summary>
+        /// Gets the root command for the command line interface.
+        /// </summary>
+        /// <returns>The root command.</returns>
         public abstract RootCommand GetRootCommand();
 
+        /// <summary>
+        /// Gets the command for creating a new bundle or updating an existing one.
+        /// </summary>
         public Command Add
         {
             get
             {
                 var command = new Command("add", "Create new bundle or update an existing one")
-                {
-                    WorkingDirectory,
-                    BundleName,
-                };
+                    {
+                        WorkingDirectory,
+                        BundleName,
+                    };
 
                 command.SetHandler((workingDir, bundleName) =>
                 {
@@ -36,6 +53,9 @@ public Command Add
             }
         }
 
+        /// <summary>
+        /// Gets the command for signing bundle with one or more certificate.
+        /// </summary>
         public Command Sign
         {
             get
@@ -45,13 +65,13 @@ public Command Sign
                 var pfxNoPassOpt = new Option<bool>("--no-password", "Ignore PFX File password prompt");
 
                 var command = new Command("sign", "Sign bundle with certificate")
-                {
-                    WorkingDirectory,
-                    BundleName,
-                    pfxOpt,
-                    pfxPassOpt,
-                    pfxNoPassOpt,
-                };
+                    {
+                        WorkingDirectory,
+                        BundleName,
+                        pfxOpt,
+                        pfxPassOpt,
+                        pfxNoPassOpt,
+                    };
 
                 command.SetHandler((workingDir, bundleName, pfxFilePath, pfxFilePassword, pfxNoPasswordPrompt) =>
                 {
@@ -65,15 +85,18 @@ public Command Sign
             }
         }
 
+        /// <summary>
+        /// Gets the command for verifying bundle.
+        /// </summary>
         public Command Verify
         {
             get
             {
                 var command = new Command("verify", "Verify bundle")
-                {
-                    WorkingDirectory,
-                    BundleName,
-                };
+                    {
+                        WorkingDirectory,
+                        BundleName,
+                    };
 
                 command.SetHandler((workingDir, bundleName) =>
                 {

src/EasySign.CommandLine/Utils.cs

@@ -9,8 +9,15 @@
 
 namespace SAPTeam.EasySign.CommandLine
 {
+    /// <summary>
+    /// Provides utility methods for various operations.
+    /// </summary>
     public static class Utils
     {
+        /// <summary>
+        /// Runs the specified action within a status context, provides fancy progress showing.
+        /// </summary>
+        /// <param name="action">The action to run within the status context.</param>
         public static void RunInStatusContext(Action<StatusContext> action)
         {
             AnsiConsole.Status()
@@ -19,6 +26,12 @@ public static void RunInStatusContext(Action<StatusContext> action)
                 .Start("", action);
         }
 
+        /// <summary>
+        /// Safely enumerates files in the specified path that match the search pattern.
+        /// </summary>
+        /// <param name="path">The path to search for files.</param>
+        /// <param name="searchPattern">The search pattern to match files.</param>
+        /// <returns>An enumerable collection of file paths.</returns>
         public static IEnumerable<string> SafeEnumerateFiles(string path, string searchPattern)
         {
             ConcurrentQueue<string> folders = new();
@@ -57,6 +70,13 @@ public static IEnumerable<string> SafeEnumerateFiles(string path, string searchP
             }
         }
 
+        /// <summary>
+        /// Retrieves a collection of certificates from a PFX file or the current user's certificate store.
+        /// </summary>
+        /// <param name="pfxFilePath">The path to the PFX file.</param>
+        /// <param name="pfxFilePassword">The password for the PFX file.</param>
+        /// <param name="pfxNoPasswordPrompt">Indicates whether to prompt for a password if not provided.</param>
+        /// <returns>A collection of certificates.</returns>
         public static X509Certificate2Collection GetCertificates(string pfxFilePath, string pfxFilePassword, bool pfxNoPasswordPrompt)
         {
             X509Certificate2Collection collection = new();
@@ -66,7 +86,7 @@ public static X509Certificate2Collection GetCertificates(string pfxFilePath, str
                 string pfpass = !string.IsNullOrEmpty(pfxFilePassword) ? pfxFilePassword : !pfxNoPasswordPrompt ? SecurePrompt("Enter PFX File password (if needed): ") : "";
 
 #if NET9_0_OR_GREATER
-                var tempCollection = X509CertificateLoader.LoadPkcs12CollectionFromFile(pfxFilePath, pfpass, X509KeyStorageFlags.EphemeralKeySet);
+                    var tempCollection = X509CertificateLoader.LoadPkcs12CollectionFromFile(pfxFilePath, pfpass, X509KeyStorageFlags.EphemeralKeySet);
 #else
                 var tempCollection = new X509Certificate2Collection();
                 tempCollection.Import(pfxFilePath, pfpass, X509KeyStorageFlags.EphemeralKeySet);
@@ -105,6 +125,11 @@ public static X509Certificate2Collection GetCertificates(string pfxFilePath, str
             return collection;
         }
 
+        /// <summary>
+        /// Prompts the user for input securely, hiding the input as it is typed.
+        /// </summary>
+        /// <param name="prompt">The prompt message to display.</param>
+        /// <returns>The user input.</returns>
         public static string SecurePrompt(string prompt)
         {
             return AnsiConsole.Prompt(
@@ -114,6 +139,10 @@ public static string SecurePrompt(string prompt)
                     .Secret(null));
         }
 
+        /// <summary>
+        /// Enumerates and displays the statuses of an X509 certificate chain.
+        /// </summary>
+        /// <param name="statuses">The array of X509 chain statuses.</param>
         public static void EnumerateStatuses(X509ChainStatus[] statuses)
         {
             foreach (var status in statuses)