Module elvis_config

Data Types
Function Index
Function Details

Data Types

config()

config() = [map()]

Function Index

apply_to_files/2	Takes a function and configuration and applies the function to all file in the configuration.
dirs/1
files/1
filter/1
from_file/1
from_rebar/1
ignore/1
merge_rules/2	Merge user rules (override) with elvis default rules.
normalize/1
resolve_files/1	Takes a configuration and finds all files according to its 'dirs' end 'filter' key, or if not specified uses '*.erl'.
resolve_files/2	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
validate/1

Function Details

apply_to_files/2

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

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

dirs/1

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

files/1

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

filter/1

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

from_file/1

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

from_rebar/1

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

ignore/1

ignore(Config::config() | map()) -> [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::config()) -> config()

resolve_files/1

resolve_files(RuleGroup::map()) -> map()

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::config() | map(), Files::[elvis_file:file()]) -> config() | map()

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(Rules::config() | map()) -> [elvis_core:rule()]

validate/1

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

Generated by EDoc