Module elvis_config

Data Types

config()

config() = [map()]

Function Index

apply_to_files/2Takes a function and configuration and applies the function to all file in the configuration.
default/0
dirs/1
files/1
filter/1
ignore/1
include_dirs/1
load/1
load_file/1
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::config() | map()) -> config() | map()

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

default/0

default() -> config()

dirs/1

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

files/1

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

filter/1

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

ignore/1

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

include_dirs/1

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

load/1

load(AppConfig::term()) -> config()

load_file/1

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

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()) -> [string()] | undefined

validate/1

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


Generated by EDoc