elvis_style (elvis_core v2.0.0)
Link to this section Summary
Link to this section Types
Link to this type
atom_naming_convention_config/0
-type atom_naming_convention_config() :: #{ignore => [ignorable()], regex => string(), enclosed_atoms => same | string()}.
Link to this type
dont_repeat_yourself_config/0
-type dont_repeat_yourself_config() :: #{ignore => [ignorable()], min_complexity => non_neg_integer()}.
Link to this type
empty_rule_config/0
-type empty_rule_config() :: #{ignore => [ignorable()]}.
Link to this type
function_naming_convention_config/0
-type function_naming_convention_config() :: #{ignore => [ignorable()], regex => string()}.
Link to this type
function_spec/0
-type function_spec() :: {module(), atom(), arity()} | {module(), atom()}.
Link to this type
god_modules_config/0
-type god_modules_config() :: #{ignore => [ignorable()], limit => integer()}.
Link to this type
ignorable/0
-type ignorable() :: module() | {module(), atom()} | {module(), atom(), arity()}.
Link to this type
macro_names_config/0
-type macro_names_config() :: #{ignore => [ignorable()], regex => string()}.
Link to this type
max_function_length_config/0
-type max_function_length_config() :: #{ignore => [ignorable()], max_length => non_neg_integer(), count_comments => boolean(), count_whitespace => boolean()}.
Link to this type
max_module_length_config/0
-type max_module_length_config() :: #{ignore => [ignorable()], count_comments => boolean(), count_whitespace => boolean(), max_length => integer()}.
Link to this type
module_naming_convention_config/0
-type module_naming_convention_config() :: #{ignore => [ignorable()], regex => string()}.
Link to this type
nesting_level_config/0
-type nesting_level_config() :: #{ignore => [ignorable()], level => integer()}.
Link to this type
no_author_config/0
-type no_author_config() :: #{ignore => [ignorable()]}.
Link to this type
no_block_expressions_config/0
-type no_block_expressions_config() :: #{ignore => [ignorable()]}.
Link to this type
no_call_config/0
-type no_call_config() :: #{ignore => [ignorable()], no_call_functions => [function_spec()]}.
Link to this type
no_catch_expressions_config/0
-type no_catch_expressions_config() :: #{ignore => [ignorable()]}.
Link to this type
no_common_caveats_call_config/0
-type no_common_caveats_call_config() :: #{ignore => [ignorable()], caveat_functions => [function_spec()]}.
Link to this type
no_debug_call_config/0
-type no_debug_call_config() :: #{ignore => [ignorable()], debug_functions => [function_spec()]}.
Link to this type
no_macros_config/0
-type no_macros_config() :: #{allow => [atom()], ignore => [ignorable()]}.
Link to this type
no_space_config/0
-type no_space_config() :: #{ignore => [ignorable()], rules => [{right | left, string()}]}.
Link to this type
numeric_format_config/0
-type numeric_format_config() :: #{ignore => [ignorable()], regex => string(), int_regex => same | string(), float_regex => same | string()}.
Link to this type
operator_spaces_config/0
-type operator_spaces_config() :: #{ignore => [ignorable()], rules => [{right | left, string()}]}.
Link to this type
variable_naming_convention_config/0
-type variable_naming_convention_config() :: #{ignore => [ignorable()], regex => string()}.
Link to this section Functions
Link to this function
always_shortcircuit(Config, Target, RuleConfig)
-spec always_shortcircuit(elvis_config:config(), elvis_file:file(), empty_rule_config()) -> [elvis_result:item()].
Link to this function
atom_naming_convention(Config, Target, RuleConfig)
-spec atom_naming_convention(elvis_config:config(), elvis_file:file(), atom_naming_convention_config()) -> [elvis_result:item()].
Link to this function
behaviour_spelling(Config, Target, RuleConfig)
-spec behaviour_spelling(elvis_config:config(), elvis_file:file(), empty_rule_config()) -> [elvis_result:item()].
Link to this function
default(Rule)
-spec default(Rule :: atom()) -> DefaultRuleConfig :: term().
Link to this function
dont_repeat_yourself(Config, Target, RuleConfig)
-spec dont_repeat_yourself(elvis_config:config(), elvis_file:file(), dont_repeat_yourself_config()) -> [elvis_result:item()].
Link to this function
function_naming_convention(Config, Target, RuleConfig)
-spec function_naming_convention(elvis_config:config(), elvis_file:file(), function_naming_convention_config()) -> [elvis_result:item()].
Link to this function
god_modules(Config, Target, RuleConfig)
-spec god_modules(elvis_config:config(), elvis_file:file(), god_modules_config()) -> [elvis_result:item()].
Link to this function
invalid_dynamic_call(Config, Target, RuleConfig)
-spec invalid_dynamic_call(elvis_config:config(), elvis_file:file(), empty_rule_config()) -> [elvis_result:item()].
Link to this function
macro_module_names(Config, Target, RuleConfig)
-spec macro_module_names(elvis_config:config(), elvis_file:file(), empty_rule_config()) -> [elvis_result:item()].
Link to this function
macro_names(Config, Target, RuleConfig)
-spec macro_names(elvis_config:config(), elvis_file:file(), macro_names_config()) -> [elvis_result:item()].
Link to this function
max_function_length(Config, Target, RuleConfig)
-spec max_function_length(elvis_config:config(), elvis_file:file(), max_function_length_config()) -> [elvis_result:item()].
Link to this function
max_module_length(Config, Target, RuleConfig)
-spec max_module_length(elvis_config:config(), elvis_file:file(), max_module_length_config()) -> [elvis_result:item()].
Link to this function
module_naming_convention(Config, Target, RuleConfig)
-spec module_naming_convention(elvis_config:config(), elvis_file:file(), module_naming_convention_config()) -> [elvis_result:item()].
Link to this function
nesting_level(Config, Target, RuleConfig)
-spec nesting_level(elvis_config:config(), elvis_file:file(), nesting_level_config()) -> [elvis_result:item()].
Link to this function
no_author(Config, Target, RuleConfig)
-spec no_author(elvis_config:config(), elvis_file:file(), no_author_config()) -> [elvis_result:item()].
Link to this function
no_behavior_info(Config, Target, RuleConfig)
-spec no_behavior_info(elvis_config:config(), elvis_file:file(), empty_rule_config()) -> [elvis_result:item()].
Link to this function
no_block_expressions(Config, Target, RuleConfig)
-spec no_block_expressions(elvis_config:config(), elvis_file:file(), no_block_expressions_config()) -> [elvis_result:item()].
Link to this function
no_call(Config, Target, RuleConfig)
-spec no_call(elvis_config:config(), elvis_file:file(), no_call_config()) -> [elvis_result:item()].
Link to this function
no_catch_expressions(Config, Target, RuleConfig)
-spec no_catch_expressions(elvis_config:config(), elvis_file:file(), no_catch_expressions_config()) -> [elvis_result:item()].
Link to this function
no_common_caveats_call(Config, Target, RuleConfig)
-spec no_common_caveats_call(elvis_config:config(), elvis_file:file(), no_common_caveats_call_config()) -> [elvis_result:item()].
Link to this function
no_debug_call(Config, Target, RuleConfig)
-spec no_debug_call(elvis_config:config(), elvis_file:file(), no_debug_call_config()) -> [elvis_result:item()].
Link to this function
no_dollar_space(Config, Target, RuleConfig)
-spec no_dollar_space(elvis_config:config(), elvis_file:file(), empty_rule_config()) -> [elvis_result:item()].
Link to this function
no_if_expression(Config, Target, RuleConfig)
-spec no_if_expression(elvis_config:config(), elvis_file:file(), empty_rule_config()) -> [elvis_result:item()].
Link to this function
no_macros(ElvisConfig, RuleTarget, RuleConfig)
-spec no_macros(elvis_config:config(), elvis_file:file(), no_macros_config()) -> [elvis_result:item()].
Link to this function
no_nested_try_catch(Config, Target, RuleConfig)
-spec no_nested_try_catch(elvis_config:config(), elvis_file:file(), empty_rule_config()) -> [elvis_result:item()].
Link to this function
no_space(Config, Target, RuleConfig)
-spec no_space(elvis_config:config(), elvis_file:file(), no_space_config()) -> [elvis_result:item()].
Link to this function
no_spec_with_records(Config, Target, RuleConfig)
-spec no_spec_with_records(elvis_config:config(), elvis_file:file(), empty_rule_config()) -> [elvis_result:item()].
Link to this function
no_successive_maps(Config, Target, RuleConfig)
-spec no_successive_maps(elvis_config:config(), elvis_file:file(), empty_rule_config()) -> [elvis_result:item()].
Link to this function
no_throw(Config, Target, RuleConfig)
-spec no_throw(elvis_config:config(), elvis_file:file(), empty_rule_config()) -> [elvis_result:item()].
Link to this function
numeric_format(Config, Target, RuleConfig)
-spec numeric_format(elvis_config:config(), elvis_file:file(), numeric_format_config()) -> [elvis_result:item()].
Link to this function
operator_spaces(Config, Target, RuleConfig)
-spec operator_spaces(elvis_config:config(), elvis_file:file(), operator_spaces_config()) -> [elvis_result:item()].
Link to this function
option(OptionName, RuleConfig, Rule)
-spec option(OptionName, RuleConfig, Rule) -> OptionValue when OptionName :: atom(), RuleConfig :: elvis_core:rule_config(), Rule :: atom(), OptionValue :: term().
Link to this function
state_record_and_type(Config, Target, RuleConfig)
-spec state_record_and_type(elvis_config:config(), elvis_file:file(), empty_rule_config()) -> [elvis_result:item()].
Link to this function
used_ignored_variable(Config, Target, RuleConfig)
-spec used_ignored_variable(elvis_config:config(), elvis_file:file(), empty_rule_config()) -> [elvis_result:item()].
Link to this function
variable_naming_convention(Config, Target, RuleConfig)
-spec variable_naming_convention(elvis_config:config(), elvis_file:file(), variable_naming_convention_config()) -> [elvis_result:item()].