Deeper configuration parsing and validation

.gitignore

@@ -3,7 +3,6 @@ _build/
 doc/
 /rebar3.crashdump
 .rebar3/
-logs
 test/**/*.beam
 test/logs/
 _checkouts/

README.md

@@ -37,37 +37,42 @@ Once this is done you can apply the style rules in the following ways.
 #### Loading configuration from a file
 
 ```shell
-1> ElvisConfig = elvis_config:from_file("elvis.config").
+1> ElvisConfig = elvis_config:config().
 <loaded_config>
-2> elvis_core:rock(ElvisConfig).
+2> application:set_env(elvis_core, verbose, true), elvis_core:rock(ElvisConfig).
+Loading src/elvis_code.erl
+# src/elvis_code.erl [OK]
+Loading src/elvis_config.erl
+# src/elvis_config.erl [OK]
+Loading src/elvis_core.erl
 # src/elvis_core.erl [OK]
-# src/elvis_result.erl [OK]
-# src/elvis_style.erl [OK]
-# src/elvis_utils.erl [OK]
+Loading src/elvis_file.erl
+# src/elvis_file.erl [OK]
+...
 ok
 3>
 ```
 
 This will load the [configuration](#configuration), specified in file `elvis.config`, from the
-current directory. If no configuration is found `{invalid_config, _}` is thrown.
+current directory.
+
+If `elvis.config` is not present, the application will fall back to searching for configuration
+parameters in `rebar.config`. If `rebar.config` is also unavailable, the application proceeds to
+perform a tertiary lookup within its application environment (which can also be set via the
+`app/sys.config` file, or e.g., via `application:set_env(elvis_core, Key, Value).` for the required
+settings.
 
 #### Providing configuration as a value
 
 Another option for using `elvis_core` from the shell is to explicitly provide the configuration as
 an argument to `elvis_core:rock/1`:
 
 ```shell
-1> ElvisConfig = [#{dirs => ["src"], filter => "*.erl", rules => []}].
+1> ElvisConfig = [#{dirs => ["src"], filter => "elvis_rule.erl", ruleset => erl_files}].
 [#{dirs => ["src"],filter => "*.erl",rules => []}]
-2> elvis_core:rock(ElvisConfig).
-Loading src/elvis_core.erl
-# src/elvis_core.erl [OK]
-Loading src/elvis_result.erl
-# src/elvis_result.erl [OK]
-Loading src/elvis_style.erl
-# src/elvis_style.erl [OK]
-Loading src/elvis_utils.erl
-# src/elvis_utils.erl [OK]
+2> application:set_env(elvis_core, verbose, true), elvis_core:rock(ElvisConfig).
+Loading src/elvis_rule.erl
+# src/elvis_rule.erl [OK]
 ok
 3>
 ```
@@ -118,6 +123,32 @@ An `elvis.config` file looks something like this:
 ]}].
 ```
 
+To look at what is considered the "current default" configuration, do:
+
+```console
+rebar3 shell
+...
+1> elvis_config:default().
+[#{filter => "*.erl",
+   dirs => ["apps/**/src/**","src/**"],
+   ruleset => erl_files},
+ #{filter => "*.erl",
+   dirs =>
+       ["apps/**/src/**","src/**","apps/**/include/**",
+        "include/**"],
+   ruleset => hrl_files},
+ #{filter => "rebar.config",
+   dirs => ["."],
+   ruleset => rebar_config},
+ #{filter => ".gitignore",
+   dirs => ["."],
+   ruleset => gitignore}]
+2>
+```
+
+**Note**: this element might change with time. The above was what was generated when this
+documentation was updated.
+
 ### Files, rules and rulesets
 
 The `dirs` key is a list that tells `elvis_core` where it should look for the files that match
@@ -238,7 +269,7 @@ found in this repository's [RULES.md](https://github.com/inaka/elvis_core/blob/m
 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
+1. `t:elvis_config:t()`: the value of each element in list `config` as found in the
 [configuration](#configuration),
 
 This means you can define rules of your own (user-defined rules) as long as the functions that

RULES.md

@@ -222,10 +222,6 @@ for `.hrl` files.
          , filter => "*.hrl"
          , ruleset => hrl_files
          }
-      , #{ dirs => ["."]
-         , filter => "Makefile"
-         , ruleset => makefiles
-         , rules => [] }
       , #{ dirs => ["."]
          , filter => "rebar.config"
          , ruleset => rebar_config

config/elvis-test-custom-ruleset.config

@@ -3,7 +3,7 @@
         {rulesets, #{project => [{elvis_text_style, no_tabs}]}},
         {config, [
             #{
-                dirs => ["."],
+                dirs => ["../../../../_build/test/lib/elvis_core/test/dirs/src"],
                 filter => "*.erl",
                 ruleset => project
             }

config/elvis-test-hrl-files.config

@@ -2,7 +2,7 @@
     {elvis, [
         {config, [
             #{
-                dirs => ["../../_build/test/lib/elvis_core/test/examples/"],
+                dirs => ["../../../../_build/test/lib/elvis_core/test/examples/"],
                 filter => "test_*.hrl",
                 ruleset => hrl_files
             }

config/elvis-test-pa.config

@@ -2,7 +2,7 @@
     {elvis, [
         {config, [
             #{
-                dirs => ["../../test/examples"],
+                dirs => ["../../../../test/examples"],
                 filter => "user_defined_rules.erl",
                 rules => [{user_defined_rules, rule}]
             }

config/elvis-test.config

@@ -2,7 +2,7 @@
     {elvis, [
         {config, [
             #{
-                dirs => ["../../src"],
+                dirs => ["../../../../src"],
                 filter => "*.erl",
                 rules =>
                     [
@@ -27,7 +27,7 @@
                 ruleset => erl_files
             },
             #{
-                dirs => ["../../_build/test/lib/elvis_core/ebin"],
+                dirs => ["../../../../_build/test/lib/elvis_core/ebin"],
                 filter => "*.beam",
                 rules =>
                     [

config/elvis-umbrella.config

@@ -4,10 +4,10 @@
             #{
                 dirs =>
                     [
-                        "../../_build/test/lib/elvis_core/test/dirs/src/**",
-                        "../../_build/test/lib/elvis_core/test/dirs/test/**",
-                        "../../_build/test/lib/elvis_core/test/dirs/apps/**/src",
-                        "../../_build/test/lib/elvis_core/test/dirs/apps/**/test"
+                        "../../../../_build/test/lib/elvis_core/test/dirs/src",
+                        "../../../../_build/test/lib/elvis_core/test/dirs/test",
+                        "../../../../_build/test/lib/elvis_core/test/dirs/apps/**/src",
+                        "../../../../_build/test/lib/elvis_core/test/dirs/apps/**/test"
                     ],
                 filter => "*.erl",
                 ruleset => erl_files

config/elvis.config

@@ -2,27 +2,27 @@
     {elvis, [
         {config, [
             #{
-                dirs => ["../../_build/test/lib/elvis_core/test/examples"],
+                dirs => ["../../../../_build/test/lib/elvis_core/test/examples"],
                 filter => "*.erl",
                 ruleset => erl_files
             },
             #{
-                dirs => ["../../_build/test/lib/elvis_core/test/examples"],
+                dirs => ["../../../../_build/test/lib/elvis_core/test/examples"],
                 filter => "*.hrl",
                 ruleset => hrl_files
             },
             #{
-                dirs => ["../../_build/test/lib/elvis_core/test/non_compilable_examples"],
+                dirs => ["../../../../_build/test/lib/elvis_core/test/non_compilable_examples"],
                 filter => "*.erl",
                 ruleset => erl_files
             },
             #{
-                dirs => ["../../_build/test/lib/elvis_core/test/examples"],
+                dirs => ["../../../../_build/test/lib/elvis_core/test/examples"],
                 filter => "*.beam",
                 ruleset => beam_files
             },
             #{
-                dirs => ["."],
+                dirs => ["../../../.."],
                 filter => "rebar.config",
                 ruleset => rebar_config
             }

config/rebar.config

@@ -8,7 +8,7 @@
 {elvis, [
     {config, [
         #{
-            dirs => ["../../_build/test/lib/elvis_core/test/examples"],
+            dirs => ["../../../../_build/test/lib/elvis_core/test/examples"],
             filter => "*.erl",
             rules => [{elvis_text_style, line_length, #{limit => 135}}]
         }

config/test.config

@@ -2,7 +2,7 @@
     {elvis_core, [
         {config, [
             #{
-                dirs => ["../../_build/test/lib/elvis_core/test/examples"],
+                dirs => ["../../../../_build/test/lib/elvis_core/test/examples"],
                 filter => "*.erl",
                 rules =>
                     [
@@ -15,13 +15,13 @@
                 ruleset => erl_files
             },
             #{
-                dirs => ["../../_build/test/lib/elvis_core/test/examples"],
+                dirs => ["../../../../_build/test/lib/elvis_core/test/examples"],
                 filter => "*.hrl",
                 rules => [],
                 ruleset => hrl_files
             },
             #{
-                dirs => ["../../_build/test/lib/elvis_core/test/examples"],
+                dirs => ["../../../../_build/test/lib/elvis_core/test/examples"],
                 filter => "*.beam",
                 rules =>
                     [
@@ -33,15 +33,15 @@
                 ruleset => beam_files
             },
             #{
-                dirs => ["../../_build/test/lib/elvis_core/test/examples"],
-                filter => "rebar.config",
+                dirs => ["../../../../_build/test/lib/elvis_core/test/examples"],
+                filter => "rebar3.config.success",
                 ruleset => rebar_config
             },
             #{
                 dirs =>
                     [
-                        "../../_build/test/lib/elvis_core/test/dirs/apps/app1",
-                        "../../_build/test/lib/elvis_core/test/dirs/apps/app2"
+                        "../../../../_build/test/lib/elvis_core/test/dirs/apps/app1",
+                        "../../../../_build/test/lib/elvis_core/test/dirs/apps/app2"
                     ],
                 filter => ".gitignore",
                 ruleset => gitignore

config/test.pass.config

@@ -3,7 +3,7 @@
     {elvis, [
         {config, [
             #{
-                dirs => ["../../_build/test/lib/elvis_core/test/examples"],
+                dirs => ["../../../../_build/test/lib/elvis_core/test/examples"],
                 filter => "*.erl",
                 rules => [{elvis_text_style, line_length, #{limit => 800}}]
             }

elvis.config

@@ -7,17 +7,24 @@
                 rules =>
                     [
                         {elvis_style, no_invalid_dynamic_calls, #{
-                            ignore => [{elvis_core, rock_this, 2}]
+                            ignore => [
+                                {elvis_core, rock_this, 2},
+                                {elvis_config, check_rule_for_options, 2}
+                            ]
                         }},
                         {elvis_style, dont_repeat_yourself, #{min_complexity => 20}},
                         {elvis_style, no_debug_call, #{
-                            ignore => [{elvis_result, print_item, 4}, {elvis_utils, print, 2}]
+                            ignore => [
+                                {elvis_result, print_item, 4},
+                                {elvis_utils, do_output, 2},
+                                {elvis_core, main, 1}
+                            ]
                         }},
                         {elvis_style, no_god_modules, #{ignore => [elvis_style]}},
                         {elvis_style, no_throw, disable},
                         {elvis_style, max_function_length, disable},
                         {elvis_style, max_function_clause_length, disable},
-                        {elvis_style, max_module_length, #{ignore => [elvis_style]}},
+                        {elvis_style, max_module_length, #{ignore => [elvis_style, elvis_config]}},
                         {elvis_style, no_common_caveats_call, #{
                             ignore => [
                                 {elvis_file, module, 1},
@@ -34,9 +41,13 @@
                 filter => "*.beam",
                 rules =>
                     [
-                        {elvis_style, no_invalid_dynamic_calls, #{ignore => [elvis_core]}},
+                        {elvis_style, no_invalid_dynamic_calls, #{
+                            ignore => [elvis_core, elvis_config]
+                        }},
                         {elvis_style, dont_repeat_yourself, #{min_complexity => 20}},
-                        {elvis_style, no_debug_call, #{ignore => [elvis_result, elvis_utils]}},
+                        {elvis_style, no_debug_call, #{
+                            ignore => [elvis_result, elvis_utils, elvis_core]
+                        }},
                         {elvis_style, no_god_modules, #{ignore => [elvis_style]}},
                         {elvis_style, no_throw, disable},
                         {elvis_style, no_common_caveats_call, disable}

rebar.config

@@ -16,7 +16,7 @@
         {deps, [{meck, "0.9.2"}]},
         {erl_opts, [nowarn_missing_spec, nowarn_export_all]},
         {dialyzer, [{warnings, [no_return, error_handling]}, {plt_extra_apps, [common_test]}]},
-        {ct_opts, [{sys_config, ["./config/test.config"]}, {logdir, "./logs"}, {verbose, true}]},
+        {ct_opts, [{sys_config, ["./config/test.config"]}, {verbose, true}]},
         {cover_enabled, true},
         {cover_opts, [verbose]}
     ]}
@@ -63,6 +63,8 @@
 
 {dialyzer, [{warnings, [no_return, unmatched_returns, error_handling, unknown]}]}.
 
-{xref_checks, [undefined_function_calls, deprecated_function_calls, deprecated_functions]}.
+{xref_checks, [
+    undefined_function_calls, deprecated_function_calls, deprecated_functions, exports_not_used
+]}.
 
 {xref_extra_paths, ["test/**"]}.

src/elvis_code.erl

@@ -12,6 +12,9 @@
     print_node/2
 ]).
 
+% These are local debug functions.
+-ignore_xref([print_node/1, print_node/2]).
+
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 %%% Public API
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -186,6 +189,6 @@ print_node(#{type := Type} = Node, CurrentLevel) ->
     Indentation = lists:duplicate(CurrentLevel * 4, $\s),
     Content = ktn_code:content(Node),
 
-    ok = elvis_utils:info("~s - [~p] ~p~n", [Indentation, CurrentLevel, Type]),
+    ok = elvis_utils:info("~s - [~p] ~p", [Indentation, CurrentLevel, Type]),
     _ = lists:map(fun(Child) -> print_node(Child, CurrentLevel + 1) end, Content),
     ok.