GitHoox.Doctor (GitHoox v0.3.0)

Copy Markdown View Source

Diagnostic checks for a git_hoox installation.

Each check reports an :ok, :warn, or :error status with a human readable detail string. run/0 returns the full list; the mix task wrapper (mix git_hoox.doctor) renders the list and sets the process exit code.

Summary

Types

check()

Single diagnostic outcome.

Functions

aggregate(checks)

Aggregate severity across checks.

run()

Run every diagnostic in order.

Types

check()

@type check() :: %{name: String.t(), status: :ok | :warn | :error, detail: String.t()}

Single diagnostic outcome.

Functions

aggregate(checks)

@spec aggregate([check()]) :: :ok | :warn | :error

Aggregate severity across checks.

run()

@spec run() :: [check()]

Run every diagnostic in order.