Module elvis_style

Data Types

dont_repeat_yourself_config()

dont_repeat_yourself_config() = #{min_complexity => non_neg_integer(), ignore => [module()]}

empty_rule_config()

empty_rule_config() = #{}

function_naming_convention_config()

function_naming_convention_config() = #{regex => string(), ignore => [module()]}

function_spec()

function_spec() = {module(), atom(), non_neg_integer()} | {module(), atom()}

god_modules_config()

god_modules_config() = #{limit => integer(), ignore => [atom()]}

invalid_dynamic_call_config()

invalid_dynamic_call_config() = #{ignore => [module()]}

line_length_config()

line_length_config() = #{limit => integer(), skip_comments => false | any | whole_line}

max_function_length_config()

max_function_length_config() = #{ignore_functions => [function_spec()], max_length => non_neg_integer(), count_comments => boolean(), count_whitespace => boolean()}

max_module_length_config()

max_module_length_config() = #{count_comments => boolean(), count_whitespace => boolean(), ignore => [atom()], max_length => integer()}

module_naming_convention_config()

module_naming_convention_config() = #{regex => string(), ignore => [module()]}

nesting_level_config()

nesting_level_config() = #{level => integer(), ignore => [atom()]}

no_call_config()

no_call_config() = #{no_call_functions => [function_spec()], ignore => [module()]}

no_common_caveats_call_config()

no_common_caveats_call_config() = #{caveat_functions => [function_spec()], ignore => [module()]}

no_debug_call_config()

no_debug_call_config() = #{debug_functions => [function_spec()], ignore => [module()]}

no_nested_try_catch_config()

no_nested_try_catch_config() = #{ignore => [module()]}

operator_spaces_config()

operator_spaces_config() = #{rules => [{right | left, string()}]}

used_ignored_variable_config()

used_ignored_variable_config() = #{ignore => [module()]}

variable_naming_convention_config()

variable_naming_convention_config() = #{regex => string(), ignore => [module()]}

Function Index

dont_repeat_yourself/3
function_naming_convention/3
god_modules/3
invalid_dynamic_call/3
line_length/3Target can be either a filename or the name of a module.
macro_module_names/3
macro_names/3
max_function_length/3
max_module_length/3
module_naming_convention/3
nesting_level/3
no_behavior_info/3
no_call/3
no_common_caveats_call/3
no_debug_call/3
no_if_expression/3
no_nested_try_catch/3
no_seqbind/3
no_spaces/3
no_spec_with_records/3
no_tabs/3
no_trailing_whitespace/3
no_useless_seqbind/3
operator_spaces/3
state_record_and_type/3
used_ignored_variable/3
variable_naming_convention/3

Function Details

dont_repeat_yourself/3

dont_repeat_yourself(Config::elvis_config:config(), Target::elvis_file:file(), RuleConfig::dont_repeat_yourself_config()) -> [elvis_result:item()]

function_naming_convention/3

function_naming_convention(Config::elvis_config:config(), Target::elvis_file:file(), RuleConfig::function_naming_convention_config()) -> [elvis_result:item()]

god_modules/3

god_modules(Config::elvis_config:config(), Target::elvis_file:file(), RuleConfig::god_modules_config()) -> [elvis_result:item()]

invalid_dynamic_call/3

invalid_dynamic_call(Config::elvis_config:config(), Target::elvis_file:file(), RuleConfig::invalid_dynamic_call_config()) -> [elvis_result:item()]

line_length/3

line_length(Config::elvis_config:config(), Target::elvis_file:file(), RuleConfig::line_length_config()) -> [elvis_result:item()]

Target can be either a filename or the name of a module.

macro_module_names/3

macro_module_names(Config::elvis_config:config(), Target::elvis_file:file(), RuleConfig::empty_rule_config()) -> [elvis_result:item()]

macro_names/3

macro_names(Config::elvis_config:config(), Target::elvis_file:file(), RuleConfig::empty_rule_config()) -> [elvis_result:item()]

max_function_length/3

max_function_length(Config::elvis_config:config(), Target::elvis_file:file(), RuleConfig::max_function_length_config()) -> [elvis_result:item()]

max_module_length/3

max_module_length(Config::elvis_config:config(), Target::elvis_file:file(), RuleConfig::max_module_length_config()) -> [elvis_result:item()]

module_naming_convention/3

module_naming_convention(Config::elvis_config:config(), Target::elvis_file:file(), RuleConfig::module_naming_convention_config()) -> [elvis_result:item()]

nesting_level/3

nesting_level(Config::elvis_config:config(), Target::elvis_file:file(), RuleConfig::nesting_level_config()) -> [elvis_result:item()]

no_behavior_info/3

no_behavior_info(Config::elvis_config:config(), Target::elvis_file:file(), RuleConfig::empty_rule_config()) -> [elvis_result:item()]

no_call/3

no_call(Config::elvis_config:config(), Target::elvis_file:file(), RuleConfig::no_call_config()) -> [elvis_result:item()]

no_common_caveats_call/3

no_common_caveats_call(Config::elvis_config:config(), Target::elvis_file:file(), RuleConfig::no_common_caveats_call_config()) -> [elvis_result:item()]

no_debug_call/3

no_debug_call(Config::elvis_config:config(), Target::elvis_file:file(), RuleConfig::no_debug_call_config()) -> [elvis_result:item()]

no_if_expression/3

no_if_expression(Config::elvis_config:config(), Target::elvis_file:file(), RuleConfig::empty_rule_config()) -> [elvis_result:item()]

no_nested_try_catch/3

no_nested_try_catch(Config::elvis_config:config(), Target::elvis_file:file(), RuleConfig::no_nested_try_catch_config()) -> [elvis_result:item()]

no_seqbind/3

no_seqbind(Config::elvis_config:config(), Target::elvis_file:file(), RuleConfig::empty_rule_config()) -> [elvis_result:item()]

no_spaces/3

no_spaces(Config::elvis_config:config(), Target::elvis_file:file(), RuleConfig::empty_rule_config()) -> [elvis_result:item()]

no_spec_with_records/3

no_spec_with_records(Config::elvis_config:config(), Target::elvis_file:file(), RuleConfig::empty_rule_config()) -> [elvis_result:item()]

no_tabs/3

no_tabs(Config::elvis_config:config(), Target::elvis_file:file(), RuleConfig::empty_rule_config()) -> [elvis_result:item()]

no_trailing_whitespace/3

no_trailing_whitespace(Config::elvis_config:config(), Target::elvis_file:file(), RuleConfig::map()) -> [elvis_result:item()]

no_useless_seqbind/3

no_useless_seqbind(Config::elvis_config:config(), Target::elvis_file:file(), RuleConfig::empty_rule_config()) -> [elvis_result:item()]

operator_spaces/3

operator_spaces(Config::elvis_config:config(), Target::elvis_file:file(), RuleConfig::operator_spaces_config()) -> [elvis_result:item()]

state_record_and_type/3

state_record_and_type(Config::elvis_config:config(), Target::elvis_file:file(), RuleConfig::empty_rule_config()) -> [elvis_result:item()]

used_ignored_variable/3

used_ignored_variable(Config::elvis_config:config(), Target::elvis_file:file(), RuleConfig::used_ignored_variable_config()) -> [elvis_result:item()]

variable_naming_convention/3

variable_naming_convention(Config::elvis_config:config(), Target::elvis_file:file(), RuleConfig::variable_naming_convention_config()) -> [elvis_result:item()]


Generated by EDoc