Module elvis_result

Data Types

elvis_error()

elvis_error() = #{error_msg => string(), info => list()}

file()

file() = #{file => elvis_file:file(), rules => [rule()]}

item()

item() = #{message => string(), info => iodata(), line_num => integer()}

rule()

rule() = #{name => atom(), items => [item()]}

Function Index

clean/1Removes files that don't have any failures.
get_file/1
get_info/1
get_items/1
get_line_num/1
get_message/1
get_name/1
get_rules/1
new/3
new/4
print/1
status/1

Function Details

clean/1

clean(Files::[file() | rule()]) -> [file() | rule()]

Removes files that don't have any failures.

get_file/1

get_file(X1::file()) -> elvis_file:file()

get_info/1

get_info(X1::item()) -> string()

get_items/1

get_items(X1::rule()) -> [item()]

get_line_num/1

get_line_num(X1::item()) -> integer()

get_message/1

get_message(X1::item()) -> string()

get_name/1

get_name(X1::rule()) -> atom()

get_rules/1

get_rules(X1::file()) -> [rule()]

new/3

new(X1::item, Msg::string(), Info::[term()]) -> item()

new/4

new(X1::item, Msg::string(), Info::[term()], LineNum::integer()) -> item()

print/1

print(Results::item() | rule() | elvis_error() | [file()]) -> ok

status/1

status(Files::[file() | rule()]) -> ok | fail


Generated by EDoc