From 69c9815b4f34f2b5b2d73524fa32307ced3eae1e Mon Sep 17 00:00:00 2001 From: Jeremy Drouillard Date: Wed, 20 Jan 2021 11:16:52 -0800 Subject: [PATCH] Serde compatibility with enum and tag field --- macros/src/attr/enum.rs | 5 ++++- macros/src/enum/mod.rs | 14 ++++++++++---- macros/src/utils.rs | 2 +- ts-rs/Cargo.toml | 3 ++- ts-rs/tests/serde_tag_enum.rs | 20 ++++++++++++++++++++ 5 files changed, 37 insertions(+), 7 deletions(-) create mode 100644 ts-rs/tests/serde_tag_enum.rs diff --git a/macros/src/attr/enum.rs b/macros/src/attr/enum.rs index 429f6c0..af0dc9a 100644 --- a/macros/src/attr/enum.rs +++ b/macros/src/attr/enum.rs @@ -7,6 +7,7 @@ use crate::utils::parse_attrs; pub struct EnumAttr { pub rename_all: Option, pub rename: Option, + pub tag: Option, } #[cfg(feature = "serde-compat")] @@ -22,9 +23,10 @@ impl EnumAttr { Ok(result) } - fn merge(&mut self, EnumAttr { rename_all, rename }: EnumAttr) { + fn merge(&mut self, EnumAttr { rename_all, rename, tag }: EnumAttr) { self.rename = self.rename.take().or(rename); self.rename_all = self.rename_all.take().or(rename_all); + self.tag = self.tag.take().or(tag); } } @@ -40,5 +42,6 @@ impl_parse! { SerdeEnumAttr(input, out) { "rename" => out.0.rename = Some(parse_assign_str(input)?), "rename_all" => out.0.rename_all = Some(parse_assign_inflection(input)?), + "tag" => out.0.tag = Some(parse_assign_str(input)?), } } diff --git a/macros/src/enum/mod.rs b/macros/src/enum/mod.rs index ae42ab6..88f8f14 100644 --- a/macros/src/enum/mod.rs +++ b/macros/src/enum/mod.rs @@ -5,7 +5,7 @@ use crate::attr::{EnumAttr, FieldAttr, Inflection}; use crate::DerivedTS; pub(crate) fn r#enum(s: &ItemEnum) -> Result { - let EnumAttr { rename_all, rename } = EnumAttr::from_attrs(&s.attrs)?; + let EnumAttr { rename_all, rename, tag } = EnumAttr::from_attrs(&s.attrs)?; if let Some(v) = s .variants @@ -18,7 +18,7 @@ pub(crate) fn r#enum(s: &ItemEnum) -> Result { let name = rename.unwrap_or_else(|| s.ident.to_string()); let mut formatted_variants = vec![]; for variant in &s.variants { - format_variant(&mut formatted_variants, &rename_all, &variant)?; + format_variant(&mut formatted_variants, &tag, &rename_all, &variant)?; } Ok(DerivedTS { @@ -32,6 +32,7 @@ pub(crate) fn r#enum(s: &ItemEnum) -> Result { fn format_variant( formatted_variants: &mut Vec, + tag: &Option, rename_all: &Option, variant: &Variant, ) -> Result<()> { @@ -56,7 +57,12 @@ fn format_variant( (None, None) => variant.ident.to_string(), (None, Some(rn)) => rn.apply(&variant.ident.to_string()), }; - - formatted_variants.push(format!("{:?}", name)); + + formatted_variants.push( match tag { + Some(tag_name) => { + format!("{{{}: {:?}}}", tag_name, name) + }, + None => format!("{:?}", name) + }); Ok(()) } diff --git a/macros/src/utils.rs b/macros/src/utils.rs index ff7c081..82211bf 100644 --- a/macros/src/utils.rs +++ b/macros/src/utils.rs @@ -67,7 +67,7 @@ pub fn parse_serde_attrs<'a, A: TryFrom<&'a Attribute, Error = Error>>( attrs .iter() .filter(|a| a.path.is_ident("serde")) - .flat_map(|attr| match A::try_from(attr) { + .flat_map(|attr| match A::try_from(attr) { Ok(attr) => Some(attr), Err(_) => { use quote::ToTokens; diff --git a/ts-rs/Cargo.toml b/ts-rs/Cargo.toml index 18d970c..7b6c1c0 100644 --- a/ts-rs/Cargo.toml +++ b/ts-rs/Cargo.toml @@ -12,4 +12,5 @@ repository = "https://github.com/Aleph-Alpha/ts-rs" serde-compat = ["ts-rs-macros/serde-compat"] [dependencies] -ts-rs-macros = { version = "2.1.2", path = "../macros" } \ No newline at end of file +ts-rs-macros = { version = "2.1.2", path = "../macros" } +serde = { version = "1.0", features = ["derive"] } \ No newline at end of file diff --git a/ts-rs/tests/serde_tag_enum.rs b/ts-rs/tests/serde_tag_enum.rs new file mode 100644 index 0000000..6d62189 --- /dev/null +++ b/ts-rs/tests/serde_tag_enum.rs @@ -0,0 +1,20 @@ +#![allow(dead_code)] + +use ts_rs::TS; +use serde::{Deserialize}; + + +#[derive(TS, Deserialize)] +#[serde(tag="kind")] +enum SimpleEnum { + A, + B, +} + +#[test] +fn test_serde_enum() { + assert_eq!( + SimpleEnum::decl(), + r#"export type SimpleEnum = {kind: "A"} | {kind: "B"};"# + ) +}