Workspace resolution contract - Flow and algorithm

Platform spec article

Workspace resolution contract - Flow and algorithm

Back to Workspace resolution 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 Workspace resolution 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/workspace-resolution-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 Workspace resolution 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/

   Open full ADR page

3. 0003-primary-contract-choice Primary contract for Workspace resolution contract Accepted

   This feature hub explains how the compiler discovers `Project.proj`, builds a project graph, and hands resolved workspac

   Context

   This feature hub explains how the compiler discovers Project.proj, builds a project graph, and hands resolved workspace inputs to compile and dependency commands. Mod projects are included in the graph like other project kinds; after resolution, the mod host registers them for event-driven orchestration per Project manifest contract and Compiler Mods.

   Decision

   The reference compiler must implement Workspace resolution 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/

   Open full ADR page

Articles

• Workspace resolution contract - Contracts and edge cases Normative guarantees and failure behavior for manifests, graph resolution, and root selection. article Standard
• Workspace resolution contract - Design model Actors, data model, and boundaries for project/workspace discovery in compiler services. article Standard Reviewed Wed May 20
• Workspace resolution contract - Examples Practical examples of manifest graph resolution and target path selection. article Standard
• Workspace resolution contract - FAQ and troubleshooting Common newcomer questions for project graph resolution, manifests, and lock behavior. article Standard
• Workspace resolution contract - Flow and algorithm End-to-end algorithm from manifest discovery to resolved compile input. article Standard
• Workspace resolution contract - Verification and traceability Tests and source anchors used to validate project graph and workspace resolution behavior. 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) · 1 H2 heading(s)

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

Related spec docs

• Feature
  Workspace resolution contract

  Parent feature hub

• Feature
  Dependency workspace and lockfile

  Workspace preparation step

Resolution pipeline

flowchart TD
  root[Discover project root]
  manifest[Load Project.proj]
  graph[Build dependency graph]
  policy[Apply cycle / missing dep policy]
  plan[Create CompilePlan]
  lock[Optional lockfile sync]
  entry[Source root + entry path]
  mods[Mod host event setup]
  root --> manifest --> graph --> policy --> plan
  plan --> lock --> entry
  plan --> mods

Steps

1. Resolve project root and load Project.proj manifest.
2. Build dependency graph with policy (error, warn, or permissive) for unresolved dependencies.
3. Classify each node’s project type (including Mod) and retain manifest fragments needed for mod host registration.
4. Select compilation target and create CompilePlan.
5. Optionally materialize workspace and lockfile synchronization.
6. Return final source root and entry path for parsing/lowering.
7. If the workspace includes Mod projects, pass the resolved graph slice to the mod host for event subscription setup (see Compiler Mods).

Implementations should use build_compile_plan_with_policy and prepare_project_workspace_with_options to keep command behavior aligned.