CredoFilenameConsistency
CredoFilenameConsistency
is a check to ensure filename consistency across an Elixir project.
Installation
Add the :CredoFilenameConsistency
to your mix.exs
dependencies:
def deps do
[
{:credo_filename_consistency, "~> 0.1.0", only: ~w(dev test)a, runtime: false},
]
end
Usage
You just need to add the check in your .credo.exs
configuration file:
{CredoFilenameConsistency.Check.Consistency.FilenameConsistency, excluded_paths: ["test/support", "priv", "rel", "mix.exs"]}
And now suppose you have a lib/foo.ex
that defines a Bar
module:
$ mix credo
┃ Consistency
┃
┃ [C] ↘ The module defined in `lib/foo.ex` is not named consistently with the
┃ filename. The file should be named either:
┃
┃ ["lib/bar/bar.ex", "lib/bar.ex"]
┃
┃ lib/foo.ex:1:11 #(Bar)
License
CredoFilenameConsistency
is © 2019 Mirego and may be freely distributed under the New BSD license. See the LICENSE.md
file.
About Mirego
Mirego is a team of passionate people who believe that work is a place where you can innovate and have fun. We’re a team of talented people who imagine and build beautiful Web and mobile applications. We come together to share ideas and change the world.
We also love open-source software and we try to give back to the community as much as we can.