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/consistency/space_around_operators.ex
defmodule Credo.Check.Consistency.SpaceAroundOperators do
@moduledoc """
Use spaces around operators like `+`, `-`, `*` and `/`. This is the
**preferred** way, although other styles are possible, as long as it is
applied consistently.
# preferred way
1 + 2 * 4
# also okay
1+2*4
While this is not necessarily a concern for the correctness of your code,
you should use a consistent style throughout your codebase.
"""
@explanation [check: @moduledoc]
@code_patterns [
Credo.Check.Consistency.SpaceAroundOperators.WithSpace,
Credo.Check.Consistency.SpaceAroundOperators.WithoutSpace
]
@default_params [ignore: [:|]]
alias Credo.Check.Consistency.Helper
alias Credo.Check.PropertyValue
use Credo.Check, run_on_all: true, base_priority: :high
# TODO: add *ignored* operators, so you can add "|" and still write
# [head|tail] while enforcing 2 + 3 / 1 ...
@doc false
def run(source_files, params \\ []) when is_list(source_files) do
source_files
|> Helper.run_code_patterns(@code_patterns, params)
|> Helper.append_issues_via_issue_service(&issue_for/5, params)
:ok
end
defp issue_for(_issue_meta, _actual_props, nil, _picked_count, _total_count), do: nil
defp issue_for(_issue_meta, [], _expected_prop, _picked_count, _total_count), do: nil
defp issue_for(issue_meta, actual_prop, expected_prop, _picked_count, _total_count) do
line_no = PropertyValue.meta(actual_prop, :line_no)
column = PropertyValue.meta(actual_prop, :column)
trigger = PropertyValue.meta(actual_prop, :trigger)
actual_prop = PropertyValue.get(actual_prop)
line = issue_meta |> IssueMeta.source_file() |> SourceFile.line_at(line_no)
params = issue_meta |> IssueMeta.params()
ignored_triggers = params |> Params.get(:ignore, @default_params)
if !Enum.member?(ignored_triggers, trigger) && create_issue?(line, column, trigger) do
format_issue issue_meta,
message: message_for(actual_prop, expected_prop),
line_no: line_no,
column: column,
trigger: trigger
end
end
defp message_for(:with_space, :without_space) do
"There are no spaces around operators most of the time, but here there are."
end
defp message_for(:without_space, :with_space) do
"There are spaces around operators most of the time, but not here."
end
# Don't create issues for `&Mod.fun/4`
defp create_issue?(line, column, :/) do
~r/\&[a-zA-Z0-9\.\_\?\!]+\/\d+/ # pattern to detect &Mod.fun/4
|> Regex.run(line, return: :index)
|> List.wrap
|> Enum.any?(fn({start_index, end_index}) ->
start_index < column && end_index > column
end)
end
# Don't create issues for `c = -1`
defp create_issue?(line, column, operator) when operator in [:+, :-] do
!number_with_sign?(line, column) &&
!number_in_range?(line, column) &&
!(operator == :- && minus_in_binary_size?(line, column))
end
defp create_issue?(_, _, _), do: true
defp number_with_sign?(line, column) do
line
|> String.slice(0..column - 2) # -2 because we need to substract the operator
|> String.match?(~r/(\s+|\@[a-zA-Z0-9\_]+|[\{\[\(\,\:\>\<\=\+\-\*\/])\s*$/)
end
defp number_in_range?(line, column) do
line
|> String.slice(column..-1)
|> String.match?(~r/^\d+\.\./)
end
# TODO: this implementation is a bit naive. improve it.
defp minus_in_binary_size?(line, column) do
binary_pattern_start_before? =
line
|> String.slice(0..column - 2) # -2 because we need to substract the operator
|> String.match?(~r/\<\</)
double_colon_before? =
line
|> String.slice(0..column - 2) # -2 because we need to substract the operator
|> String.match?(~r/\:\:/)
binary_pattern_end_after? =
line
|> String.slice(column..-1) # -1 because we need to substract the operator
|> String.match?(~r/\>\>/)
typed_after? =
line
|> String.slice(column..-1) # -1 because we need to substract the operator
|> String.match?(~r/^\s*(signed|unsigned|binary|size)/)
heuristics_met_count =
[
binary_pattern_start_before?,
binary_pattern_end_after?,
double_colon_before?,
typed_after?
]
|> Enum.filter(&(&1))
|> Enum.count
heuristics_met_count >= 2
end
end