Function Naming Convention

All functions should conform to the pattern defined by the regex option pattern, unless they match the forbidden_regex option pattern, in which case they are disallowed.

Avoid

This is a convention aimed at ensuring consistency, rather than a coding issue.

a____function() -> ok.

...

another___function() ->
    ...

Prefer

a_function() -> ok.

...

another_function() ->
    ...

Rationale

By defining a regular expression for naming functions you increase consistency across your codebase.

Options

• regex :: string()
  • default: "^[a-z](_?[a-z0-9]+)*(_test_)?$"

• forbidden_regex :: string() | undefined

  • default: undefined

regex was "^([a-z][a-z0-9]*_?)*(_SUITE)?$" until 4.0.0.

Example configuration

{elvis_style, function_naming_convention, #{
    regex => "^[a-z](_?[a-z0-9]+)*(_test_)?$",
    forbidden_regex => undefined
}}