View Source elvis_config (elvis_core v3.2.2)

Summary

Types

config/0
configs/0

Functions

apply_to_files(Fun, Config)
Takes a function and configuration and applies the function to all file in the configuration.
dirs(Config)
files(RuleGroup)
filter(Config)
from_application_or_config(Key, Default)
from_file(Path)
from_rebar(Path)
ignore(Config)
merge_rules(UserRules, DefaultRules)
Merge user rules (override) with elvis default rules.
normalize(Config)
resolve_files(RuleGroup)
Takes a configuration and finds all files according to its 'dirs' end 'filter' key, or if not specified uses '*.erl'.
resolve_files(Config, Files)
Takes a configuration and a list of files, filtering some of them according to the 'filter' key, or if not specified uses '*.erl'.
rules(RulesL)
validate(Config)

Types

Link to this type

config/0

View Source 
-type config() :: map().
Link to this type

configs/0

View Source 
-type configs() :: [config()].

Functions

Link to this function

apply_to_files(Fun, Config)

View Source 
-spec apply_to_files(Fun :: fun(), Config :: configs() | config()) -> configs() | config().
Takes a function and configuration and applies the function to all file in the configuration.
Link to this function

dirs(Config)

View Source 
-spec dirs(Config :: configs() | config()) -> [string()].
Link to this function

files(RuleGroup)

View Source 
-spec files(RuleGroup :: configs() | config()) -> [elvis_file:file()].
Link to this function

filter(Config)

View Source 
-spec filter(configs() | config()) -> [string()].
Link to this function

from_application_or_config(Key, Default)

View Source 
-spec from_application_or_config(atom(), term()) -> term().
Link to this function

from_file(Path)

View Source 
-spec from_file(string()) -> configs().
Link to this function

from_rebar(Path)

View Source 
-spec from_rebar(string()) -> configs().
Link to this function

ignore(Config)

View Source 
-spec ignore(configs() | config()) -> [string()].
Link to this function

merge_rules(UserRules, DefaultRules)

View Source 
-spec merge_rules(UserRules :: list(), DefaultRules :: list()) -> [elvis_core:rule()].
Merge user rules (override) with elvis default rules.
Link to this function

normalize(Config)

View Source 
-spec normalize(configs()) -> configs().
Link to this function

resolve_files(RuleGroup)

View Source 
-spec resolve_files(config()) -> config().
Takes a configuration and finds all files according to its 'dirs' end 'filter' key, or if not specified uses '*.erl'.
Link to this function

resolve_files(Config, Files)

View Source 
-spec resolve_files(Config :: configs() | config(), Files :: [elvis_file:file()]) ->
                 configs() | config().
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 function

rules(RulesL)

View Source 
-spec rules(RulesL :: configs()) -> [[elvis_core:rule()]];
     (Rules :: config()) -> [elvis_core:rule()].
Link to this function

validate(Config)

View Source 
-spec validate(Config :: configs()) -> ok.