specta-impls crate

Cargo.toml

@@ -106,6 +106,7 @@ bevy_ecs = ["dep:bevy_ecs"]
 
 [dependencies]
 specta-macros = { version = "=2.0.0-rc.6", path = "./macros" }
+specta-impls = { version = ">=0.0.0", path = "./crates/impls" }
 serde = { version = "1.0.183", optional = true, default-features = false, features = ["derive"] }
 serde_json = { version = "1.0.104", optional = true, default-features = false, features = ["std"] }
 serde_yaml = { version = "0.9.25", optional = true, default-features = false, features = [] }
@@ -139,3 +140,7 @@ once_cell = "1.18.0"
 doc-comment = "0.3.3"
 serde = { version = "1.0.183", features = ["derive"] }
 trybuild = "1.0.82"
+specta-impls = { version = ">=0.0.0", path = "./crates/impls", features = ["testing"] }
+
+[workspace]
+members = ["./crates/impls"]

crates/impls/Cargo.toml

@@ -0,0 +1,10 @@
+[package]
+name = "specta-impls"
+version = "0.0.1"
+edition = "2021"
+
+[features]
+default = []
+testing = []
+
+[dependencies]

crates/impls/src/internal.rs

@@ -0,0 +1,35 @@
+//! The magic that makes this crate work. This module does *NOT* follow semver at all.
+
+// This macro must *NEVER* change signature, even in major releases!!!!!
+// This is called by `specta` and `specta` depends on *any* version of this crate.
+//
+// This is a little hack to avoid the orphan rule. The code inside this is expanded inside `specta` so it can do `impl specta::Type for ...`.
+#[macro_export]
+macro_rules! impls {
+    // This runs in the context of the `specta` crate so the `cfg`'s won't work as expected.
+    () => {
+        use crate::{DataType, Type, TypeMap};
+
+        $crate::_feature_testing!();
+    };
+}
+
+// TODO: Make a nicer abstraction for this
+
+#[macro_export]
+#[cfg(any(feature = "testing", docsrs))]
+macro_rules! _feature_testing {
+    () => {
+        impl Type for specta_impls::Testing {
+            fn inline(_: &mut TypeMap, _: &[DataType]) -> DataType {
+                DataType::Any
+            }
+        }
+    };
+}
+
+#[macro_export]
+#[cfg(not(any(feature = "testing", docsrs)))]
+macro_rules! _feature_testing {
+    () => {};
+}

crates/impls/src/lib.rs

@@ -0,0 +1,18 @@
+//! # Specta Implementations
+//! A collection of Specta integrations for popular crates.
+//!
+//! TODO: List of supported features, why this exists, semver rules
+#![forbid(unsafe_code)]
+#![warn(clippy::all, clippy::unwrap_used, clippy::panic)] // TODO: missing_docs
+#![allow(clippy::module_inception)]
+#![cfg_attr(docsrs, feature(doc_cfg))]
+#![doc(
+    html_logo_url = "https://github.com/oscartbeaumont/specta/raw/main/.github/logo-128.png",
+    html_favicon_url = "https://github.com/oscartbeaumont/specta/raw/main/.github/logo-128.png"
+)]
+
+#[doc(hidden)]
+mod internal;
+
+#[cfg(feature = "testing")]
+pub struct Testing();

examples/basic.rs

@@ -62,4 +62,7 @@ fn main() {
         ts_str,
         r#"export type Something = { a: { [key in MyEnum]: number } }"#.to_string()
     );
+
+    let ts_str = ts::inline::<specta_impls::Testing>(&ExportConfig::default()).unwrap();
+    println!("{ts_str}");
 }

src/lib.rs

@@ -11,6 +11,11 @@
 #[doc(hidden)]
 pub mod internal;
 
+pub mod impls {
+    // TODO: Can we make these `impls`'s show up in the docs???
+    specta_impls::impls!();
+}
+
 /// Types related to working with [`DataType`](crate::DataType). Exposed for advanced users.
 pub mod datatype;
 /// Provides the global type store and a method to export them to other languages.