inaka · elbrujohalcon · Jul 3, 2025 · Jun 28, 2025 · Jun 28, 2025 · Jun 28, 2025
diff --git a/README.md b/README.md
@@ -78,15 +78,12 @@ We have only presented results where all files were well-behaved (i.e. they resp
 so here's an example of how the output looks when files break some of the rules:
 
 ```shell
-# ../../test/examples/fail_line_length.erl [FAIL]
-  - line_length
-    - Line 14 is too long: "    io:format(\"This line is 81 characters long and should be detected, yeah!!!\").".
-    - Line 20 is too long: "    io:format(\"This line is 90 characters long and should be detected!!!!!!!!!!!!!!!!!!\").".
-# ../../test/examples/fail_no_tabs.erl [FAIL]
-  - no_tabs
-    - Line 6 has a tab at column 0.
-    - Line 15 has a tab at column 0.
-# ../../test/examples/small.erl [OK]
+# test/examples/british_behaviour_spelling.erl [FAIL]
+  - state_record_and_type (https://github.com/inaka/elvis_core/tree/main/doc_rules/elvis_style/state_record_and_type.md)
+    - This module implements an OTP behavior but is missing a '#state{}' record.
+# test/examples/fail_always_shortcircuit.erl [FAIL]
+  - always_shortcircuit (https://github.com/inaka/elvis_core/tree/main/doc_rules/elvis_style/always_shortcircuit.md)
+    - At line 5, column 45, unexpected non-shortcircuiting operator 'or' was found; prefer 'orelse'.
 ```
 
 ## Configuration
@@ -105,9 +102,6 @@ An `elvis.config` file looks something like this:
       , #{ dirs    => ["."]
          , filter  => "rebar.config"
          , ruleset => rebar_config }
-      , #{ dirs    => ["."]
-         , filter  => "elvis.config"
-         , ruleset => elvis_config }
     ]}
     % output_format (optional): how to format the output.
     % Possible values are 'plain', 'colors' or 'parsable' (default='colors').
@@ -133,10 +127,13 @@ The `dirs` key is a list that tells `elvis_core` where it should look for the fi
 
 If you want to override the [pre-defined rules](#pre-defined-rules), for a given ruleset, you need
 to specify them in a `rules` key which is a list of items with the following structure
-`{Module, Function, RuleConfig}`, or `{Module, Function}` - if the rule takes no configuration
+`{RuleNamespace, Rule, RuleConfig}`, or `{RuleNamespace, Rule}` - if the rule takes no configuration
 values. You can also `disable` certain rules if you want to, by specifying them in the `rules` key
 and passing `disable` as a third argument.
 
+`RuleNamespace` is an Erlang module that implements the `elvis_rule` behaviour.
+`Rule` is a function exported from `RuleNamespace`.
+
 #### Disabling Rules
 
 **IMPORTANT**: `disable` will only work if you also provided a `ruleset` as shown above.
@@ -190,10 +187,8 @@ to the one presented by `dialyzer`, like `<file>:<line>:<rule>:<message>`:
 
 <!-- markdownlint-disable MD013 -->
 ```shell
-src/example.erl:1:god_modules:This module has too many functions (56). Consider breaking it into a number of modules.
-src/example_a.erl:341:no_debug_call:Remove the debug call to io:format/2 on line 341.
-src/example_a.erl:511:used_ignored_variable:Ignored variable is being used on line 511 and column 54.
-src/example_a.erl:1252:used_ignored_variable:Ignored variable is being used on line 1252 and column 21.
+test/examples/british_behaviour_spelling.erl:-1:state_record_and_type:This module implements an OTP behavior but is missing a '#state{}' record.```
+test/examples/fail_always_shortcircuit.erl:5:always_shortcircuit:At line 5, column 45, unexpected non-shortcircuiting operator ''or'' was found; prefer 'orelse'.
 ```
 <!-- markdownlint-enable MD013 -->
 
@@ -240,12 +235,11 @@ found in this repository's [RULES.md](https://github.com/inaka/elvis_core/blob/m
 
 ### User-defined rules
 
-The implementation of a new rule is a function that takes 3 arguments in the following order:
+The implementation of a new rule is a function that takes 2 arguments in the following order:
 
+1. `t:elvis_rule:t()`: the opaque rule to implement
 1. `t:elvis_config:config()`: the value of option `config` as found in the
 [configuration](#configuration),
-1. `t:elvis_file:file()`: the file to be analyzed,
-1. `t:erlang:map()`: a configuration map specific to your user-defined rule.
 
 This means you can define rules of your own (user-defined rules) as long as the functions that
 implement them respect this interface.

diff --git a/RULES.md b/RULES.md
@@ -20,24 +20,20 @@ Most, if not all, of the rules will present (opinionated) documentation sections
 - [Always Shortcircuit](doc_rules/elvis_style/always_shortcircuit.md)
 - [Atom Naming Convention](doc_rules/elvis_style/atom_naming_convention.md)
 - [Behaviour Spelling](doc_rules/elvis_style/behaviour_spelling.md)
-- [Consistent Generic Type](doc_rules/elvis_style/consistent_generic_type.md)
-- [Consistent Variable Casing](doc_rules/elvis_style/consistent_variable_casing.md)
 - [Don't Repeat Yourself](doc_rules/elvis_style/dont_repeat_yourself.md)
 - [Export Used Types](doc_rules/elvis_style/export_used_types.md)
 - [Function Naming Convention](doc_rules/elvis_style/function_naming_convention.md)
-- [God Modules](doc_rules/elvis_style/god_modules.md)
+- [Generic Type](doc_rules/elvis_style/generic_type.md)
 - [Include `ms_transform` for `ets:fun2ms/1`](doc_rules/elvis_style/ms_transform_included.md)
-- [Invalid Dynamic Calls](doc_rules/elvis_style/invalid_dynamic_call.md)
 - [Line Length](doc_rules/elvis_text_style/line_length.md)
 - [Macro Module Names - *deprecated*](doc_rules/elvis_style/macro_module_names.md)
-- [Macro Names](doc_rules/elvis_style/macro_names.md)
+- [Macro Naming Convention](doc_rules/elvis_style/macro_naming_convention.md)
 - [Max Anonymous Function Arity](doc_rules/elvis_style/max_anonymous_function_arity.md)
 - [Max Function Arity](doc_rules/elvis_style/max_function_arity.md)
 - [Max Function Clause Length](doc_rules/elvis_style/max_function_clause_length.md)
 - [Max Function Length](doc_rules/elvis_style/max_function_length.md)
 - [Max Module Length](doc_rules/elvis_style/max_module_length.md)
 - [Module Naming Convention](doc_rules/elvis_style/module_naming_convention.md)
-- [Nesting Level](doc_rules/elvis_style/nesting_level.md)
 <!-- markdownlint-disable MD033 -->
 - [No <code>$&nbsp;</code>](doc_rules/elvis_style/no_dollar_space.md)
 <!-- markdownlint-enable MD033 -->
@@ -49,11 +45,15 @@ Most, if not all, of the rules will present (opinionated) documentation sections
 - [No Catch Expressions](doc_rules/elvis_style/no_catch_expressions.md)
 - [No Common Caveats](doc_rules/elvis_style/no_common_caveats_call.md)
 - [No Debug Call](doc_rules/elvis_style/no_debug_call.md)
+- [No Deep Nesting](doc_rules/elvis_style/no_deep_nesting.md)
+- [No God Modules](doc_rules/elvis_style/no_god_modules.md)
 - [No If Expression](doc_rules/elvis_style/no_if_expression.md)
 - [No Import](doc_rules/elvis_style/no_import.md)
+- [No Invalid Dynamic Calls](doc_rules/elvis_style/no_invalid_dynamic_calls.md)
 - [No Init Lists](doc_rules/elvis_style/no_init_lists.md)
 - [No Macros](doc_rules/elvis_style/no_macros.md)
 - [No Match In Condition](doc_rules/elvis_style/no_match_in_condition.md)
+- [No Nested Header Files](doc_rules/elvis_style/no_nested_hrls.md)
 - [No Nested `try...catch` Blocks](doc_rules/elvis_style/no_nested_try_catch.md)
 - [No Operator With Same Values](doc_rules/elvis_style/no_operation_on_same_value.md)
 - [No Redundant Blank Lines](doc_rules/elvis_text_style/no_redundant_blank_lines.md)
@@ -69,14 +69,14 @@ Most, if not all, of the rules will present (opinionated) documentation sections
 - [No Throw](doc_rules/elvis_style/no_throw.md)
 - [No Trailing Whitespace](doc_rules/elvis_text_style/no_trailing_whitespace.md)
 - [No Types](doc_rules/elvis_style/no_types.md)
-- [No Nested Header Files](doc_rules/elvis_style/no_nested_hrls.md)
+- [No Used Ignored Variables](doc_rules/elvis_style/no_used_ignored_variables.md)
 - [Numeric Format](doc_rules/elvis_style/numeric_format.md)
 - [Operator Spaces](doc_rules/elvis_style/operator_spaces.md)
 - [Param Pattern-Matching](doc_rules/elvis_style/param_pattern_matching.md)
 - [Prefer Unquoted Atoms](doc_rules/elvis_text_style/prefer_unquoted_atoms.md)
 - [Private Data Types](doc_rules/elvis_style/private_data_types.md)
 - [State Record And Type](doc_rules/elvis_style/state_record_and_type.md)
-- [Used Ignored Variable](doc_rules/elvis_style/used_ignored_variable.md)
+- [Variable Casing](doc_rules/elvis_style/variable_casing.md)
 - [Variable Naming Convention](doc_rules/elvis_style/variable_naming_convention.md)
 
 ## `.gitignore` rules
@@ -89,7 +89,7 @@ Most, if not all, of the rules will present (opinionated) documentation sections
 - [No Deps `master` `erlang.mk` - *deprecated*](doc_rules/elvis_project/no_deps_master_erlang_mk.md)
 - [No Deps `master` `rebar.config` - *deprecated*](doc_rules/elvis_project/no_deps_master_rebar.md)
 - [No Deps With Branches](doc_rules/elvis_project/no_branch_deps.md)
-- [Old Configuration Format](doc_rules/elvis_project/old_configuration_format.md)
+- [Old Configuration Format - *deprecated*](doc_rules/elvis_project/old_configuration_format.md)
 - [Protocol For Deps `erlang.mk` - *deprecated*](doc_rules/elvis_project/protocol_for_deps_erlang_mk.md)
 - [Protocol For Deps `rebar.config` - *deprecated*](doc_rules/elvis_project/protocol_for_deps_rebar.md)
 - [Protocol For Deps](doc_rules/elvis_project/protocol_for_deps.md)
@@ -102,17 +102,16 @@ rulesets in the configuration file.
 
 The six pre-defined rulesets are:
 
-- `elvis_config`, for elvis configuration files.
-- `erl_files`, for Erlang source files (pre-defined rule set).
+- `erl_files`, for Erlang source files (pre-defined ruleset).
 - `erl_files_strict`, for Erlang source files (all applicable rules).
 - `gitignore`, for `.gitignore` files.
-- `hrl_files`, for Erlang header files (pre-defined rule set).
+- `hrl_files`, for Erlang header files (pre-defined ruleset).
 - `hrl_files_strict`, for Erlang header files (all applicable rules).
 - `rebar_config`, for rebar configuration files.
 
-Custom rulesets are defined in a `{<ruleset>, #{}}` tuple in `elvis`' configuration. Each key in the
-map represents the ruleset name and is mapped to a list of rules as otherwise defined in a standard
-ruleset.
+Custom rulesets are defined in a `{RuleNamespace, #{}}` tuple in `elvis`' configuration. Each key in
+the map represents the ruleset name and is mapped to a list of rules as otherwise defined in a
+standard ruleset.
 
 Example configuration with a custom ruleset (named `my_ruleset`):
 
@@ -156,7 +155,7 @@ You can always play with the following, but results may not be surprising.
 
 ```erlang
 -module(mymodule).
--elvis([{elvis_style, nesting_level, #{ level => 4, ignore => [mymodule] }}]).
+-elvis([{elvis_style, no_deep_nesting, #{ level => 4, ignore => [mymodule] }}]).
 ...
 ```
 
@@ -174,7 +173,7 @@ your choice.
 It suffices to add the `ignore` list to your rules, as per the example below.
 
 ```erlang
--elvis([{elvis_style, invalid_dynamic_call, #{ ignore => [elvis_core]}}]).
+-elvis([{elvis_style, no_invalid_dynamic_calls, #{ ignore => [elvis_core]}}]).
 -elvis([{elvis_style, no_debug_call, #{ ignore => [elvis_result, elvis_utils]}}]).
 ```
 
@@ -227,10 +226,6 @@ for `.hrl` files.
          , filter => "rebar.config"
          , ruleset => rebar_config
          , rules => [] }
-      , #{ dirs => ["."]
-         , filter => "elvis.config"
-         , ruleset => elvis_config
-         , rules => [] }
       , #{ dirs => ["."]
          , filter => ".gitignore"
          , ruleset => gitignore }

diff --git a/config/elvis-test.config b/config/elvis-test.config
@@ -8,15 +8,15 @@
                     [
                         {elvis_text_style, line_length, #{limit => 80, skip_comments => false}},
                         {elvis_text_style, no_tabs},
-                        {elvis_style, macro_names},
+                        {elvis_style, macro_naming_convention},
                         {elvis_style, operator_spaces, #{
                             rules => [{right, ","}, {right, "++"}, {left, "++"}]
                         }},
-                        {elvis_style, nesting_level, #{level => 3}},
-                        {elvis_style, god_modules, #{limit => 25}},
+                        {elvis_style, no_deep_nesting, #{level => 3}},
+                        {elvis_style, no_god_modules, #{limit => 25}},
                         {elvis_style, no_if_expression},
-                        {elvis_style, invalid_dynamic_call, #{ignore => [elvis]}},
-                        {elvis_style, used_ignored_variable},
+                        {elvis_style, no_invalid_dynamic_calls, #{ignore => [elvis]}},
+                        {elvis_style, no_used_ignored_variables},
                         {elvis_style, no_behavior_info},
                         {elvis_style, module_naming_convention, #{
                             regex => "^([a-z][a-z0-9]*_?)*(_SUITE)?$", ignore => []
@@ -33,15 +33,15 @@
                     [
                         {elvis_text_style, line_length, #{limit => 80, skip_comments => false}},
                         {elvis_text_style, no_tabs},
-                        {elvis_style, macro_names},
+                        {elvis_style, macro_naming_convention},
                         {elvis_style, operator_spaces, #{
                             rules => [{right, ","}, {right, "++"}, {left, "++"}]
                         }},
-                        {elvis_style, nesting_level, #{level => 3}},
-                        {elvis_style, god_modules, #{limit => 25}},
+                        {elvis_style, no_deep_nesting, #{level => 3}},
+                        {elvis_style, no_god_modules, #{limit => 25}},
                         {elvis_style, no_if_expression},
-                        {elvis_style, invalid_dynamic_call, #{ignore => [elvis]}},
-                        {elvis_style, used_ignored_variable},
+                        {elvis_style, no_invalid_dynamic_calls, #{ignore => [elvis]}},
+                        {elvis_style, no_used_ignored_variables},
                         {elvis_style, no_behavior_info},
                         {elvis_style, module_naming_convention, #{
                             regex => "^([a-z][a-z0-9]*_?)*(_SUITE)?$", ignore => []
@@ -60,11 +60,6 @@
                         {elvis_project, protocol_for_deps, #{ignore => []}}
                     ],
                 ruleset => rebar_config
-            },
-            #{
-                dirs => ["."],
-                filter => "elvis.config",
-                rules => [{elvis_project, old_configuration_format}]
             }
         ]}
     ]}

diff --git a/config/elvis.config b/config/elvis.config
@@ -25,11 +25,6 @@
                 dirs => ["."],
                 filter => "rebar.config",
                 ruleset => rebar_config
-            },
-            #{
-                dirs => ["."],
-                filter => "elvis.config",
-                ruleset => elvis_config
             }
         ]}
     ]}

diff --git a/config/old/elvis-test-rule-config-list.config b/config/old/elvis-test-rule-config-list.config
diff --git a/config/old/elvis-test.config b/config/old/elvis-test.config
diff --git a/config/old/elvis.config b/config/old/elvis.config
diff --git a/config/test.config b/config/test.config
@@ -7,8 +7,8 @@
                 rules =>
                     [
                         {elvis_text_style, line_length, #{limit => 80, skip_comments => false}},
-                        {elvis_style, nesting_level, #{level => 3}},
-                        {elvis_style, invalid_dynamic_call, #{ignore => [elvis]}},
+                        {elvis_style, no_deep_nesting, #{level => 3}},
+                        {elvis_style, no_invalid_dynamic_calls, #{ignore => [elvis]}},
                         {elvis_style, no_macros},
                         {elvis_style, param_pattern_matching, #{side => right}}
                     ],
@@ -26,8 +26,8 @@
                 rules =>
                     [
                         {elvis_text_style, line_length, #{limit => 80, skip_comments => false}},
-                        {elvis_style, nesting_level, #{level => 3}},
-                        {elvis_style, invalid_dynamic_call, #{ignore => [elvis]}},
+                        {elvis_style, no_deep_nesting, #{level => 3}},
+                        {elvis_style, no_invalid_dynamic_calls, #{ignore => [elvis]}},
                         {elvis_style, no_macros}
                     ],
                 ruleset => beam_files
@@ -37,11 +37,6 @@
                 filter => "rebar.config",
                 ruleset => rebar_config
             },
-            #{
-                dirs => ["../../_build/test/lib/elvis_core/test/examples"],
-                filter => "elvis.config",
-                ruleset => elvis_config
-            },
             #{
                 dirs =>
                     [