Packages
credo
0.4.10-dev
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/pipe_chain_start.ex
defmodule Credo.Check.Refactor.PipeChainStart do
@moduledoc """
Checks that each pipe chains start with a "raw" value for better readability.
"""
@explanation [check: @moduledoc]
@default_params [excluded_functions: []]
use Credo.Check
def run(%SourceFile{ast: ast} = source_file, params \\ []) do
issue_meta = IssueMeta.for(source_file, params)
excluded_functions = params |> Params.get(:excluded_functions, @default_params)
Credo.Code.prewalk(ast, &traverse(&1, &2, issue_meta, excluded_functions))
end
defp traverse({:|>, _, [{:|>, _, _} | _]} = ast, issues, _issue_meta, _excluded_functions) do
{ast, issues}
end
defp traverse({:|>, meta, [lhs | _rhs]} = ast, issues, issue_meta, excluded_functions) do
if valid_chain_start?(lhs, excluded_functions) do
{ast, issues}
else
{ast, issues ++ [issue_for(issue_meta, meta[:line], "TODO")]}
end
end
defp traverse(ast, issues, _issue_meta, _excluded_functions) do
{ast, issues}
end
for atom <- [:%, :%{}, :.., :<<>>, :@, :__aliases__, :unquote, :{}] do
defp valid_chain_start?({unquote(atom), _meta, _arguments}, _excluded_functions) do
true
end
end
# function_call()
defp valid_chain_start?({atom, _, []}, _excluded_functions) when is_atom(atom) do
true
end
# function_call(with, args) and sigils
defp valid_chain_start?({atom, _, arguments} = ast, excluded_functions) when is_atom(atom) and is_list(arguments) do
function_name = to_function_call_name(ast)
sigil?(atom) || excluded_functions |> Enum.member?(function_name)
end
# map[:access]
defp valid_chain_start?({{:., _, [Access, :get]}, _, _}, _excluded_functions) do
true
end
# Module.function_call()
defp valid_chain_start?({{:., _, _}, _, []}, _excluded_functions), do: true
# Module.function_call(with, parameters)
defp valid_chain_start?({{:., _, _}, _, _} = ast, excluded_functions) do
function_name = to_function_call_name(ast)
excluded_functions |> Enum.member?(function_name)
end
defp valid_chain_start?(_, _excluded_functions), do: true
defp sigil?(atom) do
atom |> to_string |> String.match?(~r/^sigil_[a-zA-Z]$/)
end
defp to_function_call_name({_, _, _} = ast) do
{ast, [], []}
|> Macro.to_string()
|> String.replace(~r/\.?\(.*\)$/, "")
end
defp issue_for(issue_meta, line_no, trigger) do
format_issue issue_meta,
message: "Pipe chain should start with a raw value.",
trigger: trigger,
line_no: line_no
end
end