CredoNaming is a suite of checks to enforce naming best practices in an Elixir project.

## Installation Add the `:credo_naming` package to your `mix.exs` dependencies: ```elixir def deps do [ {:credo_naming, "~> 0.1", only: [:dev, :test], runtime: false} ] end ``` ## Usage You just need to add the checks you want in your `.credo.exs` configuration file. ### Avoid specific terms in module names This check will raise an issue if specific terms are found in module names. ```elixir {CredoNaming.Check.Warning.AvoidSpecificTermsInModuleNames, terms: ["Manager", "Helper", "Helpers"]} ``` With this check configuration for example, a module named `MyApp.UserManager` or `MyApp.FormHelpers` would not be allowed. ## License `CredoNaming` is © 2019 [Mirego](https://www.mirego.com) and may be freely distributed under the [New BSD license](http://opensource.org/licenses/BSD-3-Clause). See the [`LICENSE.md`](https://github.com/mirego/credo_naming/blob/master/LICENSE.md) file. The tag logo is based on [this lovely icon by Vectors Point](https://thenounproject.com/term/tag/2606427), from The Noun Project. Used under a [Creative Commons BY 3.0](http://creativecommons.org/licenses/by/3.0/) license. ## About Mirego [Mirego](https://www.mirego.com) 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](https://life.mirego.com) who imagine and build beautiful Web and mobile applications. We come together to share ideas and [change the world](http://www.mirego.org). We also [love open-source software](https://open.mirego.com) and we try to give back to the community as much as we can.