Re-enable Credo ModuleDoc check

Closes #108
This commit is contained in:
Claudio Ortolina
2026-03-13 10:52:01 +00:00
parent 4db9213129
commit 9e1dbfd530
48 changed files with 175 additions and 4 deletions
+27 -4
View File
@@ -4,11 +4,34 @@
name: "default",
checks: %{
extra: [
{Credo.Check.Refactor.Nesting, max_nesting: 3}
{Credo.Check.Refactor.Nesting, max_nesting: 3},
{Credo.Check.Readability.ModuleDoc,
ignore_names: [
# Credo defaults
~r/(\.\w+Controller|\.Endpoint|\.\w+Live(\.\w+)?|\.Repo|\.Router|\.\w+Socket|\.\w+View|\.\w+HTML|\.\w+JSON|\.Telemetry|\.Layouts|\.Mailer)$/,
# Custom: external API internals follow a three-module pattern
# where only the facade needs documentation
~r/\.API(\..*)?$/,
~r/\.Config$/,
# Custom: test support modules
~r/Fixtures/,
# Custom: mix tasks
~r/^Mix\.Tasks\./
],
ignore_modules_using: [
# Credo defaults
Credo.Check,
Ecto.Schema,
Phoenix.LiveView,
~r/\.Web$/,
# Custom: LiveComponents and Oban workers are self-documenting
Oban.Worker,
# Matches `use MusicLibraryWeb, :live_component` etc.
MusicLibraryWeb
]},
{Credo.Check.Refactor.CyclomaticComplexity, max_complexity: 12}
],
disabled: [
{Credo.Check.Readability.ModuleDoc, []}
]
disabled: []
}
# files etc.
}