Rules and diagnostics catalog

Platform spec feature

Rules and diagnostics catalog

Back to Semantic pipeline ◎ Open 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 Rules and diagnostics catalog.

   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/semantic-pipeline/rules-and-diagnostics-catalog/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 Rules and diagnostics catalog.

   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/analysis
   • compiler/crates/beskid_analysis/src/analysis/rules/staged
   • compiler/crates/beskid_analysis/src/analysis/diagnostic_kinds.rs

   Open full ADR page

3. 0003-primary-contract-choice Primary contract for Rules and diagnostics catalog Accepted

   This feature defines how semantic rules are scheduled and how their findings map to stable diagnostic kinds. The primary

   Context

   This feature defines how semantic rules are scheduled and how their findings map to stable diagnostic kinds. The primary implementation roots are beskid_analysis/src/analysis, staged rule modules under analysis/rules/staged, and services that expose diagnostics to CLI/LSP consumers.

   Decision

   The reference compiler must implement Rules and diagnostics catalog 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/analysis
   • compiler/crates/beskid_analysis/src/analysis/rules/staged
   • compiler/crates/beskid_analysis/src/analysis/diagnostic_kinds.rs

   Open full ADR page

Articles

• Contracts and edge cases Rule-level guarantees and high-risk semantic edge cases. article Standard
• Design model Mental model for staged semantic rules and diagnostic production. article Standard
• Examples Practical examples of semantic rule outcomes and diagnostic generation. article Standard
• FAQ and troubleshooting Common semantic-pipeline debugging questions and practical checks. article Standard
• Flow and algorithm End-to-end semantic rule flow from resolved items to user-facing diagnostics. article Standard
• Verification and traceability How semantic rule behavior is validated and traced to source modules. 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) · 5 H2 heading(s)

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

Related spec docs

• Area
  Semantic pipeline

  Parent area

• Feature
  Parser and AST contracts

  Semantic checks consume parsed syntax structures

What this feature governs

This feature defines how semantic rules are scheduled and how their findings map to stable diagnostic kinds. The primary implementation roots are beskid_analysis/src/analysis, staged rule modules under analysis/rules/staged, and services that expose diagnostics to CLI/LSP consumers.

Core guarantees

1. Semantic checks run on resolved project state and must produce deterministic diagnostic ordering.
2. Diagnostic kind identity is anchored in analysis/diagnostic_kinds.rs.
3. Error-severity diagnostics are compilation blockers in diagnostics-enabled paths.
4. CLI and LSP surfaces may differ in rendering but must preserve diagnostic kind and source span identity.

Documentation diagnostics (snapshot)

Documentation-only findings use stable warning codes W1610–W1615 and W1620–W1625 (see Diagnostic code registry design model). They are computed in beskid_analysis::doc::collect_doc_diagnostics and attached to DocumentAnalysisSnapshot::doc_diagnostics so editors can merge them with staged semantic diagnostics without re-running HIR-heavy rules on the hot path.

Implementation anchors

• compiler/crates/beskid_analysis/src/analysis
• compiler/crates/beskid_analysis/src/analysis/rules/staged
• compiler/crates/beskid_analysis/src/analysis/diagnostic_kinds.rs
• compiler/crates/beskid_analysis/src/doc/validate.rs
• compiler/crates/beskid_analysis/src/services.rs
• compiler/crates/beskid_lsp/src/diagnostics.rs

Decisions

No open decisions. Closed choices are normative ADRs under adr/ (D-COMP-SEM-0007 … D-COMP-SEM-0009); use the reader ADRs tab for expandable detail.