Language + fix export + Workspace lints & nightly docs

closes #169, closes #256 and closes #245
specta-rs · Jul 9, 2024 · 35846df · 35846df
1 parent c41c53c
commit 35846df
Show file tree

Hide file tree

Showing 43 changed files with 1,110 additions and 758 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -10,7 +10,7 @@ permissions:
   statuses: write
 
 env:
-  RUSTDOCFLAGS: --cfg docsrs2
+  RUSTDOCFLAGS: --cfg docsrs
 
 jobs:
   deploy-docs:

diff --git a/Cargo.toml b/Cargo.toml
@@ -1,3 +1,15 @@
 [workspace]
 members = ["specta", "specta-*", "tests"]
 resolver = "2"
+
+[workspace.lints.rust]
+unsafe_code = { level = "forbid", priority = -1 }
+# missing_docs = { level = "warn", priority = -1 } # TODO: Enable this
+
+[workspace.lints.clippy]
+all = { level = "warn", priority = -1 }
+cargo = { level = "warn", priority = -1 }
+unwrap_used = { level = "warn", priority = -1 }
+panic = { level = "warn", priority = -1 }
+todo = { level = "warn", priority = -1 }
+panic_in_result_fn = { level = "warn", priority = -1 }
diff --git a/specta-datatype-from/Cargo.toml b/specta-datatype-from/Cargo.toml
@@ -13,6 +13,9 @@ categories = ["web-programming", "asynchronous"]
 [lib]
 proc-macro = true
 
+[lints]
+workspace = true
+
 [dependencies]
 proc-macro2 = "1.0.86"
 quote = "1.0.36"

diff --git a/specta-datatype-from/src/lib.rs b/specta-datatype-from/src/lib.rs
@@ -62,6 +62,10 @@
 //! let named_export = ts::export_named_datatype(&Default::default(), &named, &Default::default()).unwrap();
 //! assert_eq!(named_export, "export type MyObject = { a: \"A\" | \"B\" }");
 //! ```
+#![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"
+)]
 
 mod data_type_from;
 mod utils;

diff --git a/specta-go/Cargo.toml b/specta-go/Cargo.toml
@@ -10,6 +10,14 @@ documentation = "https://docs.rs/specta-zod/latest/specta-zod"
 keywords = ["async", "specta", "rspc", "go", "typesafe"]
 categories = ["web-programming", "asynchronous"]
 
+# /bin/sh RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --all-features
+[package.metadata."docs.rs"]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
+
+[lints]
+workspace = true
+
 [dependencies]
 specta = { path = "../specta" }
 thiserror = "1.0.61"
diff --git a/specta-go/src/lib.rs b/specta-go/src/lib.rs
@@ -1,3 +1,10 @@
+//! TODO
+#![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"
+)]
+
 use specta::{DataType, Generics, Type, TypeMap};
 
 /// TODO

diff --git a/specta-kotlin/Cargo.toml b/specta-kotlin/Cargo.toml
@@ -10,5 +10,13 @@ documentation = "https://docs.rs/specta-zod/latest/specta-zod"
 keywords = ["async", "specta", "rspc", "kotlin", "typesafe"]
 categories = ["web-programming", "asynchronous"]
 
+# /bin/sh RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --all-features
+[package.metadata."docs.rs"]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
+
+[lints]
+workspace = true
+
 [dependencies]
 specta = { path = "../specta" }
diff --git a/specta-kotlin/src/lib.rs b/specta-kotlin/src/lib.rs
@@ -1,3 +1,10 @@
+//! TODO
+#![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"
+)]
+
 use specta::{DataType, Generics, PrimitiveType, Type, TypeMap};
 
 /// TODO

diff --git a/specta-macros/Cargo.toml b/specta-macros/Cargo.toml
@@ -14,9 +14,13 @@ categories = ["web-programming", "asynchronous"]
 proc-macro = true
 
 [features]
-serde = []
-function = []
-export = []
+default = []
+# These will be enabled by `specta` or `specta-util` automatically as required. They depend on certain exports of it so enabling them manually is not useful.
+DO_NOT_USE_export = []
+DO_NOT_USE_function = []
+
+[lints]
+workspace = true
 
 [dependencies]
 proc-macro2 = "1.0.86"

diff --git a/specta-macros/src/lib.rs b/specta-macros/src/lib.rs
@@ -8,9 +8,9 @@
     html_favicon_url = "https://github.com/oscartbeaumont/specta/raw/main/.github/logo-128.png"
 )]
 
-#[cfg(feature = "function")]
+#[cfg(feature = "DO_NOT_USE_function")]
 mod internal_fn_datatype;
-#[cfg(feature = "function")]
+#[cfg(feature = "DO_NOT_USE_function")]
 mod specta;
 mod r#type;
 mod utils;
@@ -21,7 +21,7 @@ pub fn derive_type(input: proc_macro::TokenStream) -> proc_macro::TokenStream {
 }
 
 #[proc_macro_attribute]
-#[cfg(feature = "function")]
+#[cfg(feature = "DO_NOT_USE_function")]
 pub fn specta(
     _: proc_macro::TokenStream,
     item: proc_macro::TokenStream,
@@ -31,7 +31,7 @@ pub fn specta(
 
 #[proc_macro]
 #[doc(hidden)]
-#[cfg(feature = "function")]
+#[cfg(feature = "DO_NOT_USE_function")]
 pub fn internal_fn_datatype(input: proc_macro::TokenStream) -> proc_macro::TokenStream {
     use syn::parse_macro_input;
 

diff --git a/specta-macros/src/type/attr/container.rs b/specta-macros/src/type/attr/container.rs
@@ -53,7 +53,6 @@ impl ContainerAttr {
         let mut result = Self::default();
         result.common = CommonAttr::from_attrs(attrs)?;
         Self::try_from_attrs("specta", attrs, &mut result)?;
-        #[cfg(feature = "serde")]
         Self::try_from_attrs("serde", attrs, &mut result)?;
         Self::try_from_attrs("repr", attrs, &mut result)?; // To handle `#[repr(transparent)]`
         Ok(result)

diff --git a/specta-macros/src/type/attr/enum.rs b/specta-macros/src/type/attr/enum.rs
@@ -39,7 +39,6 @@ impl EnumAttr {
         };
 
         Self::try_from_attrs("specta", attrs, &mut result)?;
-        #[cfg(feature = "serde")]
         Self::try_from_attrs("serde", attrs, &mut result)?;
         Ok(result)
     }

diff --git a/specta-macros/src/type/attr/field.rs b/specta-macros/src/type/attr/field.rs
@@ -53,7 +53,6 @@ impl FieldAttr {
         let mut result = Self::default();
         result.common = CommonAttr::from_attrs(attrs)?;
         Self::try_from_attrs("specta", attrs, &mut result)?;
-        #[cfg(feature = "serde")]
         Self::try_from_attrs("serde", attrs, &mut result)?;
         Ok(result)
     }

diff --git a/specta-macros/src/type/attr/variant.rs b/specta-macros/src/type/attr/variant.rs
@@ -31,7 +31,6 @@ impl VariantAttr {
         let mut result = Self::default();
         result.common = CommonAttr::from_attrs(attrs)?;
         Self::try_from_attrs("specta", attrs, &mut result)?;
-        #[cfg(feature = "serde")]
         Self::try_from_attrs("serde", attrs, &mut result)?;
         Ok(result)
     }

diff --git a/specta-macros/src/type/mod.rs b/specta-macros/src/type/mod.rs
@@ -107,24 +107,24 @@ pub fn derive(input: proc_macro::TokenStream) -> syn::Result<proc_macro::TokenSt
 
     let type_impl_heading = impl_heading(quote!(#crate_ref::Type), &ident, generics);
 
-    let export = (cfg!(feature = "export") && container_attrs.export.unwrap_or(true)).then(|| {
-        let export_fn_name = format_ident!("__push_specta_type_{}", raw_ident);
-
-        let generic_params = generics
-            .params
-            .iter()
-            .filter(|param| matches!(param, syn::GenericParam::Type(_)))
-            .map(|_| quote! { () });
-
-        quote! {
-            // TODO: Bring this back
-            // #[allow(non_snake_case)]
-            // #[#internal_crate_ref::internal::ctor::ctor]
-            // fn #export_fn_name() {
-            //     #crate_ref::export::register_ty::<#ident<#(#generic_params),*>>();
-            // }
-        }
-    });
+    let export = (cfg!(feature = "DO_NOT_USE_export") && container_attrs.export.unwrap_or(true))
+        .then(|| {
+            let export_fn_name = format_ident!("__push_specta_type_{}", raw_ident);
+
+            let generic_params = generics
+                .params
+                .iter()
+                .filter(|param| matches!(param, syn::GenericParam::Type(_)))
+                .map(|_| quote! { () });
+
+            quote! {
+                #[allow(non_snake_case)]
+                #[#internal_crate_ref::export::internal::ctor]
+                fn #export_fn_name() {
+                    #internal_crate_ref::export::internal::register::<#ident<#(#generic_params),*>>();
+                }
+            }
+        });
 
     let comments = &container_attrs.common.doc;
     let deprecated = container_attrs.common.deprecated_as_tokens(&crate_ref);
@@ -163,7 +163,7 @@ pub fn derive(input: proc_macro::TokenStream) -> syn::Result<proc_macro::TokenSt
                         #name.into(),
                         #comments.into(),
                         #deprecated,
-                        #sid,
+                        Self::sid(),
                         IMPL_LOCATION,
                         <Self as #crate_ref::Type>::inline(type_map, #crate_ref::Generics::Provided(generics))
                     )
@@ -174,7 +174,7 @@ pub fn derive(input: proc_macro::TokenStream) -> syn::Result<proc_macro::TokenSt
                         #name.into(),
                         #comments.into(),
                         #deprecated,
-                        #sid,
+                        Self::sid(),
                         IMPL_LOCATION,
                         <Self as #crate_ref::Type>::inline(type_map, #crate_ref::Generics::Definition)
                     )

diff --git a/specta-macros/src/utils.rs b/specta-macros/src/utils.rs
@@ -285,7 +285,7 @@ impl Inflection {
     }
 }
 
-#[cfg(feature = "function")]
+#[cfg(feature = "DO_NOT_USE_function")]
 pub fn format_fn_wrapper(function: &Ident) -> Ident {
     quote::format_ident!("__specta__fn__{}", function)
 }

diff --git a/specta-openapi/Cargo.toml b/specta-openapi/Cargo.toml
@@ -10,6 +10,14 @@ documentation = "https://docs.rs/specta-zod/latest/specta-zod"
 keywords = ["async", "specta", "rspc", "openapi", "typesafe"]
 categories = ["web-programming", "asynchronous"]
 
+# /bin/sh RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --all-features
+[package.metadata."docs.rs"]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
+
+[lints]
+workspace = true
+
 [dependencies]
 specta = { path = "../specta" }
 openapiv3 = { version = "2.0.0", default-features = false, features = [] }
diff --git a/specta-openapi/src/lib.rs b/specta-openapi/src/lib.rs
@@ -1,4 +1,9 @@
 //! [OpenAPI](https://www.openapis.org) language exporter.
+#![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"
+)]
 
 use openapiv3::{
     ArrayType, BooleanType, NumberType, ReferenceOr, Schema, SchemaData, SchemaKind, StringType,

diff --git a/specta-rust/Cargo.toml b/specta-rust/Cargo.toml
@@ -10,5 +10,13 @@ documentation = "https://docs.rs/specta-zod/latest/specta-zod"
 keywords = ["async", "specta", "rspc", "rust", "typesafe"]
 categories = ["web-programming", "asynchronous"]
 
+# /bin/sh RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --all-features
+[package.metadata."docs.rs"]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
+
+[lints]
+workspace = true
+
 [dependencies]
 specta = { path = "../specta" }
diff --git a/specta-rust/src/lib.rs b/specta-rust/src/lib.rs
@@ -1,4 +1,9 @@
 //! [Rust](https://www.rust-lang.org) language exporter.
+#![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"
+)]
 
 use specta::{DataType, Generics, Type, TypeMap};
 

diff --git a/specta-serde/Cargo.toml b/specta-serde/Cargo.toml
@@ -10,6 +10,14 @@ documentation = "https://docs.rs/specta-zod/latest/specta-zod"
 keywords = ["async", "specta", "rspc", "typescript", "typesafe"]
 categories = ["web-programming", "asynchronous"]
 
+# /bin/sh RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --all-features
+[package.metadata."docs.rs"]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
+
+[lints]
+workspace = true
+
 [dependencies]
 specta = { path = "../specta" }
 thiserror = "1.0.61"
diff --git a/specta-serde/src/lib.rs b/specta-serde/src/lib.rs
@@ -1,4 +1,9 @@
 //! Serde support for Specta
+#![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"
+)]
 
 use std::collections::HashSet;
 

diff --git a/specta-swift/Cargo.toml b/specta-swift/Cargo.toml
@@ -10,5 +10,13 @@ documentation = "https://docs.rs/specta-zod/latest/specta-zod"
 keywords = ["async", "specta", "rspc", "swift", "typesafe"]
 categories = ["web-programming", "asynchronous"]
 
+# /bin/sh RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --all-features
+[package.metadata."docs.rs"]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
+
+[lints]
+workspace = true
+
 [dependencies]
 specta = { path = "../specta" }
diff --git a/specta-swift/src/lib.rs b/specta-swift/src/lib.rs
@@ -1,6 +1,11 @@
 //! [Swift](https://www.swift.org) language exporter.
+#![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"
+)]
 
-use specta::{reference, DataType, Generics, PrimitiveType, Type, TypeMap};
+use specta::{DataType, Generics, PrimitiveType, Type, TypeMap};
 
 /// TODO
 pub fn export<T: Type>() -> Result<String, String> {

diff --git a/specta-typescript/Cargo.toml b/specta-typescript/Cargo.toml
@@ -10,12 +10,20 @@ documentation = "https://docs.rs/specta-zod/latest/specta-zod"
 keywords = ["async", "specta", "rspc", "typescript", "typesafe"]
 categories = ["web-programming", "asynchronous"]
 
+# /bin/sh RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --all-features
+[package.metadata."docs.rs"]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
+
 [features]
 default = []
 
 # TODO: Remove this?
 function = ["specta/function"]
 
+[lints]
+workspace = true
+
 [dependencies]
 specta = { path = "../specta" }
 # TODO: Don't depend on serde