Skip to main content

workshop_rs/
lib.rs

1//! The canonical multi-locale Overwatch Workshop semantic core.
2//!
3//! `workshop-rs` owns the Workshop-language foundation of the WrightKit
4//! ecosystem: canonical Workshop semantics, the catalog of Workshop-defined
5//! content, the raw Workshop frontend, validation, deterministic emission,
6//! and Workshop IR. It is standalone and MIT-licensed; it has no dependency on
7//! Wright tooling crates or on any source-language provider implementation.
8//!
9//! * [`catalog`] — the canonical Workshop catalog: stable, locale-independent
10//!   semantic identities, kinds, parameters, and locale tables binding
11//!   identities to client spellings; catalog version/digest identity and
12//!   per-locale coverage;
13//! * `lexer`/`parser` — the native localized Workshop frontend producing
14//!   validated Workshop IR;
15//! * [`wir`] — the Workshop IR model (locale-independent semantic
16//!   representation) with its arena/source/settings support;
17//! * [`emitter`] — deterministic localized Workshop emission, failing
18//!   explicitly on missing target-locale mappings (opt-in fallback);
19//! * [`detect`] — Workshop client-language detection and explicit override;
20//! * [`validate`] — catalog-backed validation of canonical builtin references;
21//! * [`roundtrip`] — cross-locale round-trip validation;
22//! * [`convert`] — raw Workshop locale conversion (parse -> canonical
23//!   semantics -> emit).
24//! * [`live_capture`] — offline validation and structured comparison contracts
25//!   for manually recorded client evidence; it never controls a client.
26//!
27//! The catalog is locale-independent at the identity layer: analyzer and WIR
28//! APIs never need locale-specific strings to identify a builtin. Locale
29//! coverage is data, declared in the catalog dataset
30//! ([`catalog::Catalog`], [`docs/adr/0001-catalog-boundaries.md`](https://github.com/wrightkit/workshop-rs/blob/main/docs/adr/0001-catalog-boundaries.md)).
31
32pub mod arena;
33pub mod catalog;
34pub mod census;
35pub mod conformance;
36pub mod convert;
37pub mod detect;
38pub mod emitter;
39mod error;
40pub mod format;
41pub mod gameplay;
42pub mod gameplay_data;
43pub mod gameplay_query;
44pub mod ids;
45pub mod lexer;
46pub mod live_capture;
47pub mod p0;
48pub mod parser;
49pub mod roundtrip;
50pub mod semantic;
51pub mod settings;
52pub mod signatures;
53pub mod source;
54pub mod validate;
55pub mod wir;
56
57pub use error::{CatalogError, WorkshopError};