elvis_config (elvis_core v2.0.0)
Link to this section Summary
Functions
Takes a function and configuration and applies the function to all file in the configuration.
Merge user rules (override) with elvis default rules.
Takes a configuration and finds all files according to its 'dirs' end 'filter' key, or if not specified uses '*.erl'.
Takes a configuration and a list of files, filtering some of them according to the 'filter' key, or if not specified uses '*.erl'.
Link to this section Types
Link to this type
config/0
-type config() :: map().
Link to this type
configs/0
-type configs() :: [config()].
Link to this section Functions
Link to this function
apply_to_files(Fun, Config)
Link to this function
dirs(Config)
Link to this function
files(RuleGroup)
-spec files(RuleGroup :: configs() | config()) -> [elvis_file:file()].
Link to this function
filter(Config)
Link to this function
from_application_or_config(Key, Default)
-spec from_application_or_config(atom(), term()) -> term().
Link to this function
from_file(Path)
-spec from_file(string()) -> configs().
Link to this function
from_rebar(Path)
-spec from_rebar(string()) -> configs().
Link to this function
ignore(Config)
Link to this function
merge_rules(UserRules, DefaultRules)
-spec merge_rules(UserRules :: list(), DefaultRules :: list()) -> [elvis_core:rule()].
Link to this function
normalize(Config)
Link to this function
resolve_files(RuleGroup)
Link to this function
resolve_files(Config, Files)
-spec resolve_files(Config :: configs() | config(), Files :: [elvis_file:file()]) -> configs() | config().
Link to this function
rules(RulesL)
-spec rules(RulesL :: configs()) -> [[elvis_core:rule()]]; (Rules :: config()) -> [elvis_core:rule()].
Link to this function
validate(Config)
-spec validate(Config :: configs()) -> ok.