Add Styler to enforce code style

Author: crbelaus

.formatter.exs

@@ -4,7 +4,7 @@ locals_without_parens = [error_tracker_dashboard: 1, error_tracker_dashboard: 2]
 [
   import_deps: [:ecto, :ecto_sql, :plug, :phoenix],
   inputs: ["{mix,.formatter,dev,dev.*}.exs", "{config,lib,test}/**/*.{heex,ex,exs}"],
-  plugins: [Phoenix.LiveView.HTMLFormatter],
+  plugins: [Phoenix.LiveView.HTMLFormatter, Styler],
   locals_without_parens: locals_without_parens,
   export: [locals_without_parens: locals_without_parens]
 ]

config/dev.example.exs

@@ -1,16 +1,5 @@
 import Config
 
-config :tailwind,
-  version: "3.4.3",
-  default: [
-    args: ~w(
-      --config=tailwind.config.js
-      --input=css/app.css
-      --output=../priv/static/app.css
-    ),
-    cd: Path.expand("../assets", __DIR__)
-  ]
-
 config :bun,
   version: "1.1.18",
   default: [
@@ -19,32 +8,40 @@ config :bun,
     env: %{}
   ]
 
-# PostgreSQL adapter
-#
-# To use SQLite3 on your local development machine uncomment these lines and
-# comment the lines of other adapters.
-
-config :error_tracker, :ecto_adapter, :postgres
-
-config :error_tracker, ErrorTrackerDev.Repo,
-  url: "ecto://postgres:postgres@127.0.0.1/error_tracker_dev"
-
 # MySQL/MariaDB adapter
 #
 # To use MySQL/MariaDB on your local development machine uncomment these lines and
 # comment the lines of other adapters.
-
+#
 # config :error_tracker, :ecto_adapter, :mysql
-
+#
 # config :error_tracker, ErrorTrackerDev.Repo,
 #   url: "ecto://root:root@127.0.0.1/error_tracker_dev"
-
+#
 # SQLite3 adapter
 #
 # To use SQLite3 on your local development machine uncomment these lines and
 # comment the lines of other adapters.
-
+#
 # config :error_tracker, :ecto_adapter, :sqlite3
-
+#
 # config :error_tracker, ErrorTrackerDev.Repo,
 #   database: System.get_env("SQLITE_DB") || "dev.db"
+#
+# PostgreSQL adapter
+#
+# To use PostgreSQL on your local development machine uncomment these lines and
+# comment the lines of other adapters.
+config :error_tracker, ErrorTrackerDev.Repo, url: "ecto://postgres:postgres@127.0.0.1/error_tracker_dev"
+config :error_tracker, :ecto_adapter, :postgres
+
+config :tailwind,
+  version: "3.4.3",
+  default: [
+    args: ~w(
+      --config=tailwind.config.js
+      --input=css/app.css
+      --output=../priv/static/app.css
+      ),
+    cd: Path.expand("../assets", __DIR__)
+  ]

config/test.example.exs

@@ -1,25 +1,28 @@
 import Config
 
-config :error_tracker, ErrorTracker.Test.Repo,
-  url: "ecto://postgres:postgres@127.0.0.1/error_tracker_test",
-  pool: Ecto.Adapters.SQL.Sandbox,
-  log: false
+alias Ecto.Adapters.SQL.Sandbox
+alias ErrorTracker.Test.Repo
 
-config :error_tracker, ErrorTracker.Test.MySQLRepo,
-  url: "ecto://root:root@127.0.0.1/error_tracker_test",
-  pool: Ecto.Adapters.SQL.Sandbox,
+config :error_tracker, ErrorTracker.Test.LiteRepo,
+  database: "priv/lite_repo/test.db",
+  pool: Sandbox,
   log: false,
   # Use the same migrations as the PostgreSQL repo
   priv: "priv/repo"
 
-config :error_tracker, ErrorTracker.Test.LiteRepo,
-  database: "priv/lite_repo/test.db",
-  pool: Ecto.Adapters.SQL.Sandbox,
+config :error_tracker, ErrorTracker.Test.MySQLRepo,
+  url: "ecto://root:root@127.0.0.1/error_tracker_test",
+  pool: Sandbox,
   log: false,
   # Use the same migrations as the PostgreSQL repo
   priv: "priv/repo"
 
-config :error_tracker, ecto_repos: [ErrorTracker.Test.Repo]
+config :error_tracker, Repo,
+  url: "ecto://postgres:postgres@127.0.0.1/error_tracker_test",
+  pool: Sandbox,
+  log: false
+
+config :error_tracker, ecto_repos: [Repo]
 
 # Repo is selected in the test_helper.exs based on the given ENV vars
 config :error_tracker, otp_app: :error_tracker

dev.exs

@@ -22,10 +22,12 @@ Application.put_all_env(
 )
 
 defmodule ErrorTrackerDev.Repo do
-  require Logger
   use Ecto.Repo, otp_app: otp_app, adapter: Ecto.Adapters.SQLite3
 
+  require Logger
+
   defmodule Migration do
+    @moduledoc false
     use Ecto.Migration
 
     def up, do: ErrorTracker.Migration.up()
@@ -80,6 +82,7 @@ defmodule ErrorTrackerDev.Controller do
 end
 
 defmodule ErrorTrackerDev.Live do
+  @moduledoc false
   use Phoenix.LiveView
 
   def mount(params, _session, socket) do
@@ -226,7 +229,7 @@ defmodule ErrorTrackerDev.Endpoint do
     |> Plug.Conn.put_resp_header("content-security-policy", Enum.join(policies, " "))
   end
 
-  defp plug_exception(conn = %Plug.Conn{path_info: path_info}, _opts) when is_list(path_info) do
+  defp plug_exception(%Plug.Conn{path_info: path_info} = conn, _opts) when is_list(path_info) do
     if "plug_exception" in path_info,
       do: raise("Crashed in Endpoint"),
       else: conn
@@ -244,6 +247,7 @@ defmodule ErrorTrackerDev.ErrorView do
 end
 
 defmodule ErrorTrackerDev.GenServer do
+  @moduledoc false
   use GenServer
 
   # Client
@@ -267,10 +271,12 @@ defmodule ErrorTrackerDev.GenServer do
 end
 
 defmodule ErrorTrackerDev.Exception do
+  @moduledoc false
   defexception [:message, :bread_crumbs]
 end
 
 defmodule ErrorTrackerDev.Telemetry do
+  @moduledoc false
   def handle_event(event, measure, metadata, _opts) do
     dbg([event, measure, metadata])
   end

lib/error_tracker.ex

@@ -79,6 +79,13 @@ defmodule ErrorTracker do
   Breadcrumbs can be viewed in the dashboard on the details page of an occurrence.
   """
 
+  import Ecto.Query
+
+  alias ErrorTracker.Error
+  alias ErrorTracker.Occurrence
+  alias ErrorTracker.Repo
+  alias ErrorTracker.Telemetry
+
   @typedoc """
   A map containing the relevant context for a particular error.
   """
@@ -89,13 +96,6 @@ defmodule ErrorTracker do
   """
   @type exception :: Exception.t() | {:error, any()} | {Exception.non_error_kind(), any()}
 
-  import Ecto.Query
-
-  alias ErrorTracker.Error
-  alias ErrorTracker.Occurrence
-  alias ErrorTracker.Repo
-  alias ErrorTracker.Telemetry
-
   @doc """
   Report an exception to be stored.
 
@@ -154,7 +154,7 @@ defmodule ErrorTracker do
   appear as unresolved again.
   """
   @spec resolve(Error.t()) :: {:ok, Error.t()} | {:error, Ecto.Changeset.t()}
-  def resolve(error = %Error{status: :unresolved}) do
+  def resolve(%Error{status: :unresolved} = error) do
     changeset = Ecto.Changeset.change(error, status: :resolved)
 
     with {:ok, updated_error} <- Repo.update(changeset) do
@@ -167,7 +167,7 @@ defmodule ErrorTracker do
   Marks an error as unresolved.
   """
   @spec unresolve(Error.t()) :: {:ok, Error.t()} | {:error, Ecto.Changeset.t()}
-  def unresolve(error = %Error{status: :resolved}) do
+  def unresolve(%Error{status: :resolved} = error) do
     changeset = Ecto.Changeset.change(error, status: :unresolved)
 
     with {:ok, updated_error} <- Repo.update(changeset) do
@@ -188,7 +188,7 @@ defmodule ErrorTracker do
   receive notifications about.
   """
   @spec mute(Error.t()) :: {:ok, Error.t()} | {:error, Ecto.Changeset.t()}
-  def mute(error = %Error{}) do
+  def mute(%Error{} = error) do
     changeset = Ecto.Changeset.change(error, muted: true)
 
     Repo.update(changeset)
@@ -201,7 +201,7 @@ defmodule ErrorTracker do
   for new occurrences of this error again.
   """
   @spec unmute(Error.t()) :: {:ok, Error.t()} | {:error, Ecto.Changeset.t()}
-  def unmute(error = %Error{}) do
+  def unmute(%Error{} = error) do
     changeset = Ecto.Changeset.change(error, muted: false)
 
     Repo.update(changeset)
@@ -341,7 +341,7 @@ defmodule ErrorTracker do
     {:ok, {error, occurrence}} =
       Repo.transaction(fn ->
         error =
-          ErrorTracker.Repo.with_adapter(fn
+          Repo.with_adapter(fn
             :mysql ->
               Repo.insert!(error,
                 on_conflict: [set: [status: :unresolved, last_occurrence_at: DateTime.utc_now()]]

lib/error_tracker/integrations/phoenix.ex

@@ -119,12 +119,7 @@ defmodule ErrorTracker.Integrations.Phoenix do
     })
   end
 
-  def handle_event(
-        [:phoenix, :live_component, :handle_event, :exception],
-        _,
-        metadata,
-        :no_config
-      ) do
+  def handle_event([:phoenix, :live_component, :handle_event, :exception], _, metadata, :no_config) do
     ErrorTracker.report({metadata.kind, metadata.reason}, metadata.stacktrace, %{
       "live_view.component" => metadata.component,
       "live_view.event" => metadata.event,

lib/error_tracker/integrations/plug.ex

@@ -97,7 +97,7 @@ defmodule ErrorTracker.Integrations.Plug do
 
   @doc false
   def report_error(conn, reason, stack) do
-    unless Process.get(:error_tracker_router_exception_reported) do
+    if !Process.get(:error_tracker_router_exception_reported) do
       try do
         ErrorTracker.report(reason, stack, build_context(conn))
       after
@@ -107,13 +107,13 @@ defmodule ErrorTracker.Integrations.Plug do
   end
 
   @doc false
-  def set_context(conn = %Plug.Conn{}) do
-    conn |> build_context |> ErrorTracker.set_context()
+  def set_context(%Plug.Conn{} = conn) do
+    conn |> build_context() |> ErrorTracker.set_context()
   end
 
   @sensitive_headers ["cookie", "authorization"]
 
-  defp build_context(conn = %Plug.Conn{}) do
+  defp build_context(%Plug.Conn{} = conn) do
     %{
       "request.host" => conn.host,
       "request.path" => conn.request_path,
@@ -122,11 +122,11 @@ defmodule ErrorTracker.Integrations.Plug do
       "request.ip" => remote_ip(conn),
       "request.headers" => conn.req_headers |> Map.new() |> Map.drop(@sensitive_headers),
       # Depending on the error source, the request params may have not been fetched yet
-      "request.params" => unless(is_struct(conn.params, Plug.Conn.Unfetched), do: conn.params)
+      "request.params" => if(!is_struct(conn.params, Plug.Conn.Unfetched), do: conn.params)
     }
   end
 
-  defp remote_ip(conn = %Plug.Conn{}) do
+  defp remote_ip(%Plug.Conn{} = conn) do
     remote_ip =
       case Plug.Conn.get_req_header(conn, "x-forwarded-for") do
         [x_forwarded_for | _] ->

lib/error_tracker/migration/mysql.ex

@@ -4,6 +4,7 @@ defmodule ErrorTracker.Migration.MySQL do
   @behaviour ErrorTracker.Migration
 
   use Ecto.Migration
+
   alias ErrorTracker.Migration.SQLMigrator
 
   @initial_version 3

lib/error_tracker/migration/postgres.ex

@@ -4,6 +4,7 @@ defmodule ErrorTracker.Migration.Postgres do
   @behaviour ErrorTracker.Migration
 
   use Ecto.Migration
+
   alias ErrorTracker.Migration.SQLMigrator
 
   @initial_version 1

lib/error_tracker/migration/postgres/v01.ex

@@ -5,7 +5,7 @@ defmodule ErrorTracker.Migration.Postgres.V01 do
 
   import Ecto.Query
 
-  def up(opts = %{create_schema: create_schema, prefix: prefix}) do
+  def up(%{create_schema: create_schema, prefix: prefix} = opts) do
     # Prior to V02 the migration version was stored in table comments.
     # As of now the migration version is stored in a new table (created in V02).
     #