rename quit-serde to no-serde-warnings, add docs

Aleph-Alpha · Jan 11, 2024 · 3a79cea · 3a79cea
1 parent 9657feb
commit 3a79cea
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -109,6 +109,11 @@ When running `cargo test`, the TypeScript bindings will be exported to the file
 
   Implement `TS` for `Vec` from heapless
 
+- `no-serde-warnings`
+
+  When `serde-compat` is enabled, warnings are printed during build if unsupported serde
+  attributes are encountered. Enabling this feature silences these warnings.
+
 
 If there's a type you're dealing with which doesn't implement `TS`, use `#[ts(type = "..")]` or open a PR.
 
@@ -127,7 +132,7 @@ Supported serde attributes:
 - `flatten`
 - `default`
 
-When ts-rs encounters an unsupported serde attribute, a warning is emitted.
+When ts-rs encounters an unsupported serde attribute, a warning is emitted, unless the feature `no-serde-warnings` is enabled.
 
 ### contributing
 Contributions are always welcome!

diff --git a/macros/Cargo.toml b/macros/Cargo.toml
@@ -10,7 +10,7 @@ repository = "https://github.com/Aleph-Alpha/ts-rs"
 
 [features]
 serde-compat = ["termcolor"]
-quiet-serde = []
+no-serde-warnings = []
 
 [lib]
 proc-macro = true

diff --git a/ts-rs/Cargo.toml b/ts-rs/Cargo.toml
@@ -29,7 +29,7 @@ default = ["serde-compat"]
 indexmap-impl = ["indexmap"]
 ordered-float-impl = ["ordered-float"]
 heapless-impl = ["heapless"]
-quiet-serde = ["ts-rs-macros/quiet-serde"]
+no-serde-warnings = ["ts-rs-macros/no-serde-warnings"]
 
 [dev-dependencies]
 serde = { version = "1.0", features = ["derive"] }

diff --git a/ts-rs/src/lib.rs b/ts-rs/src/lib.rs
@@ -107,6 +107,11 @@
 //! 
 //!   Implement `TS` for `Vec` from heapless
 //!
+//! - `no-serde-warnings`
+//!
+//!   When `serde-compat` is enabled, warnings are printed during build if unsupported serde
+//!   attributes are encountered. Enabling this feature silences these warnings.
+//!
 //!
 //! If there's a type you're dealing with which doesn't implement `TS`, use `#[ts(type = "..")]` or open a PR.
 //!
@@ -125,7 +130,7 @@
 //! - `flatten`
 //! - `default`
 //!
-//! When ts-rs encounters an unsupported serde attribute, a warning is emitted.
+//! When ts-rs encounters an unsupported serde attribute, a warning is emitted, unless the feature `no-serde-warnings` is enabled.
 //!
 //! ## contributing
 //! Contributions are always welcome!