StatifierBlocks.Publish (StatifierBlocks v0.44.1)

Copy Markdown View Source

The findings a host's publish step refuses a document on, from the same functions the editor and the compile run (ADR-0004's Amendment of 2026-09-22, G4).

This module is one pure function. It holds no store, starts no process, performs no IO and publishes nothing: the publish step is the host's, and it calls findings/3 and then StatifierBlocks.Compiler.compile/3, refusing on an :error from either. A :warning is the host's call. An :info changes no verdict.

What it is not

StatifierBlocks.Compiler.compile/3 is not the editor's pipeline with an emit stage added. The compile runs the envelope, slot and assignability checks and stops at the first stage that refuses; the editor runs none of those itself and takes them from its host as caller-supplied findings, and adds what the compile never reports - the undeclared-path advisories, the subchart outcome disagreements, the summary lints and the palette's StatifierBlocks.DocumentValidators. So this module does not alias the compile. It composes the compile's stages before Emit (StatifierBlocks.Compiler.structure_findings/3) with the editor's own composition, and that composition is the answer an author sees in the editor for the same document, word for word.

The four steps

  1. StatifierBlocks.Compiler.structure_findings/3, with :datamodel and :declare taken from context, so the host hands one value to both halves.
  2. Every finding adapted through StatifierBlocks.Finding.from_compiler/2.
  3. When a finding came from the Document stage, the adapted list is returned and nothing else runs: the editor's composition reads a tree, and the Document stage has refused the tree. That finding carries the :document anchor.
  4. Otherwise, the editor's composition with the adapted list as its caller-supplied findings: the findings of StatifierBlocks.ViewModel.build/3 handed the adapted list, then StatifierBlocks.Datamodel.findings/4's advisories, then StatifierBlocks.ViewModel.outcome_findings/3's disagreements. The view model's own derived findings come first. When the document declares its own datamodel roots, the advisories are raised to :error before they are handed on (see An undeclared datamodel path below).

Step 4 is the editor's list for the same document, palette and context when the editor is handed the adapted list as its findings, in the same order, and StatifierBlocks.Editor.findings_count/3 over the same inputs is its length. The one difference is the severity of an undeclared-path advisory in a document that declares its own roots: :error here, :info in the editor, with the same anchor, source and message. A config refusal can appear twice in the list, once derived by the view model and once from the compile's Config stage, exactly as the editor shows it when a host hands it the compile's refusal; nothing here de-duplicates.

Nothing here emits, so an Emit-stage or Chart-stage refusal is the compile's to report, and the checks a compile's :entry_type option drives are too: context does not carry it.

An undeclared datamodel path

A config path no declaring surface declares is StatifierBlocks.Datamodel.findings/4's advisory: anchored on the field, source :lint, severity :info (ADR-0005 decision 11e, with the declared set 11k widens). What this function answers for it depends on who declared:

  • The document declares a datamodel root (its own datamodel key holds at least one entry): the advisory is answered at :error, so the host's publish step refuses the document. The document has said what storage it reads and writes, and a path outside it is the mistake a run would otherwise meet only at run time. The host's datamodel and :declare roots still count as declared, so either can only clear a path, never refuse one.
  • Only the host declares (a :datamodel, or :declare roots, with the document declaring none): the advisory stays :info, as the editor shows it, and refuses nothing.
  • Nothing is declared anywhere: no advisory is produced (11f, as 11m widens it).

The editor's own list is unchanged: it shows the advisory at :info in every case. The rule is ADR-0005's Amendment of 2026-10-19 on 11e.

Summary

Types

context()

The same inputs the editor takes, as a map. Every key is optional, and an absent key means what the editor's default means.

Functions

findings(document, palette, context)

Every finding the host's publish step judges document by, before a compile, in the editor's order.

Types

context()

@type context() :: %{
  optional(:datamodel) => term(),
  optional(:declare) => term(),
  optional(:chart_outcomes) => term()
}

The same inputs the editor takes, as a map. Every key is optional, and an absent key means what the editor's default means.

  • :datamodel - the host's datamodel: the declared paths the undeclared-path advisory reads, and the datamodel the compile's typed-environment read check reads. Absent or nil turns the advisory off (ADR-0005 amendment 11f) and gives the read check no declarations.
  • :declare - the <data> roots the host declares for this document, the compile option's own {id, expr} list. Absent means [], which declares none.
  • :chart_outcomes - what the host says its stored documents finish with, for the subchart outcome disagreements. Absent means %{}, which says nothing about any chart.

Functions

findings(document, palette, context)

@spec findings(StatifierBlocks.Document.t(), StatifierBlocks.Palette.t(), context()) ::
  [
    StatifierBlocks.Finding.t()
  ]

Every finding the host's publish step judges document by, before a compile, in the editor's order.

Pure and total: never a raise on a %Document{} and a %Palette{}, whatever the document holds. A document the Document stage refuses comes back as that one finding, anchored :document, and nothing else. See the moduledoc for the four steps and for what context holds.