PhoenixAssets.Doctor (PhoenixAssets v0.1.0)

Runs configuration and production-readiness diagnostics.

Collects the built-in core checks plus every plugin's doctor_checks/2, runs each against the context, and aggregates an overall status. A check tagged production?: true only runs under run/2 with production: true (the CI/build path), where it can enforce things that are meaningless in development -- a present manifest, no stale generated contracts.

A check that raises is captured and reported as an error rather than crashing the run.

Summary

Types

result()

Functions

run(ctx, opts \\ [])

Runs the diagnostics, returning {status, results}.

Types

result()

@type result() ::
  {PhoenixAssets.Doctor.Check.t(), PhoenixAssets.Doctor.Check.result()}

Functions

run(ctx, opts \\ [])

@spec run(
  PhoenixAssets.Context.t(),
  keyword()
) :: {PhoenixAssets.Doctor.Check.status(), [result()]}

Runs the diagnostics, returning {status, results}.

status is :ok unless any check returned :error. With production: true, production-only checks are included.