Skip to main content

Crate workshop_rs

Crate workshop_rs 

Source
Expand description

The canonical multi-locale Overwatch Workshop semantic core.

workshop-rs owns the Workshop-language foundation of the WrightKit ecosystem: canonical Workshop semantics, the catalog of Workshop-defined content, the raw Workshop frontend, validation, deterministic emission, and Workshop IR. It is standalone and MIT-licensed; it has no dependency on Wright tooling crates or on any source-language provider implementation.

  • catalog — the canonical Workshop catalog: stable, locale-independent semantic identities, kinds, parameters, and locale tables binding identities to client spellings; catalog version/digest identity and per-locale coverage;
  • lexer/parser — the native localized Workshop frontend producing validated Workshop IR;
  • wir — the Workshop IR model (locale-independent semantic representation) with its arena/source/settings support;
  • emitter — deterministic localized Workshop emission and canonical native action-layout queries, failing explicitly on missing target-locale mappings (opt-in fallback);
  • detect — Workshop client-language detection and explicit override;
  • validate — catalog-backed validation of canonical builtin references;
  • roundtrip — cross-locale round-trip validation;
  • convert — raw Workshop locale conversion (parse -> canonical semantics -> emit).
  • live_capture — offline validation and structured comparison contracts for manually recorded client evidence; it never controls a client.

The catalog is locale-independent at the identity layer: analyzer and WIR APIs never need locale-specific strings to identify a builtin. Locale coverage is data, declared in the catalog dataset (catalog::Catalog, docs/adr/0001-catalog-boundaries.md).

Modules§

arena
Arena/index-based storage.
catalog
The canonical Workshop catalog.
census
Deterministic, sharded census of the canonical Workshop surface.
conformance
Public contracts for canonical Workshop conformance evidence.
convert
Raw Workshop locale conversion: parse -> canonical semantics -> emit.
detect
Workshop client-language detection and explicit locale override.
element_count
Canonical Workshop element-count analysis.
emitter
Deterministic localized Workshop emitter.
format
Shared number formatting for emission.
gameplay
Canonical hero and ability gameplay data.
gameplay_data
Embedded, provenance-pinned hero gameplay data.
gameplay_query
Deterministic queries, locale resolution, and small calculations over crate::gameplay. This layer consumes validated records and never invents missing facts or display-name aliases.
ids
Strongly typed IDs.
lexer
Tokenizer for localized vanilla Workshop text.
live_capture
Offline schema and comparison support for provenance-recorded client captures.
parser
Native localized Workshop parser.
real_projects
Owner-controlled expectations for the pinned real-project Workshop corpus.
roundtrip
Cross-language Workshop round-trip compatibility suite.
semantic
Semantic-completeness inspection for permissive raw Workshop parsing.
settings
The neutral settings carrier.
signatures
Canonical signature context for ambiguous enum member resolution.
source
Source model: files, positions, and spans.
validate
Catalog-backed validation of Workshop-origin WIR.
wir
The Workshop IR model.

Structs§

CatalogError
Catalog-specific error.

Enums§

WorkshopError
A structured Workshop-language error.