Fix typos and code style (microsoft#741)

* Fix filename containing a space (`ApiKeyAuthenticationHandler .cs`)
* Fix typos
* Fix code style
* Add missing rule for local constants
* Add commented code to automate code style checks. These don't work
with .NET Standard 2.0, so we'll need some extra research.
* Fix one incorrect ILogger naming
* Add some TODOs about unused code
* Fix xmldocs

samples/apps/copilot-chat-app/webapi/Auth/ApiKeyAuthenticationHandler .cs → samples/apps/copilot-chat-app/webapi/Auth/ApiKeyAuthenticationHandler.cs

@@ -16,6 +16,7 @@ public class ApiKeyAuthenticationHandler : AuthenticationHandler<ApiKeyAuthentic
     public const string AuthenticationScheme = "ApiKey";
     public const string ApiKeyHeaderName = "x-api-key";
 
+    // TODO: not used?
     private readonly IOptionsMonitor<ApiKeyAuthenticationSchemeOptions> _options;
 
     /// <summary>

samples/apps/copilot-chat-app/webapi/Config/PlannerOptions.cs

@@ -35,17 +35,17 @@ public class PlannerOptions
     /// <summary>
     /// A list of skills to exclude from the plan creation request.
     /// </summary>
-    public HashSet<string> ExcludedSkills { get; set; } = new() { };
+    public HashSet<string> ExcludedSkills { get; set; } = new();
 
     /// <summary>
     /// A list of functions to exclude from the plan creation request.
     /// </summary>
-    public HashSet<string> ExcludedFunctions { get; set; } = new() { };
+    public HashSet<string> ExcludedFunctions { get; set; } = new();
 
     /// <summary>
     /// A list of functions to include in the plan creation request.
     /// </summary>
-    public HashSet<string> IncludedFunctions { get; set; } = new() { };
+    public HashSet<string> IncludedFunctions { get; set; } = new();
 
     /// <summary>
     /// The maximum number of tokens to allow in a plan.

samples/apps/copilot-chat-app/webapi/Controllers/BotController.cs

@@ -8,15 +8,14 @@
 using Microsoft.SemanticKernel.Memory;
 using SemanticKernel.Service.Config;
 using SemanticKernel.Service.Model;
-using SemanticKernel.Service.Skills;
 using SemanticKernel.Service.Storage;
 
 namespace SemanticKernel.Service.Controllers;
 
 [ApiController]
 public class BotController : ControllerBase
 {
-    private readonly ILogger<SemanticKernelController> _logger;
+    private readonly ILogger<BotController> _logger;
     private readonly IMemoryStore _memoryStore;
     private readonly ChatSessionRepository _chatRepository;
     private readonly ChatMessageRepository _chatMessageRepository;
@@ -32,7 +31,7 @@ public class BotController : ControllerBase
         IMemoryStore memoryStore,
         ChatSessionRepository chatRepository,
         ChatMessageRepository chatMessageRepository,
-        ILogger<SemanticKernelController> logger)
+        ILogger<BotController> logger)
     {
         this._logger = logger;
         this._memoryStore = memoryStore;
@@ -177,7 +176,7 @@ public class BotController : ControllerBase
     private async Task<Bot> CreateBotAsync(
         IKernel kernel,
         ChatSessionRepository chatRepository,
-        ChatMessageRepository chatMessageRepository,
+        ChatMessageRepository chatMessageRepository, // TODO: unused
         BotSchemaOptions botSchemaOptions,
         AIServiceOptions embeddingOptions,
         Guid chatId)

samples/apps/copilot-chat-app/webapi/Controllers/ChatHistoryController.cs

@@ -63,7 +63,7 @@ public class ChatHistoryController : ControllerBase
         var initialBotMessage = this._promptSettings.InitialBotMessage;
         await this.SaveResponseAsync(initialBotMessage, newChat.Id);
 
-        this._logger.LogDebug("Created chat session with id {0} for user {1}.", newChat.Id, userId);
+        this._logger.LogDebug("Created chat session with id {0} for user {1}", newChat.Id, userId);
         return this.CreatedAtAction(nameof(this.GetChatSessionByIdAsync), new { chatId = newChat.Id }, newChat);
     }
 
@@ -91,7 +91,7 @@ public async Task<IActionResult> GetChatSessionByIdAsync(Guid chatId)
     /// <summary>
     /// Get all chat sessions associated with a user. Return an empty list if no chats are found.
     /// The regex pattern that is used to match the user id will match the following format:
-    ///    - 2 period separated groups of one or more hyphen-delimitated alphanumeric strings.
+    ///    - 2 period separated groups of one or more hyphen-delimited alphanumeric strings.
     /// The pattern matches two GUIDs in canonical textual representation separated by a period.
     /// </summary>
     /// <param name="userId">The user id.</param>
@@ -160,9 +160,9 @@ public async Task<IActionResult> GetAllChatSessionsAsync(string userId)
     [ProducesResponseType(StatusCodes.Status404NotFound)]
     public async Task<IActionResult> EditChatSessionAsync([FromBody] ChatSession chatParameters)
     {
-        var chatId = chatParameters.Id;
+        string chatId = chatParameters.Id;
 
-        var chat = await this._chatSessionRepository.FindByIdAsync(chatId.ToString());
+        ChatSession? chat = await this._chatSessionRepository.FindByIdAsync(chatId);
         if (chat == null)
         {
             return this.NotFound($"Chat of id {chatId} not found.");

samples/apps/copilot-chat-app/webapi/Controllers/DocumentImportController.cs

@@ -35,9 +35,9 @@ private enum SupportedFileType
         Pdf,
     };
 
-    private readonly IServiceProvider _serviceProvider;
+    private readonly IServiceProvider _serviceProvider; // TODO: unused
     private readonly ILogger<DocumentImportController> _logger;
-    private readonly PromptSettings _promptSettings;
+    private readonly PromptSettings _promptSettings; // TODO: unused
     private readonly DocumentMemoryOptions _options;
 
     /// <summary>

samples/apps/copilot-chat-app/webapi/Model/Bot.cs

@@ -2,7 +2,6 @@
 
 using Microsoft.SemanticKernel.Memory;
 using SemanticKernel.Service.Config;
-using SemanticKernel.Service.Skills;
 
 namespace SemanticKernel.Service.Model;
 

samples/apps/copilot-chat-app/webapi/Skills/ChatSkill.cs

@@ -387,7 +387,7 @@ private bool TryExtractJsonFromPlanResult(string openApiSkillResponse, out strin
         catch (JsonException)
         {
             // Expected if not valid JSON.
-            this._logger.LogDebug("Unable to extract JSON from planner response. It is likely not JSON formatted.");
+            this._logger.LogDebug("Unable to extract JSON from planner response, it is likely not JSON formatted");
         }
 
         json = string.Empty;