Program assembly - Flow and algorithm

Platform spec article

Program assembly - Flow and algorithm

Back to Program assembly ◎ Open feature in platform map

Spec standingStandard

Owner

Piotr Mikstacki pmikstacki@cybernomad.it

Submitter

Piotr Mikstacki pmikstacki@cybernomad.it

Current document

ADRs (3)

1. 0001-feature-hub-authority Feature hub authority Accepted

   This feature hub owns normative MUST/SHOULD contract text for Program assembly.

   Context

   Sibling articles under this feature previously restated requirements in inconsistent forms.

   Decision

   This feature hub owns normative MUST/SHOULD contract text. Sibling articles must not redefine hub requirements and should link here for authority.

   Consequences

   Contract changes start on the hub or in linked ADRs, then propagate to articles and implementation anchors.

   Verification anchors

   • site/website/src/content/docs/platform-spec/compiler/build-pipeline/program-assembly/index.mdx
   • article bundle under the same feature directory.

   Open full ADR page

2. 0002-spec-over-implementation-notes Specification over implementation notes Accepted

   Platform-spec text supersedes informal crate comments for Program assembly.

   Context

   Implementation crates accumulated informal notes that diverged from published contracts.

   Decision

   Normative platform-spec prose and ADRs under this feature supersede informal comments in implementation crates until explicitly migrated into spec text.

   Consequences

   Engineers file spec/ADR updates when behavior changes; crate comments are non-authoritative for conformance arguments.

   Verification anchors

   • compiler/crates/beskid_analysis/

   Open full ADR page

3. 0003-primary-contract-choice Primary contract for Program assembly Accepted

   This feature hub defines how the reference compiler turns a resolved **`CompilePlan`** plus **effective (materialized-fi

   Context

   This feature hub defines how the reference compiler turns a resolved CompilePlan plus effective (materialized-first) source roots into a ProgramAssembly: discovered .bd units, a shared ModuleIndex for cross-module resolution, and a single front-end spine consumed by CLI, LSP, analyze, and codegen. JIT and AOT backends consume CodegenArtifact only and do not re-run assembly.

   Decision

   The reference compiler must implement Program assembly as documented in this feature hub and its article bundle.

   Consequences

   Changes require hub/ADR updates and verification anchor extensions.

   Verification anchors

   • compiler/crates/beskid_analysis/

   Open full ADR page

Articles

• Program assembly - Contracts and edge cases Materialized-first roots, discovery caps, and parity across CLI and LSP. article Standard Reviewed Wed May 20
• Program assembly - Design model EffectiveCompilationRoots, ProgramAssembly, ModuleIndex, and hybrid discovery modes. article Standard Reviewed Wed May 20
• Program assembly - Flow and algorithm Ordered assembly after workspace materialize and before multi-unit parse and HIR resolution. article Standard Reviewed Wed May 20
• Program assembly - Verification and traceability Test and source anchors for ProgramAssembly and effective roots. article Standard Reviewed Wed May 20

History

0 revisions (git unavailable at build; counts may be empty)

Open full history on GitHub

No commits recorded for this path.

Completeness

OKfeature · 0 SpecSection(s) · 1 H2 heading(s)

Full tree: run pnpm verify:platform-spec-layout (writes src/generated/platform-spec-layout-report.json).

Related spec docs

• Feature
  Program assembly

  Parent feature hub

• Feature
  Stage ordering and lowering

  Pipeline phase program.assemble

1. Build EffectiveCompilationRoots from CompilePlan + optional PreparedProjectWorkspace (or lockfile replay for LSP).
2. Emit pipeline phase program.assemble (after workspace.materialize when present).
3. Discover source paths per AssemblyOptions.discovery.
4. Parse each unit; build ModuleIndex by collection-only resolver passes on non-entry units.
5. Hand entry SourceUnit and ModuleIndex to the shared front-end spine (mod host → semantic → HIR resolve/type on entry with prefetch index).
6. Lower to CodegenArtifact for JIT/AOT consumers.

Workspace resolution step 1 output must feed stage-ordering step 6 (HIR/resolution) through ModuleIndex, not only semantic rules on the entry file.