Skip to content

Define canonical embedded Workshop and comment preservation contract #32

Description

@Teakowa

Goal

Define and implement the canonical workshop-rs WIR contract needed to preserve supported embedded vanilla Workshop blocks and authored Workshop comments when a source-language consumer mixes DEL/OSTW constructs with raw Workshop.

Context

del-rs Issue #32 has parser evidence for vanilla Workshop rules, variables, subroutines, settings blocks, and action comments, but released workshop-rs 0.1.1 has no opaque/raw rule or comment node in wir::Program. A DEL-local parser, WIR mirror, or text concatenation would duplicate canonical Workshop ownership and lose structured validation/provenance.

Scope

  • Decide the canonical representation and provenance contract for opaque-but-preserved Workshop sections or a semantically equivalent structured form.
  • Decide how authored action comments attach to rules/actions and how they are validated/emitted.
  • Define fail-closed diagnostics for malformed, unsupported, or locale-sensitive raw content.
  • Add parser/WIR/emitter round-trip and source-provenance evidence before consumers claim support.

Non-goals

  • DEL/OSTW source semantics or runtime lowering.
  • A provider-local catalog or emitter.
  • Workshop-to-DEL decompilation.

Acceptance criteria

  • A reviewed public workshop-rs contract exists for embedded Workshop and comments, or the supported boundary is explicitly classified as unsupported.
  • Canonical WIR validation and emission preserve declared semantics and source provenance.
  • Consumer repositories can integrate through public APIs without copying Workshop parser/catalog/emitter logic.

Evidence

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions