Packages
credo
0.2.4
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/variable_names.ex
defmodule Credo.Check.Readability.VariableNames do
@moduledoc """
Variable names are always written in snake_case in Elixir.
# snake_case:
incoming_result = handle_incoming_message(message)
# not snake_case
incomingResult = handle_incoming_message(message)
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.
"""
@explanation [check: @moduledoc]
@special_var_names [:__CALLER__, :__DIR__, :__ENV__, :__MODULE__]
alias Credo.Code.Name
use Credo.Check, base_priority: :high
def run(source_file, params \\ []) do
issue_meta = IssueMeta.for(source_file, params)
Credo.Code.traverse(source_file, &traverse(&1, &2, issue_meta))
end
defp traverse({:=, _meta, [lhs, _rhs]} = ast, issues, issue_meta) do
{ast, issues_for_lhs(lhs, issues, issue_meta)}
end
defp traverse(ast, issues, _issue_meta) do
{ast, issues}
end
for op <- [:{}, :%{}, :^, :|, :<>] do
defp issues_for_lhs({unquote(op), _meta, parameters}, issues, issue_meta) do
issues_for_lhs(parameters, issues, issue_meta)
end
end
defp issues_for_lhs({_name, _meta, nil} = value, issues, issue_meta) do
case issue_for_name(value, issue_meta) do
nil -> issues
new_issue -> [new_issue | issues]
end
end
defp issues_for_lhs(list, issues, issue_meta) when is_list(list) do
Enum.reduce(list, issues, &issues_for_lhs(&1, &2, issue_meta))
end
defp issues_for_lhs(tuple, issues, issue_meta) when is_tuple(tuple) do
Enum.reduce(tuple |> Tuple.to_list, issues, &issues_for_lhs(&1, &2, issue_meta))
end
defp issues_for_lhs(_, issues, _issue_meta) do
issues
end
for name <- @special_var_names do
defp issue_for_name({unquote(name), _, nil}, _), do: nil
end
defp issue_for_name({name, meta, nil}, issue_meta) do
unless name |> to_string |> Name.snake_case? do
issue_for(meta[:line], name, issue_meta)
end
end
defp issue_for(line_no, trigger, issue_meta) do
format_issue issue_meta,
message: "Variable names should be written in snake_case.",
trigger: trigger,
line_no: line_no
end
end