This module defines the hank_rule behaviour.
Required callback functions: analyze/2, ignored/2.
asts() = [{file:filename(), erl_syntax:forms()}]
ignore_pattern() = undefined | tuple()
ignore_spec() = {file:filename(), t() | all} | {file:filename(), t(), term()}
result() = #{file := file:filename(), line := non_neg_integer(), text := iodata(), rule => t(), pattern => ignore_pattern()}
t() = module()
analyze/3 | Analyze the given files with the rule. |
default_rules/0 | The list of default rules to apply. |
is_ignored/3 | Check if given rule should be ignored from results. |
analyze(Rule::t(), ASTs::asts(), Context::hank_context:t()) -> [result()]
Analyze the given files with the rule.
default_rules() -> []
The list of default rules to apply
is_ignored(Rule::t(), Pattern::ignore_pattern(), IgnoreSpec::all | term()) -> boolean()
Check if given rule should be ignored from results
Generated by EDoc