2.2.1: bug-fix for #[serde(tag)] outputting a string instead of a concatenated type list

Author: Wulf

Cargo.lock

@@ -1,7 +1,7 @@
 [package]
 name = "tsync"
 description = "Generate typescript types from rust code."
-version = "2.2.0"
+version = "2.2.1"
 readme = "README.md"
 repository = "https://github.com/Wulf/tsync"
 license = "MIT OR Apache-2.0"

Cargo.toml

@@ -2,7 +2,7 @@
 
 <a href="https://crates.io/crates/tsync"><img src="https://img.shields.io/crates/v/tsync.svg?style=for-the-badge" height="20" alt="License: MIT OR Apache-2.0" /></a>
 
-A utility to generate typescript types from rust code.
+A utility to generate typescript types from rust code. Tries to conform to serde's serialized output.
 
 # Install
 

README.md

@@ -35,17 +35,20 @@ impl super::ToTypescript for syn::ItemEnum {
         let casing = utils::get_attribute_arg("serde", "rename_all", &self.attrs);
         let casing = utils::parse_serde_case(casing);
 
+        // is_single means the enum has no variants with fields
+        // i.e. `enum Foo { Bar, Baz }` rather than `enum Foo { Bar, Baz(String) }`
         let is_single = !self.variants.iter().any(|x| !x.fields.is_empty());
         state.write_comments(&comments, 0);
 
-        if is_single {
+        // always use output the internally_tagged representation if the tag is present
+        if let Some(tag_name) = utils::get_attribute_arg("serde", "tag", &self.attrs) {
+            add_internally_tagged_enum(tag_name, self, state, casing, config.uses_type_interface)
+        } else if is_single {
             if utils::has_attribute_arg("derive", "Serialize_repr", &self.attrs) {
                 add_numeric_enum(self, state, casing, config)
             } else {
                 add_enum(self, state, casing, config.uses_type_interface)
             }
-        } else if let Some(tag_name) = utils::get_attribute_arg("serde", "tag", &self.attrs) {
-            add_internally_tagged_enum(tag_name, self, state, casing, config.uses_type_interface)
         } else {
             add_externally_tagged_enum(self, state, casing, config.uses_type_interface)
         }
@@ -131,8 +134,16 @@ fn add_numeric_enum(
     casing: Option<Case>,
     config: &crate::BuildSettings,
 ) {
-    let declare = if config.uses_type_interface { "declare " } else { "export " };
-    let const_ = if config.enable_const_enums { "const " } else { "" };
+    let declare = if config.uses_type_interface {
+        "declare "
+    } else {
+        "export "
+    };
+    let const_ = if config.enable_const_enums {
+        "const "
+    } else {
+        ""
+    };
     state.types.push_str(&format!(
         "{declare}{const_}enum {interface_name} {{",
         interface_name = exported_struct.ident
@@ -289,7 +300,9 @@ fn add_externally_tagged_enum(
             // add discriminant
             state.types.push_str(&format!("  | {{ \"{}\":", field_name));
             for field in variant.fields {
-                state.types.push_str(&format!(" {}", convert_type(&field.ty).ts_type,));
+                state
+                    .types
+                    .push_str(&format!(" {}", convert_type(&field.ty).ts_type,));
             }
             state.types.push_str(" }");
         } else {

src/to_typescript/enums.rs

@@ -64,3 +64,10 @@ enum AnimalTwo {
     DogLongExtra = 2,
     Cat,
 }
+
+// Regression: if "serde(tag)" is specified, don't output a string.
+#[tsync]
+#[serde(tag = "type")]
+enum Tagged {
+    Test // this should be { type: "Test" } in the TypeScript (not just the string "Test")
+}

test/enum/rust.rs

@@ -66,3 +66,10 @@ type Animal =
 
 type AnimalTwo =
   | "dog_long_extra" | "cat";
+
+type Tagged =
+  | Tagged__Test;
+
+type Tagged__Test = {
+  type: "Test";
+};

test/enum/typescript.d.ts

@@ -66,3 +66,10 @@ export type Animal =
 
 export type AnimalTwo =
   | "dog_long_extra" | "cat";
+
+export type Tagged =
+  | Tagged__Test;
+
+type Tagged__Test = {
+  type: "Test";
+};