ignore low priority credo checks (TODO, @moduledoc, line length)

Author: Taras Tyshko

.credo.exs

@@ -83,6 +83,8 @@
           #
           {Credo.Check.Design.AliasUsage,
            [priority: :low, if_nested_deeper_than: 2, if_called_more_often_than: 0]},
+          # TODO comments are acceptable in our codebase, but we want to see them
+          {Credo.Check.Design.TagTODO, [priority: :low]},
           {Credo.Check.Design.TagFIXME, []},
           #
           ## Readability Checks
@@ -94,6 +96,8 @@
           {Credo.Check.Readability.MaxLineLength, [priority: :low, max_length: 120]},
           {Credo.Check.Readability.ModuleAttributeNames, []},
           {Credo.Check.Readability.ModuleNames, []},
+          # ModuleDoc is not required in our codebase, but we want to see them
+          {Credo.Check.Readability.ModuleDoc, [priority: :low]},
           {Credo.Check.Readability.MultiAlias, []},
           {Credo.Check.Readability.ParenthesesInCondition, []},
           {Credo.Check.Readability.ParenthesesOnZeroArityDefs, [parens: true]},
@@ -163,14 +167,6 @@
           {Credo.Check.Warning.WrongTestFileExtension, []}
         ],
         disabled: [
-          #
-          # TODO comments are acceptable in our codebase
-          {Credo.Check.Design.TagTODO, []},
-
-          #
-          # ModuleDoc is not required in our codebase
-          {Credo.Check.Readability.ModuleDoc, []},
-
           #
           # Checks scheduled for next check update (opt-in for now)
           {Credo.Check.Refactor.UtcNowTruncate, []},

.github/workflows/ci.yml

@@ -113,7 +113,7 @@ jobs:
         run: mix spellweaver.check
 
       - name: Run Credo
-        run: mix credo
+        run: mix credo --min-priority normal
 
       - name: DB Setup
         run: mix ecto.migrate.reset

lib/nerves_hub/accounts.ex

@@ -3,6 +3,7 @@ defmodule NervesHub.Accounts do
 
   alias Ecto.Changeset
   alias Ecto.Multi
+
   alias NervesHub.Accounts.Invite
   alias NervesHub.Accounts.Org
   alias NervesHub.Accounts.OrgKey

lib/nerves_hub/accounts/user_notifier.ex

@@ -17,7 +17,7 @@ defmodule NervesHub.Accounts.UserNotifier do
   alias NervesHub.Emails.WelcomeTemplate
 
   alias NervesHub.SwooshMailer, as: Mailer
-  alias Phoenix.HTML
+  alias Phoenix.HTML.Safe, as: HTMLSafe
 
   def deliver_confirmation_instructions(user, confirmation_url) do
     assigns = %{
@@ -208,7 +208,7 @@ defmodule NervesHub.Accounts.UserNotifier do
 
     text =
       module.text_render(assigns)
-      |> HTML.Safe.to_iodata()
+      |> HTMLSafe.to_iodata()
       |> IO.iodata_to_binary()
 
     {html, text}

lib/nerves_hub/application.ex

@@ -1,7 +1,9 @@
 defmodule NervesHub.Application do
   use Application
+
   require Logger
-  alias NervesHub.Telemetry.Customizations
+
+  alias NervesHub.Telemetry.Customizations, as: TelemetryCustomizations
 
   def start(_type, _args) do
     case System.cmd("fwup", ["--version"], env: []) do
@@ -53,7 +55,7 @@ defmodule NervesHub.Application do
       :ok = :httpc.set_option(:ipfamily, :inet6fb4)
     end
 
-    :ok = Customizations.setup()
+    :ok = TelemetryCustomizations.setup()
     :ok = OpentelemetryBandit.setup()
     :ok = OpentelemetryPhoenix.setup(adapter: :bandit)
     :ok = OpentelemetryOban.setup(trace: [:jobs])

lib/nerves_hub/devices/connections.ex

@@ -7,7 +7,7 @@ defmodule NervesHub.Devices.Connections do
   alias NervesHub.Devices.Device
   alias NervesHub.Devices.DeviceConnection
   alias NervesHub.Repo
-  alias Phoenix.Channel.Server
+  alias Phoenix.Channel.Server, as: ChannelServer
 
   @doc """
   Get all connections for a device.
@@ -95,7 +95,7 @@ defmodule NervesHub.Devices.Connections do
 
     event = "connection:heartbeat"
     topic = "device:#{device.identifier}:internal"
-    Server.broadcast_from!(NervesHub.PubSub, self(), topic, event, %{})
+    ChannelServer.broadcast_from!(NervesHub.PubSub, self(), topic, event, %{})
   end
 
   @doc """

test/nerves_hub_web/live/new_ui/devices/show_test.exs

@@ -112,12 +112,9 @@ defmodule NervesHubWeb.Live.NewUI.Devices.ShowTest do
     end
 
     defp user_initials(user) do
-      String.split(user.name)
-      |> Enum.map(fn w ->
-        String.at(w, 0)
-        |> String.upcase()
-      end)
-      |> Enum.join("")
+      user.name
+      |> String.split()
+      |> Enum.map_join("", fn w -> String.at(w, 0) |> String.upcase() end)
     end
   end
 

test/support/channel_case.ex

@@ -15,7 +15,7 @@ defmodule NervesHubWeb.ChannelCase do
 
   use ExUnit.CaseTemplate
 
-  alias Ecto.Adapters.SQL.Sandbox
+  alias Ecto.Adapters.SQL.Sandbox, as: SQLSandbox
 
   using do
     quote do
@@ -56,17 +56,17 @@ defmodule NervesHubWeb.ChannelCase do
 
   setup do
     # Explicitly get a connection before each test
-    :ok = Sandbox.checkout(NervesHub.Repo)
-    :ok = Sandbox.checkout(NervesHub.ObanRepo)
+    :ok = SQLSandbox.checkout(NervesHub.Repo)
+    :ok = SQLSandbox.checkout(NervesHub.ObanRepo)
   end
 
   setup tags do
-    pid = Sandbox.start_owner!(NervesHub.Repo, shared: not tags[:async])
-    pid2 = Sandbox.start_owner!(NervesHub.ObanRepo, shared: not tags[:async])
+    pid = SQLSandbox.start_owner!(NervesHub.Repo, shared: not tags[:async])
+    pid2 = SQLSandbox.start_owner!(NervesHub.ObanRepo, shared: not tags[:async])
 
     on_exit(fn ->
-      Sandbox.stop_owner(pid)
-      Sandbox.stop_owner(pid2)
+      SQLSandbox.stop_owner(pid)
+      SQLSandbox.stop_owner(pid2)
     end)
 
     :ok

test/support/fixtures.ex

@@ -18,9 +18,9 @@ defmodule NervesHub.Fixtures do
   alias NervesHub.Scripts
   alias NervesHub.Support
   alias NervesHub.Support.Fwup
-  alias X509.Certificate.Extension
-  alias X509.Certificate.Template
-  alias X509.Certificate.Validity
+  alias X509.Certificate.Extension, as: X509Extension
+  alias X509.Certificate.Template, as: X509Template
+  alias X509.Certificate.Validity, as: X509Validity
 
   @uploader Application.compile_env(:nerves_hub, :firmware_upload)
 
@@ -357,14 +357,14 @@ defmodule NervesHub.Fixtures do
     cert =
       X509.Certificate.new(public_key, subject_rdn, signer_cert, signer_key,
         template:
-          Template.new(%Template{
+          X509Template.new(%X509Template{
             serial: {:random, 20},
-            validity: Validity.new(not_before, not_after),
+            validity: X509Validity.new(not_before, not_after),
             hash: :sha256,
             extensions: [
-              basic_constraints: Extension.basic_constraints(false),
-              key_usage: Extension.key_usage([:digitalSignature, :keyEncipherment]),
-              ext_key_usage: Extension.ext_key_usage([:clientAuth]),
+              basic_constraints: X509Extension.basic_constraints(false),
+              key_usage: X509Extension.key_usage([:digitalSignature, :keyEncipherment]),
+              ext_key_usage: X509Extension.ext_key_usage([:clientAuth]),
               subject_key_identifier: true,
               authority_key_identifier: true
             ]