ontogen-ts 0.1.5

Rust AST → TypeScript emitter for ontogen's long-tail type bindings
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

#![forbid(unsafe_code)]
#![allow(clippy::doc_markdown)]

//! Rust AST → TypeScript emitter for ontogen's long-tail type bindings.
//!
//! This crate is the build-time replacement for the OF-014 spike's `specta`
//! side-car. Given a set of root types, a pool of candidate type definitions
//! (`syn::Item` keyed by canonical [`TypePath`]), and an [`EmitConfig`], it
//! produces TypeScript source covering the supported subset documented in
//! [`OF-015`](https://github.com/sksizer/rust-ontogen/blob/main/docs/tasks/OF-015-productionize-typescript-generation.md):
//!
//! - Named structs over primitive / container / smart-pointer / reference
//!   field types
//! - C-style enums (and tagged enums where the tag is implicit from variant
//!   idents)
//! - `Vec<T>`, `Option<T>`, `HashMap<K, V>`, `BTreeMap<K, V>`
//! - Primitives: `bool`, all integer types, `f32`/`f64`, `String`, `&str`
//! - Smart-pointer wrappers (`Box`, `Rc`, `Arc`, `Cow`, `Pin`) peeled
//!   silently
//! - External types via [`EmitConfig::external_types`]
//! - `#[serde(flatten)]` on a struct field (or an enum struct-variant
//!   field), emitted as a TS intersection: `StepMeta & { program: string }`
//! - The full rename family, each on the axis serde gives it: `rename_all`
//!   (a container's members), `rename_all_fields` (an enum's struct-variant
//!   fields), `rename_all` on a variant (that variant's fields), `rename`
//!
//! See `docs/tasks/OF-015-productionize-typescript-generation.md` for the
//! full design pass.
//!
//! # PR series state (PR 4 of 8)
//!
//! PR 1-3 landed the crate scaffold, per-type emission, serde rename
//! family, type-pool walker, use-resolution, external-types table, and
//! topological ordering. PR 4 wires them together: the top-level [`emit`]
//! function now composes collection → name resolution → collision
//! detection → topological ordering → per-type emission → error
//! aggregation, all in one pass. The `#[ts_opaque(target = "...")]` and
//! `#[ts_name = "..."]` proc-macro attrs (shipped in `ontogen-macros`)
//! are read here to short-circuit emission for opaque types and override
//! TS names. External-types lookup is wired into `emit_type`'s
//! fall-through so types like `chrono::DateTime` resolve to `string`
//! per the shipped defaults.
//!
//! PR 5 wires `ontogen` itself to call [`emit`] instead of the side-car
//! emitter.

mod attr;
mod emit;
mod external;
mod order;
mod pool;
mod rename;
mod resolve;
mod types;

pub use emit::{emit, emit_with_imports, render_type, render_type_str};
pub use pool::{LOCAL_CRATE_ROOT, ScanError, scan_crate_root_with_imports, scan_src_dir, scan_src_dir_with_imports};
pub use resolve::{ModuleImports, Resolution, resolve_reference};
pub use types::{BigIntBehavior, EmitConfig, EmitError, QuoteStyle, RenameAll, TypePath, TypePathError};