credo_module_function_ordering v0.1.0 CredoModuleFunctionOrdering.Rule

In a module, functions should be ordered to provide better readability across the code base by exposing the most important functions definition types first (e.g public ones) followed by the private functions The order of function heirarchy in a module from top to bottom is as follows:

defstruct defexception defguard def defdelegate defmacro defguardp defp defmacrop defoverridable

Link to this section Summary

Functions

Returns the base priority for the check.

Returns the category for the check.

Callback implementation for Credo.Check.explanation/0.

Callback implementation for Credo.Check.run_on_all?/0.

Link to this section Functions

Link to this function

base_priority()

Returns the base priority for the check.

Callback implementation for Credo.Check.base_priority/0.

Returns the category for the check.

Callback implementation for Credo.Check.category/0.

Link to this function

elixir_version()

Callback implementation for Credo.Check.explanation/0.

Link to this function

explanation_for_params()

Callback implementation for Credo.Check.explanation_for_params/0.

Link to this function

format_issue(issue_meta, opts)

Callback implementation for Credo.Check.format_issue/2.

Link to this function

params_defaults()

Link to this function

run(source_file, params \\ [])

Callback implementation for Credo.Check.run_on_all?/0.