Merge pull request #190 from Aleph-Alpha/ignore-serde-attributes-when…

…-skipped

Ignore serde attributes when #[ts(skip)] is present

README.md

@@ -42,7 +42,7 @@ We recommend doing this in your tests.
 ### get started
 ```toml
 [dependencies]
-ts-rs = "7.0"
+ts-rs = "7.1"
 ```
 
 ```rust

macros/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "ts-rs-macros"
-version = "7.0.0"
+version = "7.1.0"
 authors = ["Moritz Bischof <[email protected]>"]
 edition = "2021"
 description = "derive macro for ts-rs"

macros/src/attr/field.rs

@@ -22,7 +22,10 @@ impl FieldAttr {
         let mut result = Self::default();
         parse_attrs(attrs)?.for_each(|a| result.merge(a));
         #[cfg(feature = "serde-compat")]
-        crate::utils::parse_serde_attrs::<SerdeFieldAttr>(attrs).for_each(|a| result.merge(a.0));
+        if !result.skip {
+            crate::utils::parse_serde_attrs::<SerdeFieldAttr>(attrs)
+                .for_each(|a| result.merge(a.0));
+        }
         Ok(result)
     }
 

macros/src/attr/variant.rs

@@ -22,7 +22,10 @@ impl VariantAttr {
         let mut result = Self::default();
         parse_attrs(attrs)?.for_each(|a| result.merge(a));
         #[cfg(feature = "serde-compat")]
-        crate::utils::parse_serde_attrs::<SerdeVariantAttr>(attrs).for_each(|a| result.merge(a.0));
+        if !result.skip {
+            crate::utils::parse_serde_attrs::<SerdeVariantAttr>(attrs)
+                .for_each(|a| result.merge(a.0));
+        }
         Ok(result)
     }
 

ts-rs/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "ts-rs"
-version = "7.0.0"
+version = "7.1.0"
 authors = ["Moritz Bischof <[email protected]>"]
 edition = "2021"
 license = "MIT"
@@ -37,7 +37,7 @@ chrono = { version = "0.4", features = ["serde"] }
 
 [dependencies]
 heapless = { version = "0.7", optional = true }
-ts-rs-macros = { version = "7.0.0", path = "../macros" }
+ts-rs-macros = { version = "7.1.0", path = "../macros" }
 dprint-plugin-typescript = { version = "0.85.1", optional = true }
 chrono = { version = "0.4", optional = true }
 bigdecimal = { version = ">=0.0.13, < 0.4.0", features = [

ts-rs/src/lib.rs

@@ -40,7 +40,7 @@
 //! ## get started
 //! ```toml
 //! [dependencies]
-//! ts-rs = "7.0"
+//! ts-rs = "7.1"
 //! ```
 //!
 //! ```rust
@@ -104,7 +104,7 @@
 //!   Implement `TS` for `OrderedFloat` from ordered_float
 //!
 //! - `heapless-impl`  
-//! 
+//!
 //!   Implement `TS` for `Vec` from heapless
 //!
 //! - `no-serde-warnings`
@@ -464,20 +464,24 @@ impl<T: TS> TS for Option<T> {
     }
 }
 
-impl<T : TS, E : TS> TS for Result<T, E>{
-    fn name() -> String{
+impl<T: TS, E: TS> TS for Result<T, E> {
+    fn name() -> String {
         unreachable!();
     }
-    fn transparent() -> bool {
-        return true;
+    fn inline() -> String {
+        format!("{{ Ok : {} }} | {{ Err : {} }}", T::inline(), E::inline())
     }
     fn dependencies() -> Vec<Dependency>
     where
-        Self: 'static {
-        [Dependency::from_ty::<T>(), Dependency::from_ty::<E>()].into_iter().flatten().collect()
+        Self: 'static,
+    {
+        [Dependency::from_ty::<T>(), Dependency::from_ty::<E>()]
+            .into_iter()
+            .flatten()
+            .collect()
     }
-    fn inline() -> String {
-        format!("{{ Ok : {} }} | {{ Err : {} }}", T::inline(), E::inline())
+    fn transparent() -> bool {
+        true
     }
 }
 

ts-rs/tests/issue-80.rs

@@ -1,5 +1,5 @@
-use ts_rs::TS;
 use serde::Serialize;
+use ts_rs::TS;
 
 #[derive(TS, Serialize)]
 #[ts(export)]
@@ -9,11 +9,11 @@ pub enum SomeTypeList {
         #[ts(skip)]
         skip_this: String,
     },
-    Value2
+    Value2,
 }
 
 #[test]
 fn issue_80() {
     let ty = SomeTypeList::inline();
     assert_eq!(ty, r#"{ "Value1": {  } } | "Value2""#);
-}
+}

ts-rs/tests/serde-skip-with-default.rs

@@ -0,0 +1,27 @@
+#![allow(dead_code)]
+
+// from issue #107. This does now no longer generate a warning.
+
+use serde::{Deserialize, Serialize};
+use ts_rs::TS;
+
+fn default_http_version() -> String {
+    "2".to_owned()
+}
+
+#[derive(Debug, Clone, Deserialize, Serialize, TS)]
+#[ts(export)]
+pub struct Foobar {
+    #[ts(skip)]
+    #[serde(skip, default = "default_http_version")]
+    pub http_version: String,
+    pub something_else: i32,
+}
+
+#[test]
+fn serde_skip_with_default() {
+    assert_eq!(
+        Foobar::decl(),
+        "interface Foobar { something_else: number, }"
+    );
+}