Module hank_rule

Behavior for defining a rule for Hank.

This module defines the hank_rule behaviour.
Required callback functions: analyze/2.

Description

Behavior for defining a rule for Hank.

Data Types

asts()

asts() = [{file:filename(), erl_syntax:forms()}]

result()

result() = #{file := file:filename(), line := non_neg_integer(), text := iodata(), rule => t()}

t()

t() = module()

Function Index

analyze/3Analyze the given files with the rule.
default_rules/0The list of default rules to apply.

Function Details

analyze/3

analyze(Rule::t(), ASTs::asts(), Context::hank_context:t()) -> [result()]

Analyze the given files with the rule.

default_rules/0

default_rules() -> []

The list of default rules to apply


Generated by EDoc