capi-v2/elvis.config

[
    {elvis, [
        {verbose, true},
        {config, [
            #{
                dirs => ["apps/**/src", "apps/**/include"],
                filter => "*.erl",
                ruleset => erl_files,
                rules => [
                    %% Common settings
                    {elvis_text_style, line_length, #{limit => 120}},
                    {elvis_style, nesting_level, #{level => 3}},
                    {elvis_style, function_naming_convention, #{regex => "^([a-z][a-z0-9]*_?)*$"}},
                    {elvis_style, no_if_expression, disable},
                    %% Project settings
                    {elvis_style, numeric_format, #{
                        ignore => [
                            % Elvis fails with `bararg` here
                            capi_handler_utils
                        ]
                    }},
                    % Verbose authorization code triggers this otherwise
                    {elvis_style, dont_repeat_yourself, #{min_complexity => 30}},
                    {elvis_style, god_modules, #{
                        ignore => [
                            % TODO
                            % Need to rethink its responsibilities
                            capi_handler_utils
                        ]
                    }},
                    {elvis_style, invalid_dynamic_call, #{
                        ignore => [
                            % Uses thrift types reflection through generated code
                            capi_domain
                        ]
                    }},
                    {elvis_style, macro_names, #{
                        ignore => [
                            % Abuses lowercase macros too much
                            capi_feature_schemas
                        ]
                    }}
                ]
            },
            #{
                dirs => ["apps/**/test"],
                filter => "*.erl",
                ruleset => erl_files,
                rules => [
                    {elvis_text_style, line_length, #{limit => 120}},
                    {elvis_style, nesting_level, #{level => 3}},
                    {elvis_style, no_if_expression, disable},
                    % We want to use `ct:pal/2` and friends in test code.
                    {elvis_style, no_debug_call, disable},
                    % Assert macros can trigger use of ignored binding, yet we want them for better
                    % readability.
                    {elvis_style, used_ignored_variable, disable},
                    % Tests are usually more comprehensible when a bit more verbose.
                    {elvis_style, dont_repeat_yourself, #{min_complexity => 50}},
                    {elvis_style, god_modules, disable}
                ]
            },
            #{
                dirs => ["."],
                filter => "Makefile",
                ruleset => makefiles
            },
            #{
                dirs => ["."],
                filter => "elvis.config",
                ruleset => elvis_config
            },
            #{
                dirs => [".", "apps/*"],
                filter => "rebar.config",
                ruleset => rebar_config,
                rules => [
                    {elvis_text_style, line_length, #{limit => 120}},
                    {elvis_text_style, no_tabs},
                    {elvis_text_style, no_trailing_whitespace},
                    %% Temporarily disabled till regex pattern is available
                    {elvis_project, no_deps_master_rebar, disable}
                ]
            },
            #{
                dirs => ["apps/*/src"],
                filter => "*.app.src",
                rules => [
                    {elvis_text_style, line_length, #{limit => 120}},
                    {elvis_text_style, no_tabs},
                    {elvis_text_style, no_trailing_whitespace}
                ]
            }
        ]}
    ]}
].