Packages
credo
1.4.0
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/function_names.ex
defmodule Credo.Check.Readability.FunctionNames do
use Credo.Check,
base_priority: :high,
explanations: [
check: """
Function, macro, and guard names are always written in snake_case in Elixir.
# snake_case
def handle_incoming_message(message) do
end
# not snake_case
def handleIncomingMessage(message) 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.
"""
]
alias Credo.Code.Name
@def_ops [:def, :defp, :defmacro, :defmacrop, :defguard, :defguardp]
@all_sigil_chars ~w(a A b B c C d D e E f F g G h H i I j J k K l L m M n N o O p P q Q r R s S t T u U v V w W x X y Y z Z)
@all_sigil_atoms Enum.map(@all_sigil_chars, &:"sigil_#{&1}")
# all non-special-form operators
@all_nonspecial_operators ~W(! && ++ -- .. <> =~ @ |> || != !== * + - / <= == === > >= ||| &&& <<< >>> <<~ ~>> <~ ~> <~> <|> ^^^ ~~~)a
@doc false
def run(%SourceFile{} = source_file, params \\ []) do
issue_meta = IssueMeta.for(source_file, params)
source_file
|> Credo.Code.prewalk(&traverse(&1, &2, issue_meta), empty_issues())
|> issues_list()
end
defp empty_issues(), do: %{}
defp add_issue(issues, name, arity, issue), do: Map.put_new(issues, {name, arity}, issue)
defp issues_list(issues) do
issues
|> Map.values()
|> Enum.sort_by(& &1.line_no)
end
# Ignore sigil definitions
for sigil <- @all_sigil_atoms do
defp traverse(
{op, _meta, [{unquote(sigil), _sigil_meta, _args} | _tail]} = ast,
issues,
_issue_meta
)
when op in [:def, :defmacro] do
{ast, issues}
end
end
for op <- @def_ops do
# Ignore variables named e.g. `defp`
defp traverse({unquote(op), _meta, nil} = ast, issues, _issue_meta) do
{ast, issues}
end
# ignore non-special-form (overridable) operators
defp traverse(
{unquote(op), _meta, [{operator, _at_meta, _args} | _tail]} = ast,
issues,
_issue_meta
)
when operator in @all_nonspecial_operators do
{ast, issues}
end
defp traverse({unquote(op), _meta, arguments} = ast, issues, issue_meta) do
{ast, issues_for_definition(arguments, issues, issue_meta)}
end
end
defp traverse(ast, issues, _issue_meta) do
{ast, issues}
end
defp issues_for_definition(body, issues, issue_meta) do
case Enum.at(body, 0) do
{:when, _when_meta, [{name, meta, args} | _guard]} ->
issues_for_name(name, args, meta, issues, issue_meta)
{name, meta, args} when is_atom(name) ->
issues_for_name(name, args, meta, issues, issue_meta)
_ ->
issues
end
end
defp issues_for_name({:unquote, _, _}, _args, _meta, issues, _issue_meta) do
issues
end
defp issues_for_name(name, args, meta, issues, issue_meta) do
if name |> to_string |> Name.snake_case?() do
issues
else
issue = issue_for(issue_meta, meta[:line], name)
arity = length(args || [])
add_issue(issues, name, arity, issue)
end
end
defp issue_for(issue_meta, line_no, trigger) do
format_issue(
issue_meta,
message: "Function/macro/guard names should be written in snake_case.",
trigger: trigger,
line_no: line_no
)
end
end