Squirrelix.Error (Squirrelix v0.5.2)

Copy Markdown View Source

Formatting helpers for structured Squirrelix errors.

Error structs under Squirrelix.Error.* are part of the supported public API — pattern-match them in tooling that inspects CodegenSummary / CodegenCheckSummary errors. Use format/1 and format_all/1 to render the same actionable text Mix tasks print.

User-facing failures (codegen, check, metadata, connection) format through format/1 with titles and actionable hints where possible. Connection failures and timeouts during --infer are classified with connection_error/2 into CannotConnectToPostgres or PostgresConnectionTimeout.

Summary

Functions

format(error)

Formats a structured error for display (same text Mix tasks print).

format_all(errors)

Formats a list of structured errors, separated by blank lines.

Functions

format(error)

@spec format(struct()) :: String.t()

Formats a structured error for display (same text Mix tasks print).

format_all(errors)

@spec format_all([struct()]) :: String.t()

Formats a list of structured errors, separated by blank lines.