elvis_config (elvis_core v5.0.3)

View Source

Summary

Types

output_format/0
t/0

Functions

apply_to_files(Fun, Config)

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

config()
default()
files(RuleGroup)
from_file(File)
from_rebar(File)
merge_rules(UserRules, DefaultRules)

Merge user rules (override) with elvis default rules.

no_output()
output_format()
parallel()
resolve_files(RuleGroup)

Takes a configuration and finds all files according to its 'files' globs.

resolve_files(Config, Files)

Takes a configuration and a list of files, filtering some of them according to the 'files' globs and ignore list.

rules(RulesL)
ruleset(ElvisConfig)
set_no_output(NoOutput)
set_output_format(OutputFormat)
set_parallel(Parallel)
set_verbose(Verbose)
set_warnings_as_errors(WarningsAsErrors)
validate(ElvisConfig, File)
verbose()
warnings_as_errors()

Types

output_format/0

-type output_format() :: plain | colors | parsable.

t/0

-opaque t()

Functions

apply_to_files(Fun, Config)

-spec apply_to_files(Fun :: fun(), Config :: [t()] | t()) -> [t()] | t().

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

config()

-spec config() -> [t()] | {error, Message :: string()}.

default()

-spec default() -> [t()].

files(RuleGroup)

-spec files(RuleGroup :: [t()] | t()) -> [elvis_file:t()].

from_file(File)

-spec from_file(File :: string()) -> [t()] | {error, Message :: string()}.

from_rebar(File)

-spec from_rebar(File :: string()) -> [t()] | {error, Message :: string()}.

merge_rules(UserRules, DefaultRules)

-spec merge_rules(UserRules :: list(), DefaultRules :: list()) -> [elvis_rule:t()].

Merge user rules (override) with elvis default rules.

no_output()

-spec no_output() -> boolean() | {error, Message :: string()}.

output_format()

-spec output_format() -> output_format() | {error, Message :: string()}.

parallel()

-spec parallel() -> pos_integer() | {error, Message :: string()}.

resolve_files(RuleGroup)

-spec resolve_files(t()) -> t().

Takes a configuration and finds all files according to its 'files' globs.

resolve_files(Config, Files)

-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 'files' globs and ignore list.

rules(RulesL)

-spec rules(RulesL :: [t()]) -> [[elvis_rule:t()]];
           (Rules :: t()) -> [elvis_rule:t()].

ruleset(ElvisConfig)

-spec ruleset(t()) -> Ruleset :: atom() | undefined.

set_no_output(NoOutput)

-spec set_no_output(boolean()) -> ok.

set_output_format(OutputFormat)

-spec set_output_format(output_format()) -> ok.

set_parallel(Parallel)

-spec set_parallel(pos_integer()) -> ok.

set_verbose(Verbose)

-spec set_verbose(boolean()) -> ok.

set_warnings_as_errors(WarningsAsErrors)

-spec set_warnings_as_errors(boolean()) -> ok.

validate(ElvisConfig, File)

-spec validate(term(), undefined | string()) -> ok | {error, Message :: string()}.

verbose()

-spec verbose() -> boolean() | {error, Message :: string()}.

warnings_as_errors()

-spec warnings_as_errors() -> boolean() | {error, Message :: string()}.