use ANSI colour codes universally in ConsoleSink

odygrd · Nov 3, 2024 · e6415fc · e6415fc
1 parent d8015ba
commit e6415fc
Show file tree

Hide file tree

Showing 8 changed files with 226 additions and 419 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -81,6 +81,17 @@
 - [v1.1.0](#v110)
 - [v1.0.0](#v100)
 
+## v8.0.0
+
+- Unified `JsonFileSink.h` and `JsonConsoleSink.h` into a single header, `JsonSink.h`, with both classes now sharing a
+  common implementation
+- Users can now inherit from `JsonFileSink` or `JsonConsoleSink` and override the `generate_json_message(...)` function
+  to implement their own custom JSON log formats
+- Simplified `ConsoleSink` by applying ANSI colour codes universally across all platforms, including Windows. The
+  previous Windows-specific implementation has been removed. Note that `quill::ConsoleColours` has been replaced with
+  `quill::ConsoleSink::Colours`, and `quill::ConsoleColours::ColourMode` has been renamed to
+  `quill::ConsoleSink::ColourMode`.
+
 ## v7.5.0
 
 - In previous versions, logging on Windows automatically included `windows.h` in all components. The frontend will no
@@ -121,6 +132,7 @@
   ```cpp
     quill::Frontend::create_or_get_sink<quill::ConsoleSink>(
       "sink_id_1", quill::ConsoleColours::ColourMode::Automatic);
+   ```
 
 ## v7.3.0
 

diff --git a/examples/console_logging.cpp b/examples/console_logging.cpp
@@ -25,7 +25,7 @@ int main()
 
   // Frontend
   auto console_sink = quill::Frontend::create_or_get_sink<quill::ConsoleSink>(
-    "sink_id_1", quill::ConsoleColours::ColourMode::Automatic);
+    "sink_id_1", quill::ConsoleSink::ColourMode::Automatic);
 
   quill::Logger* logger = quill::Frontend::create_or_get_logger("root", std::move(console_sink));
 

diff --git a/examples/custom_console_colours.cpp b/examples/custom_console_colours.cpp
@@ -18,13 +18,12 @@ int main()
   quill::Backend::start(backend_options);
 
   // Frontend
-  quill::ConsoleColours custom_console_colours;
-  custom_console_colours.set_default_colours();
-  custom_console_colours.set_colour(quill::LogLevel::Info, quill::ConsoleColours::blue); // overwrite the colour for INFO
+  quill::ConsoleSink::Colours colours;
+  colours.apply_default_colours();
+  colours.assign_colour_to_log_level(quill::LogLevel::Info, quill::ConsoleSink::Colours::blue); // overwrite the colour for INFO
 
   // Create the sink
-  auto console_sink =
-    quill::Frontend::create_or_get_sink<quill::ConsoleSink>("sink_id_1", custom_console_colours);
+  auto console_sink = quill::Frontend::create_or_get_sink<quill::ConsoleSink>("sink_id_1", colours);
 
   quill::Logger* logger = quill::Frontend::create_or_get_logger("root", std::move(console_sink));
 

diff --git a/examples/single_logger_multiple_sink_formats/ConsoleSinkWithFormatter.h b/examples/single_logger_multiple_sink_formats/ConsoleSinkWithFormatter.h
@@ -13,8 +13,9 @@ class ConsoleSinkWithFormatter : public quill::ConsoleSink
 {
 public:
   ConsoleSinkWithFormatter(quill::PatternFormatterOptions const& pattern_formater_options,
-                           bool enable_colours = true, std::string const& stream = "stdout")
-    : quill::ConsoleSink(enable_colours, stream), _formatter(pattern_formater_options)
+                           quill::ConsoleSink::ColourMode colour_mode = quill::ConsoleSink::ColourMode::Automatic,
+                           std::string const& stream = "stdout")
+    : quill::ConsoleSink(colour_mode, stream), _formatter(pattern_formater_options)
   {
   }