Packages
credo
1.7.13
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/readability/parentheses_in_condition.ex
defmodule Credo.Check.Readability.ParenthesesInCondition do
use Credo.Check,
id: "EX3013",
base_priority: :high,
tags: [:formatter],
explanations: [
check: """
Because `if` and `unless` are macros, the preferred style is to not use
parentheses around conditions.
# preferred
if valid?(username) do
# ...
end
# NOT preferred
if( valid?(username) ) do
# ...
end
Like all `Readability` issues, this one is not a technical concern.
But you can improve the odds of others reading and liking your code by making
it easier to follow.
"""
]
@doc false
@impl true
def run(%SourceFile{} = source_file, params) do
issue_meta = IssueMeta.for(source_file, params)
source_file
|> Credo.Code.to_tokens()
|> collect_parenthetical_tokens([], nil)
|> find_issues([], issue_meta)
end
defp collect_parenthetical_tokens([], acc, _), do: acc
defp collect_parenthetical_tokens([head | t], acc, prev_head) do
acc =
case check_for_opening_paren(head, t, prev_head) do
false -> acc
token -> acc ++ [token]
end
collect_parenthetical_tokens(t, acc, head)
end
defp check_for_opening_paren(
{:identifier, _, if_or_unless} = start,
[{:"(", _} = next_token | t],
prev_head
)
when if_or_unless in [:if, :unless] do
check_for_closing_paren(start, next_token, t, prev_head)
end
defp check_for_opening_paren(
{:paren_identifier, _, if_or_unless},
_,
{:arrow_op, _, :|>}
)
when if_or_unless in [:if, :unless] do
false
end
defp check_for_opening_paren(
{:paren_identifier, _, if_or_unless} = token,
[{:"(", _} | t],
_
)
when if_or_unless in [:if, :unless] do
if Enum.any?(collect_paren_children(t), &do?/1) do
false
else
token
end
end
defp check_for_opening_paren(_, _, _), do: false
# matches: if( something ) do
# ^^^^
defp check_for_closing_paren(start, {:do, _}, _tail, {:")", _}) do
start
end
# matches: if( something ) == something_else do
# ^^
defp check_for_closing_paren(_start, {:")", _}, [{:comp_op, _, _} | _tail], _prev_head) do
false
end
# matches: if( something ) or something_else do
# ^^
defp check_for_closing_paren(_start, {:")", _}, [{:or_op, _, _} | _tail], _prev_head) do
false
end
# matches: if( something ) and something_else do
# ^^^
defp check_for_closing_paren(_start, {:")", _}, [{:and_op, _, _} | _tail], _prev_head) do
false
end
# matches: if( something ) in something_else do
# ^^
defp check_for_closing_paren(_start, {:")", _}, [{:in_op, _, _} | _tail], _prev_head) do
false
end
# matches: if( 1 + foo ) / bar > 0 do
# ^
defp check_for_closing_paren(_start, {:")", _}, [{:mult_op, _, _} | _tail], _prev_head) do
false
end
# matches: if( 1 + foo ) + bar > 0 do
# ^
defp check_for_closing_paren(_start, {:")", _}, [{:dual_op, _, _} | _tail], _prev_head) do
false
end
# matches: if( 1 &&& foo ) > bar do
# ^
defp check_for_closing_paren(_start, {:")", _}, [{:rel_op, _, _} | _tail], _prev_head) do
false
end
# matches: if( something ), do:
# ^^
defp check_for_closing_paren(start, {:",", _}, _, {:")", _}) do
start
end
defp check_for_closing_paren(_, {:or_op, _, _}, [{:"(", _} | _], _) do
false
end
defp check_for_closing_paren(_, {:and_op, _, _}, [{:"(", _} | _], _) do
false
end
defp check_for_closing_paren(_, {:comp_op, _, _}, [{:"(", _} | _], _) do
false
end
defp check_for_closing_paren(start, token, [next_token | t], _prev_head) do
check_for_closing_paren(start, next_token, t, token)
end
defp check_for_closing_paren(_, _, _, _), do: false
defp do?({_, _, :do}), do: true
defp do?(_), do: false
defp collect_paren_children(x) do
{_, children} = Enum.reduce(x, {0, []}, &collect_paren_child/2)
children
end
defp collect_paren_child({:"(", _}, {nest_level, tokens}), do: {nest_level + 1, tokens}
defp collect_paren_child({:")", _}, {nest_level, tokens}), do: {nest_level - 1, tokens}
defp collect_paren_child(token, {0, tokens}), do: {0, tokens ++ [token]}
defp collect_paren_child(_, {_, _} = state), do: state
defp find_issues([], acc, _issue_meta) do
acc
end
defp find_issues([{_, {line_no, _, _}, trigger} | t], acc, issue_meta) do
new_issue = issue_for(issue_meta, line_no, trigger)
acc = acc ++ [new_issue]
find_issues(t, acc, issue_meta)
end
defp issue_for(issue_meta, line_no, trigger) do
format_issue(
issue_meta,
message: "The condition of `#{trigger}` should not be wrapped in parentheses.",
trigger: trigger,
line_no: line_no
)
end
end