Address review: move format syntax to enum comment, remove redundant FileLogger comment, move SettingLoggingFormat test, remove fff from spellcheck

Author: Copilot

.github/actions/spelling/expect.txt

@@ -179,7 +179,6 @@ fdw
 fdwgp
 FECAFEB
 fedorapeople
-fff
 fileinuse
 filemode
 Filetime

src/AppInstallerCLITests/UserSettings.cpp

@@ -386,6 +386,64 @@ TEST_CASE("SettingLoggingFileNameStrategy", "[settings]") {
     }
 }
 
+TEST_CASE("SettingLoggingFormat", "[settings]")
+{
+    auto again = DeleteUserSettingsFiles();
+
+    SECTION("Default value")
+    {
+        UserSettingsTest userSettingTest;
+
+        REQUIRE(userSettingTest.Get<Setting::LoggingFormat>() == LogFileFormat::WinGet);
+        REQUIRE(userSettingTest.GetWarnings().size() == 0);
+    }
+    SECTION("WinGet")
+    {
+        std::string_view json = R"({ "logging": { "format": "winget" } })";
+        SetSetting(Stream::PrimaryUserSettings, json);
+        UserSettingsTest userSettingTest;
+
+        REQUIRE(userSettingTest.Get<Setting::LoggingFormat>() == LogFileFormat::WinGet);
+        REQUIRE(userSettingTest.GetWarnings().size() == 0);
+    }
+    SECTION("CCM")
+    {
+        std::string_view json = R"({ "logging": { "format": "ccm" } })";
+        SetSetting(Stream::PrimaryUserSettings, json);
+        UserSettingsTest userSettingTest;
+
+        REQUIRE(userSettingTest.Get<Setting::LoggingFormat>() == LogFileFormat::CCM);
+        REQUIRE(userSettingTest.GetWarnings().size() == 0);
+    }
+    SECTION("Case insensitive CCM")
+    {
+        std::string_view json = R"({ "logging": { "format": "CCM" } })";
+        SetSetting(Stream::PrimaryUserSettings, json);
+        UserSettingsTest userSettingTest;
+
+        REQUIRE(userSettingTest.Get<Setting::LoggingFormat>() == LogFileFormat::CCM);
+        REQUIRE(userSettingTest.GetWarnings().size() == 0);
+    }
+    SECTION("Bad value")
+    {
+        std::string_view json = R"({ "logging": { "format": "cmtrace" } })";
+        SetSetting(Stream::PrimaryUserSettings, json);
+        UserSettingsTest userSettingTest;
+
+        REQUIRE(userSettingTest.Get<Setting::LoggingFormat>() == LogFileFormat::WinGet);
+        REQUIRE(userSettingTest.GetWarnings().size() == 1);
+    }
+    SECTION("Bad value type")
+    {
+        std::string_view json = R"({ "logging": { "format": true } })";
+        SetSetting(Stream::PrimaryUserSettings, json);
+        UserSettingsTest userSettingTest;
+
+        REQUIRE(userSettingTest.Get<Setting::LoggingFormat>() == LogFileFormat::WinGet);
+        REQUIRE(userSettingTest.GetWarnings().size() == 1);
+    }
+}
+
 TEST_CASE("SettingAutoUpdateIntervalInMinutes", "[settings]")
 {
     auto again = DeleteUserSettingsFiles();
@@ -925,64 +983,6 @@ TEST_CASE("SettingOutputSortDirection", "[settings]")
     }
 }
 
-TEST_CASE("SettingLoggingFormat", "[settings]")
-{
-    auto again = DeleteUserSettingsFiles();
-
-    SECTION("Default value")
-    {
-        UserSettingsTest userSettingTest;
-
-        REQUIRE(userSettingTest.Get<Setting::LoggingFormat>() == LogFileFormat::WinGet);
-        REQUIRE(userSettingTest.GetWarnings().size() == 0);
-    }
-    SECTION("WinGet")
-    {
-        std::string_view json = R"({ "logging": { "format": "winget" } })";
-        SetSetting(Stream::PrimaryUserSettings, json);
-        UserSettingsTest userSettingTest;
-
-        REQUIRE(userSettingTest.Get<Setting::LoggingFormat>() == LogFileFormat::WinGet);
-        REQUIRE(userSettingTest.GetWarnings().size() == 0);
-    }
-    SECTION("CCM")
-    {
-        std::string_view json = R"({ "logging": { "format": "ccm" } })";
-        SetSetting(Stream::PrimaryUserSettings, json);
-        UserSettingsTest userSettingTest;
-
-        REQUIRE(userSettingTest.Get<Setting::LoggingFormat>() == LogFileFormat::CCM);
-        REQUIRE(userSettingTest.GetWarnings().size() == 0);
-    }
-    SECTION("Case insensitive CCM")
-    {
-        std::string_view json = R"({ "logging": { "format": "CCM" } })";
-        SetSetting(Stream::PrimaryUserSettings, json);
-        UserSettingsTest userSettingTest;
-
-        REQUIRE(userSettingTest.Get<Setting::LoggingFormat>() == LogFileFormat::CCM);
-        REQUIRE(userSettingTest.GetWarnings().size() == 0);
-    }
-    SECTION("Bad value")
-    {
-        std::string_view json = R"({ "logging": { "format": "cmtrace" } })";
-        SetSetting(Stream::PrimaryUserSettings, json);
-        UserSettingsTest userSettingTest;
-
-        REQUIRE(userSettingTest.Get<Setting::LoggingFormat>() == LogFileFormat::WinGet);
-        REQUIRE(userSettingTest.GetWarnings().size() == 1);
-    }
-    SECTION("Bad value type")
-    {
-        std::string_view json = R"({ "logging": { "format": true } })";
-        SetSetting(Stream::PrimaryUserSettings, json);
-        UserSettingsTest userSettingTest;
-
-        REQUIRE(userSettingTest.Get<Setting::LoggingFormat>() == LogFileFormat::WinGet);
-        REQUIRE(userSettingTest.GetWarnings().size() == 1);
-    }
-}
-
 TEST_CASE("ConvertToSortField", "[settings]")
 {
     SECTION("Valid values - lowercase")

src/AppInstallerCommonCore/FileLogger.cpp

@@ -30,7 +30,6 @@ namespace AppInstaller::Logging
         }
 
         // Formats a log line in CCM (CMTrace-compatible) format.
-        // CCM log format: <![LOG[message]LOG]!><time="HH:mm:ss.fff+###" date="MM-dd-YYYY" component="channel" context="" type="N" thread="TID" file="">
         std::string ToCCMLogLine(Channel channel, Level level, std::string_view message)
         {
             auto now = std::chrono::system_clock::now();

src/AppInstallerSharedLib/Public/AppInstallerLogging.h

@@ -103,7 +103,7 @@ namespace AppInstaller::Logging
     {
         // Default WinGet format: "<timestamp> <level> [channel] message"
         WinGet,
-        // CCM/CMTrace-compatible format recognized by CMTrace and Microsoft Endpoint Configuration Manager log viewers
+        // CCM/CMTrace-compatible format: <![LOG[message]LOG]!><time="HH:mm:ss.fff+###" date="MM-dd-YYYY" component="channel" context="" type="N" thread="TID" file="">
         CCM,
     };