KogenCredo.Diff.Rule behaviour (KogenCredo v0.1.0)

View Source

A diff rule judges one changed function against its base version.

check/2 receives a KogenCredo.Diff.Change and the rule options (a keyword list shared by all rules) and returns findings built with KogenCredo.Diff.Finding.for_change/3. The severity of a finding is assigned by KogenCredo.Diff.check/3 from default_severity/0 and the :severity option, so a rule never decides by itself that a hit blocks a build.

Summary

Callbacks

check(t, keyword)
default_severity()
id()

Callbacks

check(t, keyword)

@callback check(
  KogenCredo.Diff.Change.t(),
  keyword()
) :: [KogenCredo.Diff.Finding.t()]

default_severity()

@callback default_severity() :: KogenCredo.Diff.Finding.severity()

id()

@callback id() :: String.t()