View Source elvis_config (elvis_core v3.2.5)

Summary

config/0

configs/0

Takes a function and configuration and applies the function to all file in the configuration.

dirs(Config)

files(RuleGroup)

filter(Config)

from_file(Path)

from_rebar(Path)

ignore(Config)

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'.

rules(RulesL)

validate(Config)

-type config() :: map().

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

-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.

-spec dirs(Config :: configs() | config()) -> [string()].

-spec files(RuleGroup :: configs() | config()) -> [elvis_file:file()].

-spec filter(configs() | config()) -> [string()].

-spec from_application_or_config(atom(), term()) -> term().

-spec from_file(string()) -> configs().

-spec from_rebar(string()) -> configs().

-spec ignore(configs() | config()) -> [string()].

-spec merge_rules(UserRules :: list(), DefaultRules :: list()) -> [elvis_core:rule()].

Merge user rules (override) with elvis default rules.

-spec normalize(configs()) -> configs().

-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'.

-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'.

-spec rules(RulesL :: configs()) -> [[elvis_core:rule()]];
           (Rules :: config()) -> [elvis_core:rule()].

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