feat: rename JsonFormatter to avoid confusion with Logger.Formatter

`CozyLogger.JSON` provides the `format/4` function only, so it is not a full-featured `Logger.Formatter`.
cozy-elixir · Oct 23, 2023 · 0f6f360 · 0f6f360
1 parent ec37a5f
commit 0f6f360
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 16 deletions.
diff --git a/config/config.exs b/config/config.exs
@@ -10,14 +10,16 @@ if is_old_elixir? do
 
   # use log formatter provided by CozyLogger
   config :logger, :console,
-    format: {CozyLogger.JsonFormatter, :format},
+    format: {CozyLogger.JSON, :format},
+    truncate: :infinity,
+    utc_log: true,
     metadata: :all,
-    colors: [enabled: false],
-    utc_log: true
+    colors: [enabled: false]
 else
   config :logger, :default_formatter,
-    format: {CozyLogger.JsonFormatter, :format},
+    format: {CozyLogger.JSON, :format},
+    truncate: :infinity,
+    utc_log: true,
     metadata: :all,
-    colors: [enabled: false],
-    utc_log: true
+    colors: [enabled: false]
 end
diff --git a/lib/cozy_logger/formatters/json_formatter.ex → lib/cozy_logger/formats/json.ex b/lib/cozy_logger/formatters/json_formatter.ex → lib/cozy_logger/formats/json.ex
@@ -1,18 +1,18 @@
-defmodule CozyLogger.JsonFormatter do
+defmodule CozyLogger.JSON do
   @moduledoc """
-  A JSON formatter for Elixir built-in console backend.
+  Formatting log messages as JSON.
 
   ## Usage
 
   Elixir v1.15 or later:
 
       # customize format message with this formatter.
       config :logger, :default_formatter,
-        format: {CozyLogger.JsonFormatter, :format},
-        metadata: :all,
-        colors: [enabled: false],
+        format: {#{inspect(__MODULE__)}, :format},
         truncate: :infinity,
-        utc_log: true
+        utc_log: true,
+        metadata: :all,
+        colors: [enabled: false]
 
   Prior to Elixir v1.15:
 
@@ -24,7 +24,7 @@ defmodule CozyLogger.JsonFormatter do
 
       # customize format message with this formatter.
       config :logger, :console,
-        format: {CozyLogger.JsonFormatter, :format},
+        format: {#{inspect(__MODULE__)}, :format},
         metadata: :all,
         colors: [enabled: false]
 

diff --git a/...logger/formatters/json_formatter_test.exs → test/cozy_logger/formats/json_test.exs b/...logger/formatters/json_formatter_test.exs → test/cozy_logger/formats/json_test.exs
@@ -1,15 +1,15 @@
-defmodule CozyLogger.JsonFormatterTest do
+defmodule CozyLogger.JSONTest do
   use ExUnit.Case, async: true
 
-  alias CozyLogger.JsonFormatter
+  alias CozyLogger.JSON
 
   defmodule TestStruct do
     defstruct [:field]
   end
 
   defp encode_as_string!(value) do
     value
-    |> JsonFormatter.encode!()
+    |> JSON.encode!()
     |> to_string()
   end