Brix.Validator (Brix v0.1.1)

Copy Markdown View Source

Validates a content directory against structural rules, referential integrity, and section template schemas. Returns errors (block loading) and warnings (don't block).

Summary

Functions

Validates the content tree at content_dir. Returns %{errors: [], warnings: []}. An empty errors list means the content is safe to load.

Types

result()

@type result() :: %{
  errors: [Brix.Validator.Issue.t()],
  warnings: [Brix.Validator.Issue.t()]
}

Functions

validate(content_dir)

@spec validate(String.t()) :: result()

Validates the content tree at content_dir. Returns %{errors: [], warnings: []}. An empty errors list means the content is safe to load.