set TODO and @moduledoc checks to ignore priority

Author: Taras Tyshko

.credo.exs

@@ -83,8 +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]},
+          # TODO comments are acceptable in our codebase, but we want to see them locally
+          {Credo.Check.Design.TagTODO, [priority: :ignore]},
           {Credo.Check.Design.TagFIXME, []},
           #
           ## Readability Checks
@@ -96,8 +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]},
+          # ModuleDoc is not required in our codebase, but we want to see them locally
+          {Credo.Check.Readability.ModuleDoc, [priority: :ignore]},
           {Credo.Check.Readability.MultiAlias, []},
           {Credo.Check.Readability.ParenthesesInCondition, []},
           {Credo.Check.Readability.ParenthesesOnZeroArityDefs, [parens: true]},

.github/workflows/ci.yml

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

lib/nerves_hub/certificate.ex

@@ -1,5 +1,5 @@
 defmodule NervesHub.Certificate do
-  alias X509.Certificate.Extension
+  alias X509.Certificate.Extension, as: X509Extension
 
   import X509.ASN1,
     only: [
@@ -19,7 +19,7 @@ defmodule NervesHub.Certificate do
   def get_aki(otp_certificate) do
     otp_certificate
     |> X509.Certificate.extensions()
-    |> Extension.find(:authority_key_identifier)
+    |> X509Extension.find(:authority_key_identifier)
     |> extension()
     |> Keyword.get(:extnValue)
     |> authority_key_identifier()
@@ -29,7 +29,7 @@ defmodule NervesHub.Certificate do
   def get_ski(otp_certificate) do
     otp_certificate
     |> X509.Certificate.extensions()
-    |> Extension.find(:subject_key_identifier)
+    |> X509Extension.find(:subject_key_identifier)
     |> case do
       nil ->
         nil

lib/nerves_hub/device_ssl_transport.ex

@@ -13,20 +13,20 @@ defmodule NervesHub.DeviceSSLTransport do
 
   @behaviour ThousandIsland.Transport
 
-  alias ThousandIsland.Transports.SSL
+  alias ThousandIsland.Transports.SSL, as: SSLTransport
 
   @impl ThousandIsland.Transport
-  defdelegate listen(port, user_options), to: SSL
+  defdelegate listen(port, user_options), to: SSLTransport
 
   @impl ThousandIsland.Transport
-  defdelegate accept(listener_socket), to: SSL
+  defdelegate accept(listener_socket), to: SSLTransport
 
   @impl ThousandIsland.Transport
   def handshake(socket) do
     if NervesHub.RateLimit.increment() do
       :telemetry.execute([:nerves_hub, :rate_limit, :accepted], %{count: 1})
 
-      SSL.handshake(socket)
+      SSLTransport.handshake(socket)
     else
       :telemetry.execute([:nerves_hub, :rate_limit, :rejected], %{count: 1})
 
@@ -35,50 +35,50 @@ defmodule NervesHub.DeviceSSLTransport do
   end
 
   @impl ThousandIsland.Transport
-  defdelegate upgrade(socket, opts), to: SSL
+  defdelegate upgrade(socket, opts), to: SSLTransport
 
   @impl ThousandIsland.Transport
-  defdelegate controlling_process(socket, pid), to: SSL
+  defdelegate controlling_process(socket, pid), to: SSLTransport
 
   @impl ThousandIsland.Transport
-  defdelegate recv(socket, length, timeout), to: SSL
+  defdelegate recv(socket, length, timeout), to: SSLTransport
 
   @impl ThousandIsland.Transport
-  defdelegate send(socket, data), to: SSL
+  defdelegate send(socket, data), to: SSLTransport
 
   @impl ThousandIsland.Transport
-  defdelegate sendfile(socket, filename, offset, length), to: SSL
+  defdelegate sendfile(socket, filename, offset, length), to: SSLTransport
 
   @impl ThousandIsland.Transport
-  defdelegate getopts(socket, options), to: SSL
+  defdelegate getopts(socket, options), to: SSLTransport
 
   @impl ThousandIsland.Transport
-  defdelegate setopts(socket, options), to: SSL
+  defdelegate setopts(socket, options), to: SSLTransport
 
   @impl ThousandIsland.Transport
-  defdelegate shutdown(socket, way), to: SSL
+  defdelegate shutdown(socket, way), to: SSLTransport
 
   @impl ThousandIsland.Transport
-  defdelegate close(socket), to: SSL
+  defdelegate close(socket), to: SSLTransport
 
   @impl ThousandIsland.Transport
-  defdelegate sockname(socket), to: SSL
+  defdelegate sockname(socket), to: SSLTransport
 
   @impl ThousandIsland.Transport
-  defdelegate peername(socket), to: SSL
+  defdelegate peername(socket), to: SSLTransport
 
   @impl ThousandIsland.Transport
-  defdelegate peercert(socket), to: SSL
+  defdelegate peercert(socket), to: SSLTransport
 
   @impl ThousandIsland.Transport
-  defdelegate secure?(), to: SSL
+  defdelegate secure?(), to: SSLTransport
 
   @impl ThousandIsland.Transport
-  defdelegate getstat(socket), to: SSL
+  defdelegate getstat(socket), to: SSLTransport
 
   @impl ThousandIsland.Transport
-  defdelegate negotiated_protocol(socket), to: SSL
+  defdelegate negotiated_protocol(socket), to: SSLTransport
 
   @impl ThousandIsland.Transport
-  defdelegate connection_information(socket), to: SSL
+  defdelegate connection_information(socket), to: SSLTransport
 end

lib/nerves_hub_web/components/core_components.ex

@@ -18,7 +18,7 @@ defmodule NervesHubWeb.CoreComponents do
 
   import NervesHubWeb.Components.Icons
 
-  alias Phoenix.HTML.Form
+  alias Phoenix.HTML.Form, as: HTMLForm
 
   alias Phoenix.LiveView.JS
 
@@ -362,7 +362,9 @@ defmodule NervesHubWeb.CoreComponents do
 
   def input(%{type: "checkbox"} = assigns) do
     assigns =
-      assign_new(assigns, :checked, fn -> Form.normalize_value("checkbox", assigns[:value]) end)
+      assign_new(assigns, :checked, fn ->
+        HTMLForm.normalize_value("checkbox", assigns[:value])
+      end)
 
     ~H"""
     <div phx-feedback-for={@name}>
@@ -391,7 +393,7 @@ defmodule NervesHubWeb.CoreComponents do
         {@rest}
       >
         <option :if={@prompt} value="">{@prompt}</option>
-        {Phoenix.HTML.Form.options_for_select(@options, @value)}
+        {HTMLForm.options_for_select(@options, @value)}
       </select>
       <div :if={assigns[:hint] || assigns[:rich_hint]} class="text-xs text-zinc-400">
         {assigns[:hint] || render_slot(assigns[:rich_hint])}
@@ -415,7 +417,7 @@ defmodule NervesHubWeb.CoreComponents do
           @errors != [] && "border-red-500 focus:border-red-500"
         ]}
         {@rest}
-      ><%= Phoenix.HTML.Form.normalize_value("textarea", @value) %></textarea>
+      ><%= HTMLForm.normalize_value("textarea", @value) %></textarea>
       <div :if={assigns[:hint] || assigns[:rich_hint]} class="flex flex-col gap-1 text-xs text-zinc-400 pt-1">
         {assigns[:hint] || render_slot(assigns[:rich_hint])}
       </div>
@@ -434,7 +436,7 @@ defmodule NervesHubWeb.CoreComponents do
         type={@type}
         name={@name}
         id={@id}
-        value={Phoenix.HTML.Form.normalize_value(@type, @value)}
+        value={HTMLForm.normalize_value(@type, @value)}
         class={[
           "mt-2 py-1.5 px-2 block w-full rounded text-zinc-400 bg-zinc-900 focus:ring-0 sm:text-sm",
           "phx-no-feedback:border-zinc-600 phx-no-feedback:focus:border-zinc-700",
@@ -463,7 +465,7 @@ defmodule NervesHubWeb.CoreComponents do
         type={@type}
         name={@name}
         id={@id}
-        value={Phoenix.HTML.Form.normalize_value(@type, @value)}
+        value={HTMLForm.normalize_value(@type, @value)}
         class={[
           "mt-2 py-1.5 px-2 block w-full rounded text-zinc-400 bg-zinc-900 focus:ring-0 sm:text-sm",
           "phx-no-feedback:border-zinc-600 phx-no-feedback:focus:border-zinc-700",

lib/nerves_hub_web/plugs/configure_uploads.ex

@@ -1,15 +1,16 @@
 defmodule NervesHubWeb.Plugs.ConfigureUploads do
   use NervesHubWeb, :plug
 
-  alias NervesHubWeb.Plugs
+  alias NervesHubWeb.Plugs.FileUpload
+  alias NervesHubWeb.Plugs.StaticUploads
 
   def init(_opts), do: []
 
   def call(conn, _opts) do
     if local_uploads?() do
       conn
-      |> Plugs.FileUpload.call([])
-      |> Plugs.StaticUploads.call([])
+      |> FileUpload.call([])
+      |> StaticUploads.call([])
     else
       conn
     end

test/nerves_hub/ssl_test.exs

@@ -4,7 +4,7 @@ defmodule NervesHub.SSLTest do
   alias NervesHub.Certificate
   alias NervesHub.Devices
   alias NervesHub.Fixtures
-  alias X509.Certificate.Validity
+  alias X509.Certificate.Validity, as: X509Validity
 
   require X509.ASN1
 
@@ -389,7 +389,7 @@ defmodule NervesHub.SSLTest do
   defp do_corruption(cert, :expired) do
     {:ok, not_before, 0} = DateTime.from_iso8601("2018-01-01T00:00:00Z")
     {:ok, not_after, 0} = DateTime.from_iso8601("2018-12-31T23:59:59Z")
-    new_validity = Validity.new(not_before, not_after)
+    new_validity = X509Validity.new(not_before, not_after)
 
     tbs_cert = X509.ASN1.otp_certificate(cert, :tbsCertificate)
     new_tbs_cert = X509.ASN1.tbs_certificate(tbs_cert, validity: new_validity)

test/nerves_hub_web/live/devices/show_test.exs

@@ -734,7 +734,7 @@ defmodule NervesHubWeb.Live.Devices.ShowTest do
 
       # Test paginate event
       view
-      |> element("button[phx-click=\"paginate\"][phx-value-page=\"2\"]", "2")
+      |> element(~s{button[phx-click="paginate"][phx-value-page="2"]}, "2")
       |> render_click()
 
       # Should redirect to page 2 on same device page