Macro Naming Convention

All macro names 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.

-define('myMacro\'sDaBomb!'(), io:format("My macro's da bomb!~n")).
      % ^_macro name______^

myfun() -> ?'myMacro\'sDaBomb!'().

Prefer

-define(MY_MACROS_DA_BOMB(), io:format("My macro's da bomb!~n")).

myfun() -> ?MY_MACROS_DA_BOMB().

Note: this convention avoids the use of single quotes ('), improving readability and reducing visual clutter.

Rationale

Although macros can technically be named using any valid atom syntax - including quoted atoms - most Erlang/OTP documentation adopts the screaming snake case convention recommended by Elvis as the standard.

Options

• regex :: string().
  • default: "^[A-Z](_?[A-Z0-9]+)*$"

• forbidden_regex :: string() | undefined

  • default: undefined

regex was "^([A-Z][A-Z_0-9]+)$" until 4.0.0.

Example configuration

{elvis_style, macro_naming_convention, #{
    regex => "^[A-Z](_?[A-Z0-9]+)*$",
    forbidden_regex => undefined
}}