Project manifest contract - Examples

Platform spec article

Project manifest contract - Examples

Back to Project manifest 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 Project manifest 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/resolution-and-projects/project-manifest-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 Project manifest 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/projects/manifest_resolve.rs
   • compiler/crates/beskid_analysis/src/projects/graph/
   • compiler/crates/beskid_cli/src/commands/

   Open full ADR page

3. 0003-tooling-schema-compiler-graph Tooling owns schema; compiler owns graph Accepted

   Manifest key tables were duplicated between tooling and compiler specs.

   Context

   Manifest key tables were duplicated between tooling and compiler specs.

   Decision

   Author-facing Project.proj key tables live only under tooling; this compiler feature documents resolution graph behavior and defers schema prose via relatedTopics.

   Consequences

   Compiler changes manifest parsing only when graph or diagnostic bands change; tooling spec leads schema edits.

   Verification anchors

   • compiler/crates/beskid_analysis/src/projects/manifest_resolve.rs
   • tooling project-manifest-contract hub.

   Open full ADR page

Articles

• Project manifest contract - Contracts and edge cases Compiler resolution guarantees, graph cycles, and manifest-band diagnostics. article Standard
• Project manifest contract - Design model Resolution graph entities for Project.proj ingestion (manifest key prose defers to tooling). article Standard
• Project manifest contract - Examples Gives concrete newcomer-friendly scenarios mapped to real compiler paths. article Standard
• Project manifest contract - FAQ and troubleshooting Answers common operator and contributor questions with practical next checks. article Standard
• Project manifest contract - Flow and algorithm Compiler order of operations for manifest parse, graph insertion, and Mod materialization. article Standard
• Project manifest 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 · 2 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
  Project manifest contract

  Parent feature hub

This article documents examples for project manifest 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_cli/src/commands/ reads manifest-driven compile inputs.
• compiler/crates/beskid_tests/src/projects/corelib/mod.rs uses manifest-aware project fixtures.
• compiler/crates/beskid_tests/src/projects/corelib/compile.rs verifies manifest-based compile execution.

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.