rebar3_hank v1.4.1

View Source hank (rebar3_hank v1.4.1)

The Erlang Dead Code Cleaner

Link to this section Summary

Types

ms/0
parsing_style/0
stats/0

Functions

analyze(Files, IgnoreSpecsFromState, Rules, ParsingStyle, Context)
Runs a list of rules over a list of files and returns all the dead code pieces it can find.
get_ast(File)

Link to this section Types

Link to this type

ms/0

View Source 
-type ms() :: non_neg_integer().
Link to this type

parsing_style/0

View Source 
-type parsing_style() :: parallel | sequential.
Link to this type

stats/0

View Source 
-type stats() :: #{ignored := non_neg_integer(), parsing := ms(), analyzing => ms(), total => ms()}.

Link to this section Functions

Link to this function

analyze(Files, IgnoreSpecsFromState, Rules, ParsingStyle, Context)

View Source 
-spec analyze([file:filename()],
        [hank_rule:ignore_spec()],
        [hank_rule:t()],
        parsing_style(),
        hank_context:t()) ->
           #{results := [hank_rule:result()],
             unused_ignores := [hank_rule:ignore_spec()],
             stats := stats()}.
Runs a list of rules over a list of files and returns all the dead code pieces it can find.
Link to this function

get_ast(File)

View Source 
-spec get_ast(file:filename()) -> erl_syntax:forms().