CredoContrib is a set of additional checks for the Credo static analysis tool. Many of the checks are implementations of rules from christopheradams/elixir_style_guide. Contributions welcome!
Add credo_contrib
to the list of dependencies in your mix.exs
:
def deps do
[
{:credo_contrib, "~> 0.2.0"}
]
end
Add CredoContrib
as a plugin in your .credo.exs
to enable all checks:
%{
configs: [
%{
name: "default",
plugins: [
{CredoContrib, []}
]
}
]
}
Or add the desired checks individually:
%{
configs: [
%{
name: "default",
checks: [
{CredoContrib.Check.FunctionBlockSyntax, allow_single_kw_defs: false},
# …
]
}
]
}
Disallows extranneous whitespace in documentation strings:
## GOOD
defmodule Foo do
@moduledoc """
This is a module
"""
@doc """
This is a function
"""
def bar do
:ok
end
end
## BAD
defmodule Foo do
@moduledoc """
This is a module
"""
@doc """
This is a function
"""
def bar do
:ok
end
end
Disallows @doc
strings that do not contain any text.
## GOOD
@doc """
This is a function
"""
def bar do
:ok
end
## BAD
@doc """
"""
def bar do
:ok
end
Disallows usage of ExUnit.Case.test/3 with an empty body.
For unimplemented tests, use ExUnit.Case.test/1 and set ExUnit.start(except: [:not_implemented])
## GOOD
test "something not implemented"
test "something implemented" do
assert 1 + 1 == 2
end
## BAD
test "something not implemented" do
end
Disallows mixing of def …, do:
syntax with multiple def … do … end
-style
definitions
https://github.com/christopheradams/elixir_style_guide#multiple-function-defs
allow_single_kw_defs
(default:true
): Set tofalse
to only allowdef …, do:
syntax for functions with multiple heads
Disallows function names prefixed with a single underscore
https://github.com/christopheradams/elixir_style_guide#private-functions-with-same-name-as-public
Disallows alias __MODULE__
and @foo __MODULE__
https://github.com/christopheradams/elixir_style_guide#module-pseudo-variable
Enforces consistent ordering for module attributes and directives.
https://github.com/christopheradams/elixir_style_guide#module-attribute-ordering
Enforces a consistent naming scheme for modules based on their file path
## GOOD
# lib/foo/bar.ex
defmodule SomeApp.Foo.Bar do
end
# lib/controllers/bar_controller.ex
defmodule SomeApp.BarController do
end
## BAD
# lib/foo/bar/bar.ex
defmodule SomeApp.Foo.Bar do
end
# lib/utils/foo.ex
defmodule SomeApp.Foo do
end
Disallows public and private functions with the same name
https://github.com/christopheradams/elixir_style_guide#private-functions-with-same-name-as-public
Disallows usage of the pipe operator with a single function call
https://github.com/christopheradams/elixir_style_guide#avoid-single-pipelines
ignored_locals
: Keyword list of names and arities of local functions to ignore. E.g.,[expect: 3, stub: 3]
bin/setup
bin/test