New rule: Strict Module Layout

[elbrujohalcon]

Strict Module Layout

Brief Description

Provide module parts in the required order.

-module(…).

-include[_lib](…).

-dialyzer(…).
-elvis(…).
-format #{…}.
-hank(…).
-mixin(…).
…

-type(…).
-type(…).
…

-export_type(…).

-export(…).

exported_function_1(…) ->
…

exported_function_2(…) ->
…

non_exported_function_1(…) –>
…

Should be on by default?

YES

Options

• order :: [Part] when Part :: module | includes | types | … | everything_else (default: ??)

We need to come up with a list of all possible parts and a reasonable default for them. We can inspire ourselves in Credo (link below) but Erlang has some extra attribute types and we need to be able to correctly deal with -if, -ifdef, and all its friends.

Reasoning

Paraphrasing Credo documentation:

Like all Readability issues, this one is not a technical concern. But you can improve the odds of others reading and liking your code by making it easier to follow.

Origin (#281)

Inspired by the Consistency.Readability.StrictModuleLayout rule from Credo