update c

Author: woylie

.credo.exs

@@ -21,16 +21,7 @@
         # You can give explicit globs or simply directories.
         # In the latter case `**/*.{ex,exs}` will be used.
         #
-        included: [
-          "lib/",
-          "src/",
-          "test/",
-          "web/",
-          "apps/*/lib/",
-          "apps/*/src/",
-          "apps/*/test/",
-          "apps/*/web/"
-        ],
+        included: ["example/lib", "example/test", "lib/", "test/"],
         excluded: [~r"/_build/", ~r"/deps/", ~r"/node_modules/"]
       },
       #
@@ -83,7 +74,11 @@
           # Priority values are: `low, normal, high, higher`
           #
           {Credo.Check.Design.AliasUsage,
-           [priority: :low, if_nested_deeper_than: 2, if_called_more_often_than: 0]},
+           [
+             priority: :low,
+             if_nested_deeper_than: 2,
+             if_called_more_often_than: 0
+           ]},
           # You can also customize the exit_status of each check.
           # If you don't want TODO comments to cause `mix credo` to fail, just
           # set this value to 0 (zero).
@@ -97,7 +92,8 @@
           {Credo.Check.Readability.AliasOrder, []},
           {Credo.Check.Readability.FunctionNames, []},
           {Credo.Check.Readability.LargeNumbers, []},
-          {Credo.Check.Readability.MaxLineLength, [priority: :low, max_length: 80]},
+          {Credo.Check.Readability.MaxLineLength,
+           [priority: :low, max_length: 80]},
           {Credo.Check.Readability.ModuleAttributeNames, []},
           {Credo.Check.Readability.ModuleDoc, []},
           {Credo.Check.Readability.ModuleNames, []},
@@ -131,6 +127,7 @@
           {Credo.Check.Refactor.Nesting, []},
           {Credo.Check.Refactor.UnlessWithElse, []},
           {Credo.Check.Refactor.WithClauses, []},
+          {Credo.Check.Refactor.FilterCount, []},
           {Credo.Check.Refactor.FilterFilter, []},
           {Credo.Check.Refactor.RejectReject, []},
           {Credo.Check.Refactor.RedundantWithClauseResult, []},
@@ -140,9 +137,11 @@
           #
           {Credo.Check.Warning.ApplicationConfigInModuleAttribute, []},
           {Credo.Check.Warning.BoolOperationOnSameValues, []},
+          {Credo.Check.Warning.Dbg, []},
           {Credo.Check.Warning.ExpensiveEmptyEnumCheck, []},
           {Credo.Check.Warning.IExPry, []},
           {Credo.Check.Warning.IoInspect, []},
+          {Credo.Check.Warning.MissedMetadataKeyInLoggerConfig, []},
           {Credo.Check.Warning.OperationOnSameValues, []},
           {Credo.Check.Warning.OperationWithConstantResult, []},
           {Credo.Check.Warning.RaiseInsideRescue, []},
@@ -159,24 +158,18 @@
           {Credo.Check.Warning.UnsafeExec, []},
 
           #
-          ## Controversial and experimental checks
+          ## Checks disabled by default
           #
-          {Credo.Check.Consistency.UnusedVariableNames, []},
-          {Credo.Check.Readability.ImplTrue, []},
-          {Credo.Check.Readability.MultiAlias, []},
-          {Credo.Check.Readability.SingleFunctionToBlockPipe, []},
+
           {Credo.Check.Readability.SinglePipe, []},
           {Credo.Check.Readability.StrictModuleLayout, []},
           {Credo.Check.Readability.WithCustomTaggedTuple, []},
           {Credo.Check.Refactor.DoubleBooleanNegation, []},
           {Credo.Check.Refactor.FilterReject, []},
           {Credo.Check.Refactor.MapMap, []},
-          {Credo.Check.Refactor.NegatedIsNil, []},
           {Credo.Check.Refactor.PipeChainStart, []},
           {Credo.Check.Refactor.RejectFilter, []},
-          {Credo.Check.Refactor.VariableRebinding, []},
-          {Credo.Check.Warning.MapGetUnsafePass, []},
-          {Credo.Check.Warning.UnsafeToAtom, []}
+          {Credo.Check.Warning.MapGetUnsafePass, []}
         ],
         disabled: [
           #
@@ -187,19 +180,30 @@
           #   and be sure to use `mix credo --strict` to see low priority checks)
           #
           {Credo.Check.Consistency.MultiAliasImportRequireUse, []},
+          {Credo.Check.Consistency.UnusedVariableNames, []},
           {Credo.Check.Design.DuplicatedCode, []},
           {Credo.Check.Design.SkipTestWithoutComment, []},
           {Credo.Check.Readability.AliasAs, []},
+          {Credo.Check.Readability.BlockPipe, []},
+          {Credo.Check.Readability.ImplTrue, []},
+          {Credo.Check.Readability.MultiAlias, []},
+          {Credo.Check.Readability.NestedFunctionCalls, []},
+          {Credo.Check.Readability.OneArityFunctionInPipe, []},
+          {Credo.Check.Readability.OnePipePerLine, []},
           {Credo.Check.Readability.SeparateAliasRequire, []},
+          {Credo.Check.Readability.SingleFunctionToBlockPipe, []},
           {Credo.Check.Readability.Specs, []},
           {Credo.Check.Refactor.ABCSize, []},
           {Credo.Check.Refactor.AppendSingleItem, []},
           {Credo.Check.Refactor.IoPuts, []},
           {Credo.Check.Refactor.ModuleDependencies, []},
+          {Credo.Check.Refactor.NegatedIsNil, []},
+          {Credo.Check.Refactor.PassAsyncInTestCases, []},
+          {Credo.Check.Refactor.VariableRebinding, []},
           {Credo.Check.Warning.LazyLogging, []},
           {Credo.Check.Warning.LeakyEnvironment, []},
           {Credo.Check.Warning.MixEnv, []},
-
+          {Credo.Check.Warning.UnsafeToAtom, []}
 
           # {Credo.Check.Refactor.MapInto, []},
 

example/lib/nested/helpers.ex

@@ -1,4 +1,7 @@
 defmodule Nested.Helpers do
+  @moduledoc """
+  Defines a helper function for handling deletions of associations.
+  """
   import Ecto.Changeset
   alias Ecto.Changeset
 

example/lib/nested/members/owner.ex

@@ -1,4 +1,7 @@
 defmodule Nested.Members.Owner do
+  @moduledoc """
+  Schema for pet owners.
+  """
   use Ecto.Schema
   import Ecto.Changeset
   alias Nested.Members.Pet

example/lib/nested/members/pet.ex

@@ -1,4 +1,7 @@
 defmodule Nested.Members.Pet do
+  @moduledoc """
+  Schema for pets, which are owned by owners.
+  """
   use Ecto.Schema
 
   import Ecto.Changeset

example/lib/nested/members/toy.ex

@@ -1,4 +1,7 @@
 defmodule Nested.Members.Toy do
+  @moduledoc """
+  Schema for toys, which are owned by pets.
+  """
   use Ecto.Schema
 
   import Ecto.Changeset

example/lib/nested_web/components/core_components.ex

@@ -11,6 +11,7 @@ defmodule NestedWeb.CoreComponents do
   """
   use Phoenix.Component
 
+  alias Phoenix.HTML.Form
   alias Phoenix.LiveView.JS
 
   @doc """
@@ -360,7 +361,7 @@ defmodule NestedWeb.CoreComponents do
   def input(%{type: "checkbox", value: value} = assigns) do
     assigns =
       assign_new(assigns, :checked, fn ->
-        Phoenix.HTML.Form.normalize_value("checkbox", value)
+        Form.normalize_value("checkbox", value)
       end)
 
     ~H"""

example/lib/nested_web/components/layouts.ex

@@ -1,5 +1,8 @@
 defmodule NestedWeb.Layouts do
+  @moduledoc """
+  Defines the layouts for live views.
+  """
   use NestedWeb, :html
 
-  embed_templates "layouts/*"
+  embed_templates("layouts/*")
 end

example/lib/nested_web/telemetry.ex

@@ -1,4 +1,5 @@
 defmodule NestedWeb.Telemetry do
+  @moduledoc false
   use Supervisor
   import Telemetry.Metrics
 
@@ -86,7 +87,8 @@ defmodule NestedWeb.Telemetry do
   defp periodic_measurements do
     [
       # A module, function and arguments to be invoked periodically.
-      # This function must call :telemetry.execute/3 and a metric must be added above.
+      # This function must call :telemetry.execute/3 and a metric must be added
+      # above.
       # {NestedWeb, :count_users, []}
     ]
   end

example/test/support/data_case.ex

@@ -16,6 +16,8 @@ defmodule Nested.DataCase do
 
   use ExUnit.CaseTemplate
 
+  alias Ecto.Adapters.SQL
+
   using do
     quote do
       alias Nested.Repo
@@ -36,12 +38,8 @@ defmodule Nested.DataCase do
   Sets up the sandbox based on the test tags.
   """
   def setup_sandbox(tags) do
-    pid =
-      Ecto.Adapters.SQL.Sandbox.start_owner!(Nested.Repo,
-        shared: not tags[:async]
-      )
-
-    on_exit(fn -> Ecto.Adapters.SQL.Sandbox.stop_owner(pid) end)
+    pid = SQL.Sandbox.start_owner!(Nested.Repo, shared: not tags[:async])
+    on_exit(fn -> SQL.Sandbox.stop_owner(pid) end)
   end
 
   @doc """

mix.exs

@@ -41,7 +41,7 @@ defmodule EctoNestedChangeset.MixProject do
   # Run "mix help deps" to learn about dependencies.
   defp deps do
     [
-      {:credo, "~> 1.6.0", only: [:dev, :test], runtime: false},
+      {:credo, "~> 1.7.0", only: [:dev, :test], runtime: false},
       {:dialyxir, "~> 1.2.0", only: [:dev], runtime: false},
       {:ecto, "~> 3.7"},
       {:ecto_sql, "~> 3.7", only: :test},