View Source elvis_result (elvis_core v3.2.5)

Summary

Types

elvis_error/0

elvis_warn/0

file/0

item/0

rule/0

Functions

clean(Files)

Removes files that don't have any failures.

get_info(_)

get_items(_)

get_line_num(_)

get_message(_)

get_name(_)

get_path(_)

get_rules(_)

new(_, Msg, Info)

new(_, Msg, Info, LineNum)

print_results(Results)

status(Files)

Types

elvis_error/0

-type elvis_error() :: #{error_msg => string(), info => list()}.

elvis_warn/0

-type elvis_warn() :: #{warn_msg => string(), info => list()}.

file/0

-type file() :: #{file => string(), rules => [rule()]}.

item/0

-type item() :: #{message => string(), info => iodata(), line_num => integer()}.

rule/0

-type rule() :: #{scope => atom(), name => atom(), items => [item()]}.

Functions

clean(Files)

-spec clean([file() | rule()]) -> [file() | rule()].

Removes files that don't have any failures.

get_info(_)

-spec get_info(item()) -> string().

get_items(_)

-spec get_items(rule()) -> [item()].

get_line_num(_)

-spec get_line_num(item()) -> integer().

get_message(_)

-spec get_message(item()) -> string().

get_name(_)

-spec get_name(rule()) -> atom().

get_path(_)

-spec get_path(file()) -> string().

get_rules(_)

-spec get_rules(file()) -> [rule()].

new(_, Msg, Info)

-spec new(item, string(), [term()]) -> item();
         (rule, {atom(), atom()}, [item()]) -> rule();
         (file, elvis_file:file(), [elvis_error() | rule()]) -> file();
         (error, string(), string()) -> elvis_error();
         (warn, string(), string()) -> elvis_warn().

new(_, Msg, Info, LineNum)

-spec new(item, string(), [term()], integer()) -> item().

print_results(Results)

-spec print_results(file() | [elvis_warn()]) -> ok.

status(Files)

-spec status([file() | rule()]) -> ok | fail.