AST and HIR shape contract - Verification and traceability

Platform spec article

AST and HIR shape contract - Verification and traceability

Back to AST and HIR shape contract ◎ 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 AST and HIR shape contract.

   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/front-end/ast-hir-shape-contract/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 AST and HIR shape contract.

   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/src/syntax/items/
   • compiler/crates/beskid_analysis/src/resolve/items.rs
   • compiler/crates/beskid_analysis/src/analysis/

   Open full ADR page

3. 0003-primary-contract-choice Primary contract for AST and HIR shape contract Accepted

   This feature hub defines the normative contract for **ast and hir shape contract** and links newcomer-oriented reference

   Context

   This feature hub defines the normative contract for ast and hir shape contract and links newcomer-oriented reference articles.

   Decision

   The reference compiler must implement AST and HIR shape contract 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/src/syntax/items/
   • compiler/crates/beskid_analysis/src/resolve/items.rs
   • compiler/crates/beskid_analysis/src/analysis/

   Open full ADR page

Articles

• AST and HIR shape contract - Contracts and edge cases States the normative guarantees and what happens at boundaries or failure edges. article Standard
• AST and HIR shape contract - Design model Explains the persistent concepts, entities, and boundaries this feature relies on. article Standard
• AST and HIR shape contract - Examples Gives concrete newcomer-friendly scenarios mapped to real compiler paths. article Standard
• AST and HIR shape contract - FAQ and troubleshooting Answers common operator and contributor questions with practical next checks. article Standard
• AST and HIR shape contract - Flow and algorithm Walks through runtime/order-of-operations behavior in the implementation. article Standard
• AST and HIR shape contract - Verification and traceability Shows how the team proves this feature works and where evidence lives. article Standard

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) · 2 H2 heading(s)

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

Related spec docs

• Feature
  AST and HIR shape contract

  Parent feature hub

This article documents verification and traceability for ast and hir shape contract in the reference compiler.

What this covers

For newcomers, this page explains where the contract shows up in day-to-day compiler work and which code paths are most useful first reads.

Anchored code paths

• compiler/crates/beskid_analysis/src/syntax/items/ exposes AST-like syntax node shapes.
• compiler/crates/beskid_analysis/src/resolve/items.rs maps parsed items into resolved structures.
• compiler/crates/beskid_analysis/src/analysis/ consumes those shapes for semantic passes.

Practical notes

• Prefer tracing from CLI/test entry points into analysis/codegen crates before changing internals.
• Treat diagnostics and tests as part of the contract, not optional implementation details.
• If behavior changes, update this article and add/adjust tests in compiler/crates/beskid_tests or compiler/crates/beskid_e2e_tests.