elvis_result (elvis_core v4.2.0)

View Source

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_path(_)
get_rules(_)
new(_, Msg, Info)
new_item(Format)
new_item(Format, Data)
new_item(Format, Data, Attrs)
print_results(Results)
status(Files)

Types

elvis_error/0

-opaque elvis_error()

elvis_warn/0

-opaque elvis_warn()

file/0

-opaque file()

item/0

-opaque item()

rule/0

-opaque rule()

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_path(_)

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

get_rules(_)

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

new(_, Msg, Info)

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

new_item(Format)

-spec new_item(Format :: string()) -> item().

new_item(Format, Data)

-spec new_item(Format :: string(), Data :: [term()]) -> item().

new_item(Format, Data, Attrs)

-spec new_item(Format :: string(), Data :: [term()], Attrs) -> item()
                  when
                      Attrs ::
                          #{node => ktn_code:tree_node(),
                            zipper => zipper:zipper(ktn_code:tree_node()),
                            line => -1 | non_neg_integer(),
                            column => -1 | non_neg_integer(),
                            limit => -1 | non_neg_integer()}.

status(Files)

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