elvis.config

%%%
%%% Copyright 2020 RBKmoney
%%%
%%% Licensed under the Apache License, Version 2.0 (the "License");
%%% you may not use this file except in compliance with the License.
%%% You may obtain a copy of the License at
%%%
%%%     http://www.apache.org/licenses/LICENSE-2.0
%%%
%%% Unless required by applicable law or agreed to in writing, software
%%% distributed under the License is distributed on an "AS IS" BASIS,
%%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
%%% See the License for the specific language governing permissions and
%%% limitations under the License.
%%%
[
    {elvis, [
        {verbose, true},
        {config, [
            #{
                dirs => ["src"],
                filter => "*.erl",
                ruleset => erl_files,
                rules => [
                    % In line with erlfmt settings.
                    {elvis_text_style, line_length, #{limit => 120}},
                    % Was too strict.
                    {elvis_style, dont_repeat_yourself, #{min_complexity => 15}},
                    {elvis_style, god_modules, #{
                        ignore => [
                            % Provides a bunch of simple and easy to understand utilities for the configurator.
                            machinegun_configuration_utils
                        ]
                    }}
                ]
            },
            #{
                dirs => ["test"],
                filter => "*.erl",
                ruleset => erl_files,
                rules => [
                    % In line with erlfmt settings.
                    {elvis_text_style, line_length, #{limit => 120}},
                    % We want to use `ct:pal/2` and friends in test code.
                    {elvis_style, no_debug_call, disable},
                    % Tests are usually more comprehensible when a bit more verbose.
                    {elvis_style, dont_repeat_yourself, #{min_complexity => 20}},
                    {elvis_style, god_modules, #{
                        ignore => [machinegun_prometheus_metric_SUITE]
                    }}
                ]
            },
            #{
                dirs => ["."],
                filter => "rebar.config",
                rules => [
                    {elvis_text_style, line_length, #{limit => 120}},
                    {elvis_text_style, no_tabs},
                    {elvis_text_style, no_trailing_whitespace}
                ]
            },
            #{
                dirs => ["src"],
                filter => "*.app.src",
                rules => [
                    {elvis_text_style, line_length, #{limit => 120}},
                    {elvis_text_style, no_tabs},
                    {elvis_text_style, no_trailing_whitespace}
                ]
            },
            #{
                dirs => ["."],
                filter => "elvis.config",
                ruleset => elvis_config
            }
        ]}
    ]}
].