Module elvis_config

Data Types

config()

config() = map()

configs()

configs() = [config()]

Function Index

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

Function Details

apply_to_files/2

apply_to_files(Fun::function(), Config::configs() | config()) -> configs() | config()

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

dirs/1

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

files/1

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

filter/1

filter(Config::configs() | config()) -> [string()]

from_application_or_config/2

from_application_or_config(Key::atom(), Default::term()) -> term()

from_file/1

from_file(Path::string()) -> configs()

from_rebar/1

from_rebar(Path::string()) -> configs()

ignore/1

ignore(Config::configs() | config()) -> [string()]

merge_rules/2

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

Merge user rules (override) with elvis default rules.

normalize/1

normalize(Config::configs()) -> configs()

resolve_files/1

resolve_files(RuleGroup::config()) -> config()

Takes a configuration and finds all files according to its 'dirs' end 'filter' key, or if not specified uses '*.erl'.

resolve_files/2

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

rules/1

rules(RulesL::configs()) -> [[elvis_core:rule()]]

rules(Rules::config()) -> [elvis_core:rule()]

validate/1

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


Generated by EDoc