Snapshot and refresh contract

Platform spec feature

Snapshot and refresh contract

Back to LSP ◎ Open in platform map

Spec standingStandard

Owner

Piotr Mikstacki pmikstacki@cybernomad.it

Submitter

Piotr Mikstacki pmikstacki@cybernomad.it

Current document

ADRs (2)

1. 0001-hub-authority Hub authority Accepted

   Hub authority

   Context

   One authority.

   Decision

   Hub owns snapshot/refresh MUST/SHOULD.

   Consequences

   IDE parity.

   Verification anchors

   beskid_lsp tests.

   Open full ADR page

2. 0002-invalidation-on-focus-and-manifest Invalidation Accepted

   Invalidation

   Context

   Stale snapshots.

   Decision

   Invalidate on focus, manifest, lock; debounce watchers.

   Consequences

   Config notification.

   Verification anchors

   session store.

   Open full ADR page

Articles

• Contracts and edge cases Strict guarantees for LSP snapshot lifecycle and refresh behavior. article Standard
• Design model Conceptual model for `Snapshot and refresh contract` and its subsystem boundaries. article Standard
• Examples Observable LSP refresh scenarios for snapshots and diagnostics. article Standard
• FAQ and troubleshooting Common LSP snapshot and refresh issues. article Standard
• Flow and algorithm End-to-end refresh flow for LSP workspace snapshots and diagnostics. article Standard
• Verification and traceability Tests and traceability for the LSP snapshot and refresh contract. 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 · 3 SpecSection(s) · 0 H2 heading(s)

Section id	Required	Found
what-this-feature-specifies	yes	yes
implementation-anchors	yes	yes

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

Related spec docs

• Area
  LSP

  Parent area

• Area
  Semantic pipeline

  LSP diagnostics reuse semantic analysis rules

• Area
  VS Code extension

  Extension commands trigger and observe LSP refresh operations

What this feature specifies

Snapshot and refresh contract defines one operational contract that a newcomer can follow end-to-end: first the model, then execution flow, then strict guarantees, concrete examples, and verification guidance.

Implementation anchors

• LSP diagnostics in compiler/crates/beskid_lsp/src/diagnostics.rs
• Analysis services in compiler/crates/beskid_analysis/src/services.rs
• Resolver implementation in compiler/crates/beskid_analysis/src/resolve/resolver.rs
• LSP tests in compiler/crates/beskid_tests/src/analysis/resolve.rs

Decisions

No open decisions. D-TOOL-LSP-0001 (hub authority), 0002 (invalidation on focus and manifest)—see adr/ and the ADRs tab.

Articles

• Hub authorityHub authority
• Contracts and edge casesStrict guarantees for LSP snapshot lifecycle and refresh behavior.
• Design modelConceptual model for `Snapshot and refresh contract` and its subsystem boundaries.
• ExamplesObservable LSP refresh scenarios for snapshots and diagnostics.
• FAQ and troubleshootingCommon LSP snapshot and refresh issues.
• Flow and algorithmEnd-to-end refresh flow for LSP workspace snapshots and diagnostics.
• Verification and traceabilityTests and traceability for the LSP snapshot and refresh contract.