Module elvis_style

Data Types

atom_naming_convention_config()

atom_naming_convention_config() = #{ignore => [ignorable()], regex => string(), enclosed_atoms => same | string()}

dont_repeat_yourself_config()

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

empty_rule_config()

empty_rule_config() = #{ignore => [ignorable()]}

function_naming_convention_config()

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

function_spec()

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

god_modules_config()

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

ignorable()

ignorable() = module() | {module(), atom()} | {module(), atom(), arity()}

macro_names_config()

macro_names_config() = #{ignore => [ignorable()], regex => string()}

max_function_length_config()

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

max_module_length_config()

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

module_naming_convention_config()

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

nesting_level_config()

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

no_call_config()

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

no_common_caveats_call_config()

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

no_debug_call_config()

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

operator_spaces_config()

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

variable_naming_convention_config()

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

Function Index

atom_naming_convention/3
default/1
dont_repeat_yourself/3
function_naming_convention/3
god_modules/3
invalid_dynamic_call/3
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_spec_with_records/3
operator_spaces/3
option/3
state_record_and_type/3
used_ignored_variable/3
variable_naming_convention/3

Function Details

atom_naming_convention/3

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

default/1

default(Rule::atom()) -> DefaultRuleConfig::term()

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::empty_rule_config()) -> [elvis_result:item()]

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::macro_names_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::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()]

operator_spaces/3

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

option/3

option(OptionName, RuleConfig, Rule) -> OptionValue

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::empty_rule_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