Packages
credo
1.7.19
1.7.19
1.7.18
1.7.17
1.7.16
1.7.15
1.7.14
1.7.13
1.7.12
1.7.11
1.7.10
1.7.9
1.7.8
1.7.7
1.7.7-rc.0
1.7.6
1.7.5
1.7.4
1.7.3
1.7.2
1.7.2-rc.4
1.7.2-rc.3
1.7.2-rc.2
1.7.2-rc.1
1.7.2-rc.0
1.7.1
1.7.0
1.7.0-rc.2
1.7.0-rc.1
1.6.7
1.6.6
1.6.5
1.6.4
1.6.3
1.6.2
1.6.1
1.6.0
1.6.0-rc.1
1.6.0-rc.0
1.5.6
1.5.5
1.5.4
1.5.3
1.5.2
1.5.1
1.5.0
1.5.0-rc.5
1.5.0-rc.4
1.5.0-rc.3
1.5.0-rc.2
1.5.0-rc.1
1.4.1
1.4.0
1.4.0-rc.2
1.4.0-rc.1
1.3.2
1.3.1
1.3.0
1.3.0-rc3
1.3.0-rc2
1.3.0-rc1
1.2.3
1.2.2
1.2.1
1.2.0
1.2.0-rc4
1.2.0-rc3
1.2.0-rc2
1.2.0-rc1
1.1.5
1.1.4
1.1.3
1.1.2
1.1.1
1.1.0
1.1.0-rc3
1.1.0-rc2
1.1.0-rc1
1.0.5
1.0.4
1.0.3
1.0.2
1.0.1
1.0.1-rc1
1.0.0
1.0.0-rc1
0.10.2
0.10.1
0.10.0
0.9.3
0.9.2
0.9.1
0.9.0
0.9.0-rc8
0.9.0-rc7
0.9.0-rc6
0.9.0-rc5
0.9.0-rc4
0.9.0-rc3
0.9.0-rc2
0.9.0-rc1
0.8.10
0.8.9
0.8.8
0.8.7
0.8.6
0.8.5
0.8.4
0.8.3
0.8.2
0.8.1
0.8.0
0.8.0-rc7
0.8.0-rc6
0.8.0-rc5
0.8.0-rc4
0.8.0-rc3
0.8.0-rc2
0.8.0-rc1
0.7.4
0.7.3
0.7.2
0.7.1
0.7.0
0.6.1
0.6.0
0.6.0-rc2
0.6.0-rc1
0.5.3
0.5.2
0.5.1
0.5.0
0.4.14
0.4.13
0.4.12
0.4.11
0.4.10
0.4.10-dev
0.4.9
0.4.8
0.4.7
0.4.6
0.4.5
0.4.4
0.4.3
0.4.2
0.4.1
0.4.0
0.4.0-beta5
0.4.0-beta4
0.4.0-beta3
0.4.0-beta2
0.4.0-beta1
0.3.13
0.3.12
0.3.11
0.3.10
0.3.9
0.3.8
0.3.7
0.3.6
0.3.5
0.3.4
0.3.3
0.3.2
0.3.1
0.3.0
0.3.0-dev2
0.3.0-dev
0.2.6
0.2.5
0.2.4
0.2.3
0.2.2
0.2.1
0.2.0
0.1.10
0.1.9
0.1.8
0.1.7
0.1.6
0.1.5
0.1.4
0.1.3
0.1.2
0.1.1
0.1.0
0.0.1-dev
A static code analysis tool with a focus on code consistency and teaching.
Current section
Files
Jump to
Current section
Files
lib/credo/check/refactor/module_dependencies.ex
defmodule Credo.Check.Refactor.ModuleDependencies do
use Credo.Check,
id: "EX4017",
base_priority: :normal,
tags: [:controversial],
param_defaults: [
max_deps: 10,
dependency_namespaces: [],
excluded_namespaces: [],
excluded_paths: [~r"/test/", "test"]
],
explanations: [
check: """
This module might be doing too much. Consider limiting the number of
module dependencies.
As always: This is just a suggestion. Check the configuration options for
tweaking or disabling this check.
""",
params: [
max_deps: "Maximum number of module dependencies.",
dependency_namespaces: "List of dependency namespaces to include in this check",
excluded_namespaces: "List of namespaces to exclude from this check",
excluded_paths: "List of paths or regex to exclude from this check"
]
]
alias Credo.Code.Module
alias Credo.Code.Name
@doc false
@impl true
def run(%SourceFile{} = source_file, params) do
ctx = Context.build(source_file, params, __MODULE__)
if ignore_path?(source_file.filename, ctx.params.excluded_paths) do
[]
else
result = Credo.Code.prewalk(source_file, &walk/2, ctx)
result.issues
end
end
defp walk({:defmodule, meta, [mod | _]} = ast, ctx) do
module_name = Name.full(mod)
if has_namespace?(module_name, ctx.params.excluded_namespaces) do
{ast, ctx}
else
module_dependencies = get_dependencies(ast, ctx.params.dependency_namespaces)
{ast,
put_issue(
ctx,
issue_for_module(module_dependencies, ctx.params.max_deps, ctx, meta, module_name)
)}
end
end
defp walk(ast, ctx) do
{ast, ctx}
end
defp ignore_path?(filename, excluded_paths) do
directory = Path.dirname(filename)
Enum.any?(excluded_paths, &matches?(directory, &1))
end
defp matches?(directory, %Regex{} = regex), do: Regex.match?(regex, directory)
defp matches?(directory, path) when is_binary(path), do: String.starts_with?(directory, path)
defp get_dependencies(ast, dependency_namespaces) do
aliases = Module.aliases(ast)
ast
|> Module.modules()
|> with_fullnames(aliases)
|> filter_namespaces(dependency_namespaces)
end
defp with_fullnames(dependencies, aliases) do
dependencies
|> Enum.map(&full_name(&1, aliases))
|> Enum.uniq()
end
defp filter_namespaces(dependencies, namespaces) do
Enum.filter(dependencies, &keep?(&1, namespaces))
end
defp keep?(_module_name, []), do: true
defp keep?(module_name, namespaces), do: has_namespace?(module_name, namespaces)
defp has_namespace?(module_name, namespaces) do
Enum.any?(namespaces, &String.starts_with?(module_name, &1))
end
defp full_name(dep, aliases) do
aliases
|> Enum.find(&String.ends_with?(&1, dep))
|> case do
nil -> dep
full_name -> full_name
end
end
defp issue_for_module(deps, max_deps, ctx, meta, module_name) when length(deps) > max_deps do
format_issue(
ctx,
message: "Module has too many dependencies: #{length(deps)} (max is #{max_deps})",
trigger: module_name,
line_no: meta[:line]
)
end
defp issue_for_module(_, _, _, _, _), do: nil
end