CredoNaming v0.6.0 CredoNaming.Check.Warning.AvoidSpecificTermsInModuleNames View Source

This check has a base priority of low and works with any version of Elixir.

Explanation

In an effort to encourage more accurate module naming practices, it is sometimes useful to maintain a list of terms to avoid in module names.

For example, if the list of terms to avoid is ["Manager", "Fetcher"]:

# preferred

defmodule Accounts do
end

defmodule App.Networking do
end

# NOT preferred

defmodule AccountManager do
end

defmodule App.DataFetcher do
end

Configuration parameters

Use the following parameters to configure this check:

  • terms: A list of terms to avoid

    Defaults to []

Parameters can be configured via the .credo.exs config file.

Link to this section Summary

Link to this section Functions

Link to this function

traverse(ast, issues, terms, issue_meta) View Source