elvis_config (elvis_core v4.2.0)
View SourceSummary
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'.
Types
-type fail_validation() :: {fail, [{throw, {invalid_config, Message :: string()}}]}.
-type output_format() :: plain | colors | parsable.
-opaque t()
Functions
Takes a function and configuration and applies the function to all file in the configuration.
-spec config() -> [t()] | fail_validation().
-spec default() -> [t()].
-spec files(RuleGroup :: [t()] | t()) -> [elvis_file:t()].
-spec from_file(File :: string()) -> [t()] | fail_validation().
-spec from_rebar(File :: string()) -> [t()] | fail_validation().
-spec merge_rules(UserRules :: list(), DefaultRules :: list()) -> [elvis_rule:t()].
Merge user rules (override) with elvis default rules.
-spec no_output() -> boolean().
-spec output_format() -> output_format().
-spec parallel() -> pos_integer().
Takes a configuration and finds all files according to its 'dirs' end 'filter' key, or if not specified uses '*.erl'.
-spec resolve_files(Config :: [t()] | t(), Files :: [elvis_file:t()]) -> [t()] | t().
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 :: [t()]) -> [[elvis_rule:t()]]; (Rules :: t()) -> [elvis_rule:t()].
-spec set_no_output(boolean()) -> ok.
-spec set_output_format(output_format()) -> ok.
-spec set_parallel(pos_integer()) -> ok.
-spec set_verbose(boolean()) -> ok.
-spec validate_config(term()) -> ok.
-spec verbose() -> boolean().