Dependency graph and cycle policy - FAQ and troubleshooting

Platform spec article

Dependency graph and cycle policy - FAQ and troubleshooting

Back to Dependency graph and cycle policy ◎ 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 Dependency graph and cycle policy.

   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/dependency-graph-and-cycle-policy/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 Dependency graph and cycle policy.

   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_tests/src/projects/corelib/layout.rs
   • compiler/crates/beskid_tests/src/projects/corelib/mod.rs
   • compiler/crates/beskid_cli/src/commands/doc.rs

   Open full ADR page

3. 0003-cycles-reported-at-graph-build Dependency cycles reported at graph build Accepted

   Silent cycle handling broke workspace diagnostics parity.

   Context

   Silent cycle handling broke workspace diagnostics parity.

   Decision

   Directed cycles must be reported during graph build; Mod cycles must include mod id in the diagnostic path.

   Consequences

   Policy knobs (error, warn, permissive) select abort vs continue; default remains fail-closed for release builds.

   Verification anchors

   • beskid_analysis::projects::graph
   • compiler/crates/beskid_tests/src/projects/corelib/layout.rs.

   Open full ADR page

Articles

• Dependency graph and cycle policy - Contracts and edge cases States the normative guarantees and what happens at boundaries or failure edges. article Standard
• Dependency graph and cycle policy - Design model Explains the persistent concepts, entities, and boundaries this feature relies on. article Standard
• Dependency graph and cycle policy - Examples Gives concrete newcomer-friendly scenarios mapped to real compiler paths. article Standard
• Dependency graph and cycle policy - FAQ and troubleshooting Answers common operator and contributor questions with practical next checks. article Standard
• Dependency graph and cycle policy - Flow and algorithm Walks through runtime/order-of-operations behavior in the implementation. article Standard
• Dependency graph and cycle policy - 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
  Dependency graph and cycle policy

  Parent feature hub

This article documents faq and troubleshooting for dependency graph and cycle policy 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_tests/src/projects/corelib/layout.rs models multi-project dependency layouts.
• compiler/crates/beskid_tests/src/projects/corelib/mod.rs checks graph expectations.
• compiler/crates/beskid_cli/src/commands/doc.rs consumes resolved dependency context for docs.

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.